eslint-config-plus-prettier 4.1.9 → 4.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,6 +4,12 @@
4
4
 
5
5
  ## Quick Setup
6
6
 
7
+ Install the package:
8
+
9
+ ```bash
10
+ npm install --save-dev --save-exact eslint-config-plus-prettier
11
+ ```
12
+
7
13
  Add the following scripts to your `package.json`:
8
14
 
9
15
  ```json
@@ -28,12 +34,21 @@ import config from "eslint-config-plus-prettier";
28
34
  export default [config];
29
35
  ```
30
36
 
31
- Consider adding a `.eslintignore` file to avoid trying to lint compiled code in the `dist` folder:
37
+ To exclude specific folders or files from linting, add an `ignores` configuration:
32
38
 
33
- ```text
34
- dist
39
+ ```javascript
40
+ import config from "eslint-config-plus-prettier";
41
+
42
+ export default [
43
+ config,
44
+ {
45
+ ignores: ["_site/**", "build/**", "*.min.js"],
46
+ },
47
+ ];
35
48
  ```
36
49
 
50
+ > **Note:** `dist/**` and `node_modules/**` are ignored by default.
51
+
37
52
  ### Prettier
38
53
 
39
54
  Add prettier configuration to your `package.json`:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "eslint-config-plus-prettier",
3
- "version": "4.1.9",
3
+ "version": "4.1.11",
4
4
  "description": "Standard config for ESLint, Prettier and Package Lint. Also includes an optional TSConfig.",
5
5
  "license": "ISC",
6
6
  "author": "aimee rivers",