Switch to ESLint Flat Config (#301)

upleveled · Nov 12, 2023 · a441b57 · a441b57
1 parent 6bea504
commit a441b57
Show file tree

Hide file tree

Showing 44 changed files with 700 additions and 1,541 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
diff --git a/__tests__/.eslintignore b/__tests__/.eslintignore
diff --git a/__tests__/.eslintrc.cjs b/__tests__/.eslintrc.cjs
diff --git a/__tests__/eslint.config.js b/__tests__/eslint.config.js
@@ -0,0 +1 @@
+export { default } from 'eslint-config-upleveled';
diff --git a/__tests__/package.json b/__tests__/package.json
@@ -8,6 +8,7 @@
     "Karl Horky <karl.horky@gmail.com>",
     "Jose Höwer <josehower@gmail.com>"
   ],
+  "type": "module",
   "main": "index.js",
   "scripts": {
     "update-config-version": "pnpm add --save-dev eslint-config-upleveled@latest && pnpm upleveled-eslint-install"
@@ -18,7 +19,7 @@
   "devDependencies": {
     "@types/react": "^18.2.14",
     "@types/react-dom": "^18.2.6",
-    "eslint-config-upleveled": "^6.1.2",
+    "eslint-config-upleveled": "^7.0.0-1",
     "postcss-styled-syntax": "^0.5.0",
     "stylelint": "^15.9.0",
     "stylelint-config-upleveled": "^1.0.2",

diff --git a/__tests__/pnpm-lock.yaml b/__tests__/pnpm-lock.yaml
diff --git a/__tests__/tsconfig.json b/__tests__/tsconfig.json
@@ -9,7 +9,6 @@
     ]
   },
   "include": [
-    "**/.eslintrc.cjs",
     "**/*.ts",
     "**/*.tsx",
     "**/*.js",

diff --git a/bin/install.js b/bin/install.js
@@ -13,8 +13,9 @@ import {
 import { dirname, join, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
+const projectPackageJsonPath = join(process.cwd(), 'package.json');
 const projectPackageJson = JSON.parse(
-  readFileSync(join(process.cwd(), 'package.json'), 'utf-8'),
+  readFileSync(projectPackageJsonPath, 'utf-8'),
 );
 
 const projectDependencies = projectPackageJson.dependencies || {};
@@ -45,10 +46,22 @@ console.log(`Detected project type: ${projectTypeTitle}`);
 //   }
 // }
 //
-// writeFileSync(
-//   projectPackageJsonPath,
-//   JSON.stringify(projectPackageJson, null, 2) + '\n',
-// );
+
+// Set "type": "module" in package.json for support
+// of ESM syntax in eslint.config.js
+//
+// ESLint does not support other ways of specifying
+// that the config file is ESM such as an .mjs extension:
+// https://github.com/eslint/eslint/issues/13440
+// https://github.com/eslint/eslint/issues/16580
+if (projectPackageJson.type !== 'module') {
+  projectPackageJson.type = 'module';
+
+  writeFileSync(
+    projectPackageJsonPath,
+    JSON.stringify(projectPackageJson, null, 2) + '\n',
+  );
+}
 
 const newDevDependenciesToInstall = [
   // pnpm v8+ automatically installs peer dependencies (auto-install-peers=true

diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,11 @@
+import upleveled from './index.js';
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+const config = [
+  ...upleveled,
+  {
+    ignores: ['__tests__/**/*'],
+  },
+];
+
+export default config;