Skip to content

Add a mechanism for marking a rule as an extension rule #1446

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.

Sign up for GitHub

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

Jump to bottom
Closed
bradzacher opened this issue Jan 13, 2020 · 0 comments · Fixed by #1456
Closed

Add a mechanism for marking a rule as an extension rule #1446

bradzacher opened this issue Jan 13, 2020 · 0 comments · Fixed by #1456
Labels
documentation Documentation ("docs") that needs adding/updating has pr there is a PR raised to close this package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin

Comments

@bradzacher
Copy link
Member

We have a number of rules which extend eslint functionality.

Currently, the only place that we list these extension rules is here.
This is easy to forget about, and it is hard to expose to users.

We should do the following things:

  • Similar to how we added the requiresTypeChecking?: boolean flag to the rule meta, we should add a new flag, say baseRuleExtension?: boolean.
  • We should generate documentation based on this (maybe a separate table in the eslint-plugin readme, to clearly list them?).
  • We should add a section to the FAQ about checking the extension rule list when you encounter a bug in a base rule.
@bradzacher bradzacher added package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin documentation Documentation ("docs") that needs adding/updating has pr there is a PR raised to close this labels Jan 13, 2020
bradzacher added a commit that referenced this issue Jan 14, 2020
@bradzacher
docs(eslint-plugin): clearly document extension rules
1529a69 
Fixes #1446
@bradzacher bradzacher mentioned this issue Jan 14, 2020
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Documentation ("docs") that needs adding/updating has pr there is a PR raised to close this package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(eslint-plugin): clearly document extension rules typescript-eslint/typescript-eslint
1 participant
@bradzacher