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: Clarify that node_modules is ignored by default #13054

Merged
merged 1 commit into from Mar 21, 2020
Merged

Docs: Clarify that node_modules is ignored by default #13054

merged 1 commit into from Mar 21, 2020

Conversation

MKuijpers
Copy link
Contributor

@MKuijpers MKuijpers commented Mar 16, 2020

Fixes #13006

Prerequisites checklist

  • I have read the contributing guidelines.
  • The team has reached consensus on the changes proposed in this pull request. If not, I understand that the evaluation process will begin with this pull request and won't be merged until the team has reached consensus.

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)

The node_modules folder is ignored by default. However, in some parts of the documentation it is still included in ignore configs. I removed the node_modules entries from the examples and clarified in an example ignore config how it can be added back in.

Is there anything you'd like reviewers to focus on?

Whether the added/edited documentation is still correct and if node_modules/* is the correct pattern.

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Mar 16, 2020
@MKuijpers MKuijpers changed the title Docs: Clarify that node_modules is ignored by default Docs: clarify that node_modules is ignored by default and not needed … Mar 16, 2020
@MKuijpers MKuijpers changed the title Docs: clarify that node_modules is ignored by default and not needed … Docs: Clarify that node_modules is ignored by default Mar 16, 2020
@kaicataldo kaicataldo added documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Mar 17, 2020
@kaicataldo
Copy link
Member

Thanks for doing this! Agreed that this is an improvement.

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks

@nzakas nzakas merged commit 9ac5b9e into eslint:master Mar 21, 2020
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Sep 19, 2020
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Sep 19, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
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.

Documentation bug: Re: linting node_modules
3 participants