Skip to content

Commit 3bd55c6

Browse files
authored
Update README.md for workspaces support
1 parent 3bf3149 commit 3bd55c6

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,18 @@ module.exports = {
6565
}
6666
```
6767

68+
### npm/yarn/pnpm workspaces support
69+
70+
This plugin supports npm/yarn/pnpm workspaces, although note that if the eslint-local-rules.js file is in the workspace subdirectory, running from the project root is unsupported.
71+
72+
For example, if there's an eslint-local-rules.js and index.js in ./src/app:
73+
74+
Wrong: `npx eslint src/app/index.js`
75+
76+
Right: `(cd src/app; npx eslint index.js)`
77+
78+
Also note that if there is an eslint-local-rules.js file in *both* the workspace subdirectory and project root, the workspace one takes precedence (assuming you're running eslint from the workspace directory, as above).
79+
6880
## License
6981

7082
MIT

0 commit comments

Comments
 (0)