Skip to content

Commit 4e58be0

Browse files
authored
Add further project integration guidance
1 parent 63a8e51 commit 4e58be0

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,25 @@ module.exports = {
2525

2626
- Use ESLint’s [`--report-unused-disable-directives`](https://eslint.org/docs/user-guide/command-line-interface#--report-unused-disable-directives) flag to ensure you do not use more `eslint-disable` comments than needed.
2727
- This config is [Prettier](https://prettier.io/)-compatible, but it is still usable by projects which do not wish to use Prettier.
28+
- We recommend using a `.eslintignore` so ESLint can be targeted at all files, with a blacklist of files to ignore.
29+
30+
Here’s a package.json `run` script and an ignore file to get you started:
31+
32+
```json
33+
"lint:js": "eslint --report-unused-disable-directives .",
34+
```
35+
36+
`.eslintignore` (adapt to your project):
37+
38+
```
39+
.git
40+
node_modules
41+
coverage
42+
static_compiled
43+
venv
44+
```
45+
46+
Note the point of the ignore file isn’t just to determine which JS files we don’t want to be linted, but also speed up linting by excluding large folders.
2847

2948
### React
3049

0 commit comments

Comments
 (0)