Add max-len rule #1613
Merged
Add max-len rule #1613
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
bgrgicak
commented
Jul 15, 2024
bgrgicak
added
[Priority] Low
[Type] Developer Experience
[Focus] Developer Tools
and removed
Needs Author's Reply
labels
|
@brandonpayton I ran the |
| // @TODO: Don't process the command. Lean on the shell to do it, e.g. through | ||
| // a PATH or an alias. | ||
| // @TODO: Don't process the command. Lean on the shell to do it, e.g. | ||
| // through a PATH or an alias. |
There was a problem hiding this comment.
It would be nice to see "e.g." next to the subsequent text, but this is OK and to be expected for auto-fix output.
brandonpayton
approved these changes
Aug 6, 2024
There was a problem hiding this comment.
It's kind of funny when the auto-fix wraps a single word to the next line, but overall this looks fine to me.
I'm planning to remove the ignorePattern which seems unused, rerun the fix to make sure that change didn't break anything, and merge.
Thank you, @bgrgicak!
bgrgicak
added a commit
that referenced
this pull request
Aug 8, 2024
Long doc comments are hard to read and it's easy to write long comments. We need an automated way of checking for the comment length. This PR adds [eslint-plugin-comment-length](https://www.npmjs.com/package/eslint-plugin-comment-length?activeTab=readme) to implement comment max-len `eslint` rules. The errors aren't fixed to avoid creating issues with this PR, but they will show up as warnings, so we can fix them in the future. - CI
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.
Motivation for the change, related issues
Long doc comments are hard to read and it's easy to write long comments.
We need an automated way of checking for the comment length.
Implementation details
This PR adds eslint-plugin-comment-length to implement comment max-len
eslintrules.The errors aren't fixed to avoid creating issues with this PR, but they will show up as warnings, so we can fix them in the future.
Testing Instructions (or ideally a Blueprint)