@bonniernews/eslint-config - npm Package Compare versions

Comparing version 2.0.0-alpha.7 to 2.0.0-alpha.8

index.js

@@ -8,2 +8,3 @@ "use strict";
 const testConfig = require("./test");
+const ignoresConfig = require("./ignores");
 
@@ -16,12 +17,3 @@ module.exports = [
   testConfig,
-  {
-    ignores: [
-      "tmp/",
-      "public/",
-      "submodule/**",
-      "logs/",
-      "docs/",
-      "**/.terraform/",
-    ],
-  },
+  ignoresConfig,
 ];

package.json

 {
   "name": "@bonniernews/eslint-config",
-  "version": "2.0.0-alpha.7",
+  "version": "2.0.0-alpha.8",
   "description": "ESLint config",
@@ -65,2 +65,3 @@ "main": "index.js",
     "rules.js",
+    "ignores.js",
     "test.js",
@@ -80,4 +81,5 @@ "typescript-rules.js",
     "./tsx": "./tsx.js",
-    "./test": "./test.js"
+    "./test": "./test.js",
+    "./ignores": "./ignores.js"
   }
 }

README.md

@@ -21,2 +21,3 @@ # @bonniernews/eslint-config
     - [Typed react configuration](#typed-react-configuration)
+    - [Global ignores](#global-ignores)
   - [Migrating from 1.X to 2.X](#migrating-from-1x-to-2x)
@@ -103,2 +104,17 @@ - [Running eslint](#running-eslint)
 
+### Global ignores
+
+To activate this config (in addition to other config(s), using it alone makes no sense), add the following:
+
+```javascript
+"use strict";
+
+const ignores = require("@bonniernews/eslint-config/ignores");
+
+module.exports = [
+  ...allYourGoodConfigs,
+  ignores
+];
+```
+
 ## Migrating from 1.X to 2.X
@@ -112,2 +128,5 @@
 
+One major change from eslint 8 is that in order for ignores to be global they need to be added in a single config at the root level. If you just use the `@bonniernews/eslint-config`
+you will have it included, but if you construct your own set of rules you need to add it manually to your config file, otherwise eslint will run on files in terraform directories and such.
+
 The different rule sets have changed name and behaviour:
@@ -121,2 +140,3 @@
 * `@bonniernews/eslint-config/test` config for test files using mocha-cakes-2 and chai
+* `@bonniernews/eslint-config/ignores` global ignores
 
@@ -123,0 +143,0 @@ ## Running eslint

No alert changes

Improved metrics

Total package byte prevSize

31278

2.87%

Number of package files

16

6.67%

Lines of code

558

0.54%

Number of lines in readme file

202

10.99%

No dependency changes