feat(eslint): add flat configs

eslint.config.mjs

@@ -0,0 +1,26 @@
+import globals from 'globals';
+import flat from './eslint/flat/index.js';
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  ...flat.configs.recommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+    },
+  },
+  {
+    files: ['eslint/rules/**'],
+    rules: {
+      'sort-keys': 'error',
+    },
+  },
+  {
+    files: ['*.config.mjs'],
+    rules: {
+      'import/no-default-export': 'off',
+    },
+  },
+];

eslint/_base.js

@@ -12,12 +12,12 @@ module.exports = {
     'plugin:import/recommended',
     'prettier',
     require.resolve('./rules/best-practice'),
-    require.resolve('./rules/comments'),
+    require.resolve('./comments'),
     require.resolve('./rules/es6'),
     require.resolve('./rules/import'),
     require.resolve('./rules/possible-errors'),
     require.resolve('./rules/stylistic'),
-    require.resolve('./rules/unicorn'),
+    require.resolve('./unicorn'),
     require.resolve('./rules/variables'),
   ],
   env: {

eslint/comments.js

@@ -1,6 +1,6 @@
 module.exports = {
   extends: [
-    'plugin:eslint-comments/recommended',
+    'plugin:@eslint-community/eslint-comments/recommended',
     require.resolve('./rules/comments'),
   ],
 };

eslint/flat/_base.js

@@ -0,0 +1,48 @@
+const babelParser = require('@babel/eslint-parser');
+const eslint = require('@eslint/js');
+const prettier = require('eslint-config-prettier');
+const commentsConfig = require('./comments');
+const importConfig = require('./import');
+const unicornConfig = require('./unicorn');
+const { ECMA_VERSION, JAVASCRIPT_FILES } = require('./constants');
+
+/**
+ * This is the base for both our browser and Node ESLint config files.
+ * @type {import('eslint').Linter.Config[]}
+ */
+module.exports = [
+  eslint.configs.recommended,
+  prettier,
+  commentsConfig,
+  importConfig,
+  unicornConfig,
+  {
+    rules: {
+      ...require('../rules/best-practice').rules,
+      ...require('../rules/es6').rules,
+      ...require('../rules/possible-errors').rules,
+      ...require('../rules/stylistic').rules,
+      ...require('../rules/variables').rules,
+    },
+    settings: {
+      'import/resolver': {
+        typescript: true,
+      },
+    },
+  },
+  {
+    files: JAVASCRIPT_FILES,
+    ignores: ['!.*.js'],
+    linterOptions: {
+      reportUnusedDisableDirectives: 'warn',
+    },
+    languageOptions: {
+      ecmaVersion: ECMA_VERSION,
+      sourceType: 'module',
+      parser: babelParser,
+      parserOptions: {
+        requireConfigFile: false,
+      },
+    },
+  },
+];

eslint/flat/comments.js

@@ -0,0 +1,10 @@
+const comments = require('@eslint-community/eslint-plugin-eslint-comments/configs');
+
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  ...comments.recommended,
+  rules: {
+    ...comments.recommended.rules,
+    ...require('../rules/comments').rules,
+  },
+};

eslint/flat/constants.js

@@ -0,0 +1,5 @@
+module.exports = {
+  ECMA_VERSION: 2021,
+  JAVASCRIPT_FILES: ['**/*.js?(x)', '**/*.(c|m)?js'],
+  TYPESCRIPT_FILES: ['**/*.ts?(x)'],
+};

eslint/flat/import.js

@@ -0,0 +1,10 @@
+const importPlugin = require('eslint-plugin-import');
+
+/** @type {improt('eslint').Linter.Config} */
+module.exports = {
+  ...importPlugin.flatConfigs.recommended,
+  rules: {
+    ...importPlugin.flatConfigs.recommended.rules,
+    ...require('../rules/import').rules,
+  },
+};

eslint/flat/index.js

@@ -0,0 +1,13 @@
+module.exports = {
+  configs: {
+    recommended: require('./_base'),
+    jest: require('./jest'),
+    'jest-typescript': require('./jest-typescript'),
+    next: require('./next'),
+    'playwright-test': require('./playwright-test'),
+    react: require('./react'),
+    'testing-library': require('./testing-library'),
+    typescript: require('./typescript'),
+    vitest: require('./vitest'),
+  },
+};

eslint/flat/jest-typescript.js

@@ -0,0 +1,10 @@
+const { TYPESCRIPT_FILES } = require('./constants');
+
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  files: TYPESCRIPT_FILES,
+  rules: {
+    '@typescript-eslint/unbound-method': 'off',
+    'jest/unbound-method': 'error',
+  },
+};

eslint/flat/jest.js

@@ -0,0 +1,10 @@
+const jest = require('eslint-plugin-jest');
+
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  ...jest.configs['flat/recommended'],
+  rules: {
+    ...jest.configs['flat/recommended'].rules,
+    ...require('../rules/jest').rules,
+  },
+};

eslint/flat/next.js

@@ -0,0 +1,42 @@
+const next = require('@next/eslint-plugin-next');
+const requirePackage = require('../utils/require-package');
+const { JAVASCRIPT_FILES } = require('./constants');
+
+requirePackage('next', '@next/eslint-plugin-next');
+
+const babelOptions = {
+  presets: (() => {
+    try {
+      require.resolve('next/babel');
+      return ['next/babel'];
+    } catch {
+      return [];
+    }
+  })(),
+};
+
+/** @type {import('eslint').Linter.Config[]} */
+module.exports = [
+  {
+    plugins: {
+      '@next/next': next,
+    },
+    rules: {
+      ...next.configs.recommended.rules,
+    },
+    languageOptions: {
+      parserOptions: {
+        babelOptions,
+      },
+    },
+    ignores: ['**/.next/**'],
+  },
+  {
+    files: JAVASCRIPT_FILES,
+    languageOptions: {
+      parserOptions: {
+        babelOptions,
+      },
+    },
+  },
+];

