Skip to content

docs(eslint-plugin): clearly document extension rules #1456

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

Merged
merged 5 commits into from
Jan 16, 2020

Conversation

bradzacher
Copy link
Member

Fixes #1446

  • Adds a flag to the rule meta.
  • Moves the extension rules to a new table in the readme.
  • Adds a section to the FAQ.
  • Update doc checker accordingly.

@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Jan 14, 2020
@typescript-eslint
Copy link
Contributor

Thanks for the PR, @bradzacher!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

Comment on lines +37 to +41
// this looks a little weird, but it provides the cleanest test output style
expect(unfilteredConfigRules).toMatchObject({
...unfilteredConfigRules,
[extRuleName]: 'off',
});
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

armano2
armano2 previously approved these changes Jan 16, 2020
@bradzacher bradzacher merged commit 9f9a5c5 into master Jan 16, 2020
@bradzacher bradzacher deleted the extension-rules-documentation branch January 16, 2020 05:35
@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.
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a mechanism for marking a rule as an extension rule
2 participants