add files to simplify usage

eslint · Jul 7, 2023 · 42ba8de · 42ba8de
1 parent 6f71c8e
commit 42ba8de
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 19 deletions.
diff --git a/packages/eslint-config-eslint/README.md b/packages/eslint-config-eslint/README.md
@@ -22,36 +22,28 @@ npm install eslint-config-eslint --save-dev
 
 ## Usage
 
+### ESM (`"type":"module"`) projects
+
 In your `eslint.config.js` file, add:
 
 ```js
-// ESM project
 import eslintConfigESLint from "eslint-config-eslint";
 
 export default [
     ...eslintConfigESLint
 ];
 ```
 
-```js
-// ESM project containing .cjs files
-import eslintConfigESLint from "eslint-config-eslint";
-import eslintConfigESLintCJS from "eslint-config-eslint/cjs";
+**Note**: This configuration array contains configuration objects with the `files` property.
 
-export default [
-    ...eslintConfigESLint.map(config => ({
-        files: ["**/*.js"],
-        ...config
-    })),
-    ...eslintConfigESLintCJS.map(config => ({
-        files: ["**/*.cjs"],
-        ...config
-    }))
-];
-```
+* `files: ["**/*.js"]`: ESM-specific configurations.
+* `files: ["**/*.cjs"]`: CommonJS-specific configurations.
+
+### CommonJS projects
+
+In your `eslint.config.js` file, add:
 
 ```js
-// CommonJS project
 const eslintConfigESLintCJS = require("eslint-config-eslint/cjs");
 
 module.exports = [

diff --git a/packages/eslint-config-eslint/index.js b/packages/eslint-config-eslint/index.js
@@ -1,9 +1,16 @@
 "use strict";
 
 const baseConfigs = require("./base");
-const { esmConfigs } = require("./nodejs");
+const { esmConfigs, cjsConfigs } = require("./nodejs");
 
 module.exports = [
     ...baseConfigs,
-    ...esmConfigs
+    ...esmConfigs.map(config => ({
+        files: ["**/*.js"],
+        ...config
+    })),
+    ...cjsConfigs.map(config => ({
+        files: ["**/*.cjs"],
+        ...config
+    }))
 ];