-
Notifications
You must be signed in to change notification settings - Fork 7
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
revise: preamble and version stmt lint rules #187
Conversation
I think it's find to create either a single issue to track the various |
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 good! Just a few feedback comments.
I also tried to comment on the TODOs
where encountered to act as a reminder to create tracking issues / a singular tracking issue; I might have missed some.
Co-authored-by: Peter Huene <peter@huene.dev>
opened #203 with 6 items to track |
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 good!
Describe the problem or feature in addition to a link to the issues.
This revises the preamble+version formatting rules to use some more whitespace.
PreambleComments
andPreambleWhitespace
have been refactored into 3 rules:PreambleFormatting
,VersionFormatting
, andPreambleCommentAfterVersion
.The tests have been cleaned up. This means using lint directives judiciously and generally following more of our own lints within the tests.
Some rules that were emitting
warning
s have been downgraded tonote
s.Many TODOs have been logged. We generally prefer logging issues to TODO comments, but I didn't want to flood the issues with a bunch of tiny complaints. Maybe that's preferred?
Before submitting this PR, please make sure:
changes (when appropriate).
CHANGELOG.md
(see"keep a changelog" for more information).