Implement checks for unnumbered TODOs and FIXMEs #106
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does two things: it saves the errors rustfmt finds in a report instead of immediately printing them, making some progress on https://github.com/nrc/rustfmt/issues/9.
It also adds checks for unnumbered TODOs and FIXMEs in the code. Basically we just check that any line containing a TODO matches the following regex:
But since we go through the results character by character, I implemented a state machine myself.
The output can get quite noisy --especially for rustfmt's own code--, so I added an option to forgo the check.
Note: the check treats all text equally. We're not making sure that we're in a comment. It may happen that we get false positives when there's a FIXME or TODO in a string literal, for example.