Skip to content

Commit 7de4c3b

Browse files
fregantecletusw
authored andcommitted
Cleanup readme
1 parent 5acc1f9 commit 7de4c3b

File tree

1 file changed

+7
-14
lines changed

1 file changed

+7
-14
lines changed

README.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,12 @@
11
# eslint-plugin-local-rules
22

3-
A plugin for ESLint that allows you to use project-specific rules, similar to the [`--rulesdir`](http://eslint.org/docs/user-guide/command-line-interface#--rulesdir) command line option ([more](http://eslint.org/docs/developer-guide/working-with-rules#runtime-rules)).
3+
A plugin for ESLint that allows you to use project-specific rules, similar to the deprecated [`--rulesdir`](http://eslint.org/docs/user-guide/command-line-interface#--rulesdir) command line option ([more](http://eslint.org/docs/developer-guide/working-with-rules#runtime-rules)).
44

55
Workaround for https://github.com/eslint/eslint/issues/8769 (previously https://github.com/eslint/eslint/issues/2715).
66

7-
## Other solutions
8-
9-
- https://github.com/taskworld/eslint-plugin-local
10-
- Allows specifying additonal plugin config such as
11-
[`processors`](https://eslint.org/docs/developer-guide/working-with-plugins#processors-in-plugins)
12-
- https://github.com/not-an-aardvark/eslint-plugin-rulesdir
13-
- Allows for a custom rules directory name
14-
15-
## Dependencies
16-
17-
- Requires ESLint version 0.8.0 or higher
18-
197
## Install
208

21-
```
9+
```sh
2210
npm install eslint-plugin-local-rules
2311
```
2412

@@ -125,6 +113,11 @@ Right: `(cd src/app; npx eslint index.js)`
125113

126114
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).
127115

116+
## Alternatives
117+
118+
- [eslint-plugin-local](https://github.com/taskworld/eslint-plugin-local) - Allows specifying additonal plugin config such as [`processors`](https://eslint.org/docs/developer-guide/working-with-plugins#processors-in-plugins)
119+
- [eslint-plugin-rulesdir](https://github.com/not-an-aardvark/eslint-plugin-rulesdir) - Allows for a custom rules directory name
120+
128121
## License
129122

130123
MIT

0 commit comments

Comments
 (0)