Skip to content
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

Docs: add example .eslintrc.json #15087

Merged
merged 4 commits into from Sep 29, 2021
Merged

Docs: add example .eslintrc.json #15087

merged 4 commits into from Sep 29, 2021

Conversation

nmattia
Copy link
Contributor

@nmattia nmattia commented Sep 21, 2021

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

This adds a .eslintrc.json that shows how to set rules config (among
others). For context, see #15064


NOTE: this includes configuration from third-party plugins (in particular typescript-eslint). Feel free to replace with {...}-style configuration blocks from eslint itself.

This adds a `.eslintrc.json` that shows how to set rules config (among
others).
@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Sep 21, 2021
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 21, 2021

CLA Signed

The committers are authorized under a signed CLA.

@mdjermanovic mdjermanovic added documentation Relates to ESLint's documentation evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Sep 24, 2021
Copy link
Member

@nzakas nzakas left a comment

Overall looks good, just a few suggestions.

docs/user-guide/configuring/configuration-files.md Outdated Show resolved Hide resolved
docs/user-guide/configuring/configuration-files.md Outdated Show resolved Hide resolved
docs/user-guide/configuring/configuration-files.md Outdated Show resolved Hide resolved
nmattia and others added 3 commits Sep 27, 2021
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
@nmattia
Copy link
Contributor Author

nmattia commented Sep 27, 2021

Thanks, applied everything!

nzakas
nzakas approved these changes Sep 28, 2021
Copy link
Contributor

@snitin315 snitin315 left a comment

LGTM. Thank you for contributing!

@snitin315 snitin315 added accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Sep 28, 2021
@nmattia
Copy link
Contributor Author

nmattia commented Sep 28, 2021

Great! Let me know if there's anything that needs to be done on my end for the merge.

@nzakas nzakas merged commit 2d654f1 into eslint:master Sep 29, 2021
13 checks passed
@nzakas
Copy link
Member

nzakas commented Sep 29, 2021

Nothing left to do. Thanks!

@nmattia nmattia deleted the nm-example-rc branch Sep 30, 2021
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 29, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Mar 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants