New: Description in directive comments #33
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
mysticatea
added
the
Initial Commenting
ilyavolodin
approved these changes
Jul 23, 2019
platinumazure
approved these changes
Jul 23, 2019
kaicataldo
approved these changes
Jul 23, 2019
aladdin-add
approved these changes
Jul 24, 2019
mysticatea
added
Final Commenting
|
Looks no objections from TSC. I'm merging this RFC. |
mysticatea
added a commit
to eslint/eslint
that referenced
this pull request
Dec 22, 2019
mysticatea
added a commit
to eslint/eslint
that referenced
this pull request
Dec 22, 2019
btmills
pushed a commit
to eslint/eslint
that referenced
this pull request
Jan 17, 2020
…2699) * Breaking: description in directive comments (refs eslint/rfcs#33) * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update tests/lib/linter/linter.js Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * update configuring.md Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
montmanu
pushed a commit
to montmanu/eslint
that referenced
this pull request
Mar 4, 2020
…lint#12699) * Breaking: description in directive comments (refs eslint/rfcs#33) * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update tests/lib/linter/linter.js Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * Update docs/user-guide/configuring.md Co-Authored-By: Kai Cataldo <kai@kaicataldo.com> * update configuring.md Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
|
Great to see this implemented, because I proposed it first. @mysticatea: can you please update the link in the OP? It's broken now. |
|
Thanks for this! Sorry if I'm being too off-topic (hope you can point me in the right direction if that's the case), but is there (or are there plans for) a rule to enforce that all disabled directives should have a description? Sometimes a comment is added and after some time it's no longer clear if it's an intentional "violation" of a rule or something meant to be temporal that became permanent. |
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.
Summary
This RFC adds the description support into directive comments such as
/*eslint-disable*/. For example,/* eslint-disable no-new -- this class has a side-effect in the constructor and it's a library's. */.Related Issues