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.

Sign up for GitHub

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

Jump to bottom

Add "Limitations" section to the readme to properly address eslint bug #44

Merged
merged 1 commit into from
Dec 23, 2015
Merged

Add "Limitations" section to the readme to properly address eslint bug #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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 😉 )


### This package tracks config in the following versions:

- [ESLint](https://github.com/eslint/eslint) 1.5.1
Expand Down