-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: reworks the concept of lint directives #162
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
a-frantz
commented
Sep 10, 2024
peterhuene
reviewed
Sep 13, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks really great! I've added some review comments.
Co-authored-by: Peter Huene <peter@huene.dev>
peterhuene
approved these changes
Sep 16, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Describe the problem or feature in addition to a link to the issues.
This PR reworks the concept of lint directives (AKA
#@
comments orexcept
comments). It should close #135 , which details how lint directives have been partially broken since their introduction.Lint directives keep their same form (
#@ except: <comma delimited list of Rule IDs>
) but now are only expected in certain locations. Those locations are defined on a per-rule basis via the newexceptable_nodes()
method in theRule
trait.TODO in follow-up PR[s]
Diagnostics
struct not included here.tests/lints/
dir is awfully messy. They frequently contain a long list of excepted rules. All those WDL files deserve a clean up to be more conformant to expected lints.PreambleWhitespace
andPreambleComments
into new rulesPreambleFormatting
andPreambleCommentInBody
(accepting alternate names there).PreambleFormatting
will perform the bulk of the checks currently handled by the whitespace and comments rules.PreambleCommentInBody
will check for double-pound-sign comments outside the preamble.Before submitting this PR, please make sure:
changes (when appropriate).
CHANGELOG.md
(see"keep a changelog" for more information).