Add "Limitations" section to the readme to properly address eslint bug #44
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
| @@ -86,6 +86,10 @@ ESLint configuration is broken apart in `./rules` containing ESLint's rules and | |||
| "phantom": true | |||
| ``` | |||
|
|
|||
| ## Limitations | |||
|
|
|||
| Due to an issue with ESLint, config extension cannot be called from a globally installed (`npm install -g eslint`) eslint. It can however be run properly using eslint installed directly to your package's `node_modules`. This can be done by either calling it directly (`./node_modules/.bin/eslint .`) or from within an npm script since they automatically check local `node_modules` first. This will be tracked in issue #43. | |||
There was a problem hiding this comment.
Add link to 43.
Also possibly add
export PATH="./node_modules/.bin:${PATH}"as a documented option to "use local first"? (Some shell curmudgeons won't like that recommendation though 😉 )
baer
added a commit
that referenced
this pull request
Dec 23, 2015
…ude-limitations Add "Limitations" section to the readme to properly address eslint bug
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Explain #43 right in the README.
@exogen @ryan-roemer