eslint/flat/playwright-test.js

@@ -0,0 +1,10 @@
+const playwright = require('eslint-plugin-playwright');
+
+/** @type {import('eslint').Linter} */
+module.exports = {
+  ...playwright.configs['flat/recommended'],
+  rules: {
+    ...playwright.configs['flat/recommended'].rules,
+    ...require('../rules/playwright-test').rules,
+  },
+};

eslint/flat/react.js

@@ -0,0 +1,33 @@
+const react = require('eslint-plugin-react');
+const reactHooks = require('eslint-plugin-react-hooks');
+const jsxA11y = require('eslint-plugin-jsx-a11y');
+const importPlugin = require('eslint-plugin-import');
+const prettier = require('eslint-config-prettier');
+
+/** @type {import('eslint').Linter.Config[]} */
+module.exports = [
+  react.configs.flat.recommended,
+  react.configs.flat['jsx-runtime'],
+  {
+    plugins: {
+      'react-hooks': reactHooks,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+    },
+  },
+  jsxA11y.flatConfigs.recommended,
+  {
+    rules: {
+      ...require('../rules/react').rules,
+      ...require('../rules/jsx-a11y').rules,
+    },
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+  },
+  importPlugin.flatConfigs.react,
+  prettier,
+];

eslint/flat/testing-library.js

@@ -0,0 +1,6 @@
+const testingLibrary = require('eslint-plugin-testing-library');
+
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  ...testingLibrary.configs['flat/react'],
+};

eslint/flat/tsdoc.js

@@ -0,0 +1,11 @@
+const tsdoc = require('eslint-plugin-tsdoc');
+
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  plugins: {
+    tsdoc,
+  },
+  rules: {
+    ...require('../rules/tsdoc').rules,
+  },
+};

eslint/flat/typescript.js

@@ -0,0 +1,30 @@
+const tseslint = require('typescript-eslint');
+const importPlugin = require('eslint-plugin-import');
+const prettier = require('eslint-config-prettier');
+const requirePackage = require('../utils/require-package');
+const { TYPESCRIPT_FILES } = require('./constants');
+const tsdoc = require('./tsdoc');
+
+requirePackage('typescript', 'typescript');
+
+/** @type {import('eslint').Linter.Config[]} */
+module.exports = [
+  ...tseslint.configs.strictTypeChecked,
+  ...tseslint.configs.stylisticTypeChecked,
+  importPlugin.flatConfigs.typescript,
+  prettier,
+  tsdoc,
+  {
+    files: TYPESCRIPT_FILES,
+    rules: {
+      ...require('../rules/typescript').rules,
+      ...require('../rules/typescript/extension').rules,
+      ...require('../rules/typescript/import').rules,
+    },
+    settings: {
+      'import/resolver': {
+        typescript: true,
+      },
+    },
+  },
+];

eslint/flat/unicorn.js

@@ -0,0 +1,11 @@
+const unicorn = require('eslint-plugin-unicorn');
+
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  plugins: {
+    unicorn,
+  },
+  rules: {
+    ...require('../rules/unicorn').rules,
+  },
+};

eslint/flat/vitest.js

@@ -0,0 +1,12 @@
+const vitest = require('@vitest/eslint-plugin');
+
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  plugins: {
+    vitest,
+  },
+  rules: {
+    ...vitest.configs.recommended.rules,
+    ...require('../rules/vitest').rules,
+  },
+};

eslint/next.js

@@ -8,7 +8,7 @@ const babelOptions = {
     try {
       require.resolve('next/babel');
       return ['next/babel'];
-    } catch (e) {
+    } catch {
       return [];
     }
   })(),

eslint/rules/comments.js

@@ -1,11 +1,10 @@
 module.exports = {
-  plugins: ['eslint-comments'],
   rules: {
     /**
      * Require comments on ESlint disable directives.
      *
      * 🚫 Not fixable - https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/require-description.html
      */
-    'eslint-comments/require-description': 'error',
+    '@eslint-community/eslint-comments/require-description': 'error',
   },
 };

eslint/rules/tsdoc.js

@@ -1,5 +1,4 @@
 module.exports = {
-  plugins: ['eslint-plugin-tsdoc'],
   rules: {
     /**
      * Require TSDoc comments conform to the TSDoc specification.

eslint/rules/unicorn.js

@@ -1,5 +1,4 @@
 module.exports = {
-  plugins: ['unicorn'],
   rules: {
     /**
      * Require consistent filename case for all linted files.

eslint/tsdoc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  plugins: ['eslint-plugin-tsdoc'],
+  extends: [require.resolve('./rules/tsdoc')],
+};

eslint/typescript.js

@@ -16,7 +16,7 @@ module.exports = {
         require.resolve('./rules/typescript'),
         require.resolve('./rules/typescript/extension'),
         require.resolve('./rules/typescript/import'),
-        require.resolve('./rules/tsdoc'),
+        require.resolve('./tsdoc'),
       ],
     },
   ],

eslint/unicorn.js

@@ -0,0 +1,4 @@
+module.exports = {
+  plugins: ['unicorn'],
+  extends: [require.resolve('./rules/unicorn.js')],
+};

eslint/utils/require-package.js

@@ -18,7 +18,7 @@ function readPackageManager() {
 module.exports = (configName, packageName) => {
   try {
     require.resolve(packageName);
-  } catch (e) {
+  } catch {
     const packageManager = readPackageManager();
     const command = packageManager === 'yarn' ? 'add' : 'install';