This repository has been archived by the owner on Aug 7, 2023. It is now read-only.
Improve package.json eslintConfig support #848
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
Fixes #832 Previously, we would find the fallback `.eslintrc.*` config file in a user’s home directory, return that, and then potentially ignore it later because it’s a fallback. Only if there were _zero_ `.eslintrc.*` files would we ever look for a package.json. With this change, we will find a package.json file and check for an eslint configuration before traversing higher up the directory structure and potentially encountering a fallback in the user’s home root. It’s important that the `package.json` file come last in the array, so that we look for `.eslintrc` config files first. Otherwise, we may find a package.json file without an eslintConfig, ignore it, and not bother looking for a .eslintrc file in the same directory. This still has the problem that hitting a `package.json` file without an eslintConfig will prevent finding another config higher in the structure. That fix will come in the next commit.
Fixes #768 This continues traversing up the directory structure after finding a `package.json` file which does not contain an `eslintConfig`.
Arcanemagus
approved these changes
Mar 14, 2017
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
This PR solves a few edge cases around using
eslintConfigproperties withinpackage.jsonfiles:.eslintrcfile was placed in a user's home root, the project'spackage.jsonwas ignored. (issue linter-eslint isn't reading eslintConfig from my project's package.json #832)package.jsonwithout aneslintConfigwas found, we would bail out and not find a parentpackage.json(issue Multiple package.json files in subdirectories disable eslint if there's no config defined #768)It does this by searching every directory for a
package.jsonin addition to the other.eslintrc.*-style config files. If we find a.eslintrcfile, then we'll just return that off the bat, since they are checked first (they come first in the array we provide tofindCached). If we find apackage.jsonfile, we will check if it has aneslintConfigproperty. If so, we're done. If not, we will continue looking in parent folders and repeating the process.