feat: migrate to v9

BREAKING CHANGE: migrates to v9

README.md

@@ -11,10 +11,13 @@ Canonical consists of 1,000+ rules (40% auto-fixable), some of which are [custom
 
 Most projects should simply extend from [`canonical/auto`](#canonicalauto-ruleset):
 
-```json
-{
-  "extends": "canonical/auto"
-}
+```ts
+// eslint.config.js
+import auto from 'eslint-config-canonical/configurations/auto';
+
+export default [
+  auto
+];
 ```
 
 ## Rulesets

bin/generate-typescript-compatibility-rules.js

@@ -30,5 +30,5 @@ const orderedRules = {
   rules: Object.fromEntries(Object.entries(appendRules).sort()),
 };
 
-// eslint-disable-next-line no-console -- CLI
+// eslint-disable-next-line no-console
 console.log('module.exports = ' + JSON.stringify(orderedRules, '', '  '));

compare/compare.js

@@ -1,5 +1,5 @@
-/* eslint-disable complexity */
 /* eslint-disable no-console */
+/* eslint-disable complexity */
 
 const { writeFile, readFile } = require('node:fs/promises');
 const { resolve } = require('node:path');

compare/find-deprecated.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-console */
-
 /**
  * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/issues/825
  * https://github.com/eslint/eslint/issues/15292
@@ -29,6 +27,7 @@ const { getLoadedRules } = require('./utilities');
     });
 
     if (response.toLowerCase().includes('deprecated')) {
+      // eslint-disable-next-line no-console
       console.warn(
         '⚠️  ' +
           ruleName +

compare/utilities.js

@@ -1,3 +1,6 @@
+/* eslint-disable complexity */
+/* eslint-disable import/no-dynamic-require */
+
 const { ESLint } = require('eslint');
 const { builtinRules } = require('eslint/use-at-your-own-risk');
 
@@ -95,7 +98,6 @@ const getConfigurationRules = async (configuration) => {
   return calculatedConfiguration.rules;
 };
 
-// eslint-disable-next-line complexity
 const getRuleLink = (ruleName) => {
   if (!ruleName.includes('/')) {
     return (

configurations/auto.js

@@ -1,48 +1,11 @@
-module.exports = {
-  overrides: [
-    {
-      extends: [
-        'canonical',
-        'canonical/regexp',
-        'canonical/jsdoc',
-        'canonical/node',
-        'canonical/prettier',
-      ],
-      files: ['*.js', '*.mjs', '*.cjs'],
-    },
-    {
-      extends: [
-        'canonical',
-        'canonical/regexp',
-        'canonical/jsdoc',
-        'canonical/node',
-        'canonical/typescript',
-        'canonical/prettier',
-      ],
-      files: ['*.ts'],
-    },
-    {
-      extends: [
-        'canonical',
-        'canonical/regexp',
-        'canonical/jsdoc',
-        'canonical/react',
-        'canonical/typescript',
-        'canonical/prettier',
-      ],
-      files: ['*.tsx'],
-    },
-    {
-      extends: ['canonical/json'],
-      files: '*.json',
-    },
-    {
-      extends: ['canonical/yaml'],
-      files: '*.yaml',
-    },
-    {
-      extends: ['canonical/graphql'],
-      files: '*.graphql',
-    },
-  ],
-};
+module.exports = [
+  require('./canonical').recommended,
+  require('./typescript').recommended,
+  require('./regexp').recommended,
+  require('./jsdoc').recommended,
+  require('./react').recommended,
+  require('./prettier').recommended,
+  require('./json').recommended,
+  require('./yaml').recommended,
+  require('./graphql').recommended,
+];

configurations/auto.test.js

@@ -0,0 +1,5 @@
+const test = require('ava');
+
+test('foo', (t) => {
+  t.pass();
+});

configurations/ava.js

@@ -1,5 +1,12 @@
-module.exports = {
-  plugins: ['ava', 'unicorn'],
+const ava = require('eslint-plugin-ava');
+const unicorn = require('eslint-plugin-unicorn');
+
+module.exports.recommended = {
+  files: ['**/*.test.{js,ts,tsx}'],
+  plugins: {
+    ava,
+    unicorn,
+  },
   rules: {
     'ava/assertion-arguments': 2,
     'ava/hooks-order': 2,

configurations/browser.js

@@ -1,8 +1,14 @@
-module.exports = {
-  env: {
-    browser: true,
+const globals = require('globals');
+
+module.exports.recommended = {
+  languageOptions: {
+    globals: {
+      ...globals.browser,
+    },
+  },
+  plugins: {
+    unicorn: require('eslint-plugin-unicorn'),
   },
-  plugins: ['unicorn'],
   rules: {
     'unicorn/prefer-dom-node-append': 2,
     'unicorn/prefer-dom-node-dataset': 2,

configurations/eslintrc.js → configurations/canonical.js

@@ -21,15 +21,22 @@ const importRules = {
   'import/max-dependencies': 0,
   'import/named': 0,
   'import/namespace': 0,
-  'import/newline-after-import': 2,
+  // TODO broke after ESLint upgrade to v9
+  // 'import/newline-after-import': 2,
   'import/no-absolute-path': 2,
-  'import/no-amd': 2,
+  // TODO broke after ESLint upgrade to v9
+  // 'import/no-amd': 2,
   'import/no-anonymous-default-export': 0,
   'import/no-commonjs': 0,
   'import/no-cycle': 2,
   'import/no-default-export': 0,
   'import/no-deprecated': 1,
-  'import/no-duplicates': [2, { 'prefer-inline': true }],
+  'import/no-duplicates': [
+    2,
+    {
+      'prefer-inline': true,
+    },
+  ],
   'import/no-dynamic-require': 2,
   'import/no-extraneous-dependencies': [
     2,
@@ -194,33 +201,32 @@ const unicornRules = {
   'unicorn/throw-new-error': 2,
 };
 
-module.exports = {
-  env: {
-    es6: true,
-  },
-  parser: '@babel/eslint-parser',
-  parserOptions: {
-    babelOptions: {
-      plugins: ['@babel/plugin-syntax-import-assertions'],
-    },
-    ecmaFeatures: {
-      globalReturn: false,
-      impliedStrict: true,
-      jsx: true,
+module.exports.recommended = {
+  languageOptions: {
+    parser: require('@babel/eslint-parser'),
+    parserOptions: {
+      babelOptions: {
+        plugins: ['@babel/plugin-syntax-import-assertions'],
+      },
+      ecmaFeatures: {
+        globalReturn: false,
+        impliedStrict: true,
+        jsx: true,
+      },
+      ecmaVersion: 2_021,
+      requireConfigFile: false,
+      sourceType: 'module',
     },
-    ecmaVersion: 2_021,
-    requireConfigFile: false,
-    sourceType: 'module',
   },
-  plugins: [
-    'canonical',
-    '@babel',
-    'import',
-    'unicorn',
-    'eslint-comments',
-    'promise',
-    'simple-import-sort',
-  ],
+  plugins: {
+    '@babel': require('@babel/eslint-plugin'),
+    canonical: require('eslint-plugin-canonical'),
+    'eslint-comments': require('eslint-plugin-eslint-comments'),
+    import: require('eslint-plugin-import'),
+    promise: require('eslint-plugin-promise'),
+    'simple-import-sort': require('eslint-plugin-simple-import-sort'),
+    unicorn: require('eslint-plugin-unicorn'),
+  },
   rules: {
     ...importRules,
     ...unicornRules,
@@ -664,7 +670,8 @@ module.exports = {
     'prefer-template': 0,
     'promise/param-names': 2,
     'promise/prefer-await-to-callbacks': 0,
-    'promise/prefer-await-to-then': 2,
+    // TODO broke after ESLint upgrade to v9
+    // 'promise/prefer-await-to-then': 2,
     'promise/valid-params': 2,
     'quote-props': [
       2,
@@ -690,7 +697,12 @@ module.exports = {
     ],
     'semi-style': [2, 'last'],
     'simple-import-sort/exports': 2,
-    'simple-import-sort/imports': [2, { groups: [] }],
+    'simple-import-sort/imports': [
+      2,
+      {
+        groups: [],
+      },
+    ],
     'sort-imports': 0,
     'sort-keys': 0,
     'sort-vars': 2,

configurations/cypress.js

@@ -1,8 +1,10 @@
-module.exports = {
-  env: {
-    'cypress/globals': true,
+module.exports.recommended = {
+  // env: {
+  //   'cypress/globals': true,
+  // },
+  plugins: {
+    cypress: require('eslint-plugin-cypress'),
   },
-  plugins: ['cypress'],
   rules: {
     'cypress/assertion-before-screenshot': 2,
     'cypress/no-assigning-return-values': 2,

configurations/flowtype.js

@@ -1,5 +1,7 @@
-module.exports = {
-  plugins: ['flowtype'],
+module.exports.recommended = {
+  plugins: {
+    flowtype: require('eslint-plugin-flowtype'),
+  },
   rules: {
     'flowtype/array-style-complex-type': [2, 'verbose'],
     'flowtype/array-style-simple-type': [2, 'shorthand'],

configurations/graphql.js

@@ -1,6 +1,11 @@
-module.exports = {
-  parser: '@graphql-eslint/eslint-plugin',
-  plugins: ['@graphql-eslint'],
+module.exports.recommended = {
+  files: ['*.graphql'],
+  languageOptions: {
+    parser: require('@graphql-eslint/eslint-plugin'),
+  },
+  plugins: {
+    '@graphql-eslint': require('@graphql-eslint/eslint-plugin'),
+  },
   rules: {
     '@graphql-eslint/alphabetize': [
       2,

configurations/jest.js

@@ -1,8 +1,9 @@
-module.exports = {
-  env: {
-    jest: true,
-  },
-  plugins: ['jest'],
+module.exports.recommended = {
+  plugins: [
+    {
+      jest: require('eslint-plugin-jest'),
+    },
+  ],
   rules: {
     'jest/consistent-test-it': 2,
     'jest/expect-expect': 2,

configurations/jsdoc.js

@@ -1,5 +1,7 @@
-module.exports = {
-  plugins: ['jsdoc'],
+module.exports.recommended = {
+  plugins: {
+    jsdoc: require('eslint-plugin-jsdoc'),
+  },
   rules: {
     'jsdoc/check-access': 2,
     'jsdoc/check-alignment': 2,

configurations/json.js

@@ -1,6 +1,11 @@
-module.exports = {
-  parser: 'jsonc-eslint-parser',
-  plugins: ['jsonc'],
+module.exports.recommended = {
+  files: ['*.json'],
+  languageOptions: {
+    parser: require('eslint-plugin-jsonc'),
+  },
+  plugins: {
+    jsonc: require('eslint-plugin-jsonc'),
+  },
   rules: {
     'jsonc/array-bracket-newline': [
       2,

configurations/jsx-a11y.js

@@ -1,10 +1,12 @@
-module.exports = {
+module.exports.recommended = {
   parserOptions: {
     ecmaFeatures: {
       jsx: true,
     },
   },
-  plugins: ['jsx-a11y'],
+  plugins: {
+    'jsx-a11y': require('eslint-plugin-jsx-a11y'),
+  },
   rules: {
     'jsx-a11y/alt-text': 2,
     'jsx-a11y/anchor-has-content': 2,

configurations/lodash.js

@@ -1,5 +1,7 @@
-module.exports = {
-  plugins: ['lodash'],
+module.exports.recommended = {
+  plugins: {
+    lodash: require('eslint-plugin-lodash'),
+  },
   rules: {
     'lodash/callback-binding': 2,
     'lodash/chain-style': [2, 'explicit'],