FIxed recommended config for legacy eslintrc config format (#36)

* Added v8 compatibility test * Added a legacy config * Clean up scripts * updated readme * Keep things the same for eslintrc * Imporved the naming
ihordiachenko · Jun 3, 2024 · 7d1d73e · 7d1d73e
1 parent 3ab221e
commit 7d1d73e
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ ESLint 9 flat config format:
 const pluginChaiFriendly = require("eslint-plugin-chai-friendly");
 
 module.exports = [
-    pluginChaiFriendly.configs.recommended,
+    pluginChaiFriendly.configs.recommendedFlat,
     // other configurations
 ]
 ```

diff --git a/eslint.config.js b/eslint.config.js
@@ -3,7 +3,7 @@
 const pluginChaiFriendly = require("./lib");
 
 module.exports = [
-    pluginChaiFriendly.configs.recommended,
+    pluginChaiFriendly.configs.recommendedFlat,
     {
         ignores: ["node_modules", "!.eslintrc.js", "examples"],
     }

diff --git a/lib/index.js b/lib/index.js
@@ -19,14 +19,26 @@ const plugin = {
 
 // assign configs here so we can reference `plugin`
 Object.assign(plugin.configs, {
-    recommended: {
+    // Compatible with ESLint v9 flat configs
+    recommendedFlat: {
         plugins: {
             'chai-friendly': plugin
         },
         rules: {
             'chai-friendly/no-unused-expressions': 'error',
             'no-unused-expressions': 'off'
         }
+    },
+
+    // Compatible with ESLint <9 eslintrc configs
+    recommended: {
+        plugins: [
+            'chai-friendly'
+        ],
+        rules: {
+            'no-unused-expressions': 0, // disable original rule
+            'chai-friendly/no-unused-expressions': 2
+        }
     }
 },)