chore: refactor all rulesets to use defineConfig() ♻️

Author: robertrossmann

eslint.config.js

@@ -1,7 +1,7 @@
 import { defineConfig } from 'eslint/config'
-import node from './packages/eslint-config-node/index.mjs'
-import optional from './packages/eslint-config-node/optional.mjs'
-import style from './packages/eslint-config-node/style.mjs'
+import node from '@strv/eslint-config-node'
+import optional from '@strv/eslint-config-node/optional'
+import style from '@strv/eslint-config-node/style'
 
 export default defineConfig([{
   files: ['**/*.js', '**/*.cjs', '**/*.mjs'],

packages/eslint-config-base/index.mjs

@@ -1,8 +1,10 @@
+import { defineConfig } from 'eslint/config'
 import imports from 'eslint-plugin-import'
 import stylistic from '@stylistic/eslint-plugin'
 
-/** @type {import("eslint").Linter.Config} */
-const config = {
+/** @returns {ReturnType<typeof defineConfig>} */
+export default defineConfig({
+  name: '@strv/eslint-config-base',
   plugins: {
     import: imports,
     '@stylistic': stylistic,
@@ -652,6 +654,4 @@ const config = {
     // Disabled because ES Modules require file extension to be supplied
     // 'import/extensions': ['warn', { json: 'aways' }],
   },
-}
-
-export default config
+})

packages/eslint-config-base/optional.mjs

@@ -1,10 +1,8 @@
-import imports from 'eslint-plugin-import'
+import { defineConfig } from 'eslint/config'
 
-/** @type {import("eslint").Linter.Config} */
-const config = {
-  plugins: {
-    import: imports,
-  },
+/** @returns {ReturnType<typeof defineConfig>} */
+export default defineConfig({
+  name: '@strv/eslint-config-base/optional',
   rules: {
     // Require Consistent Returns
     // This rule is aimed at ensuring all return statements either specify a value or don't specify
@@ -51,6 +49,4 @@ const config = {
     // Reports if a resolved path is imported more than once
     'import/no-duplicates': 'warn',
   },
-}
-
-export default config
+})

packages/eslint-config-base/style.mjs

@@ -1,10 +1,10 @@
-import imports from 'eslint-plugin-import'
+import { defineConfig } from 'eslint/config'
 import stylistic from '@stylistic/eslint-plugin'
 
-/** @type {import("eslint").Linter.Config} */
-const config = {
+/** @returns {ReturnType<typeof defineConfig>} */
+export default defineConfig({
+  name: '@strv/eslint-config-base/style',
   plugins: {
-    import: imports,
     '@stylistic': stylistic,
   },
   rules: {
@@ -606,6 +606,4 @@ const config = {
     // Enforces having an empty line after the last top-level import statement or require call
     'import/newline-after-import': 'warn',
   },
-}
-
-export default config
+})

packages/eslint-config-graphql/index.mjs

@@ -1,8 +1,10 @@
+import { defineConfig } from 'eslint/config'
 // TODO: Deprecated. Move to https://github.com/dimaMachina/graphql-eslint
 import graphql from 'eslint-plugin-graphql'
 
-/** @type {import("eslint").Linter.Config} */
-const config = {
+/** @returns {ReturnType<typeof defineConfig>} */
+export default defineConfig({
+  name: '@strv/eslint-config-graphql',
   plugins: {
     graphql,
   },
@@ -11,6 +13,4 @@ const config = {
       env: 'apollo',
     }],
   },
-}
-
-export default config
+})

packages/eslint-config-mocha/index.mjs

@@ -1,8 +1,10 @@
+import { defineConfig } from 'eslint/config'
 import mocha from 'eslint-plugin-mocha'
 import imports from 'eslint-plugin-import'
 
-/** @type {import("eslint").Linter.Config} */
-const config = {
+/** @returns {ReturnType<typeof defineConfig>} */
+export default defineConfig({
+  name: '@strv/eslint-config-mocha',
   plugins: {
     mocha,
     import: imports,
@@ -81,6 +83,4 @@ const config = {
     // project. Test files are usually sourced by Mocha directly.
     'import/no-unused-modules': 'off',
   },
-}
-
-export default config
+})

packages/eslint-config-node/index.mjs

@@ -1,15 +1,17 @@
+import { defineConfig } from 'eslint/config'
 import node from 'eslint-plugin-n'
 import base from '@strv/eslint-config-base'
 
-/** @type {import("eslint").Linter.Config} */
-const config = {
+/** @returns {ReturnType<typeof defineConfig>} */
+export default defineConfig({
+  name: '@strv/eslint-config-node',
+  extends: [
+    base,
+  ],
   plugins: {
-    ...base.plugins,
     node,
   },
   rules: {
-    ...base.rules,
-
     // Disallow use of the deprecated Buffer() constructor
     // In Node.js, the behavior of the Buffer constructor is different depending on the type of its
     // argument. Passing an argument from user input to Buffer() without validating its type can
@@ -114,6 +116,4 @@ const config = {
     // so we should not use those.
     'node/no-deprecated-api': 'warn',
   },
-}
-
-export default config
+})

packages/eslint-config-react/index.mjs

@@ -1,13 +1,17 @@
+import { defineConfig } from 'eslint/config'
 import parser from '@babel/eslint-parser'
 import base from '@strv/eslint-config-base'
 import react from 'eslint-plugin-react'
 import a11y from 'eslint-plugin-jsx-a11y'
 import hooks from 'eslint-plugin-react-hooks'
 
-/** @type {import("eslint").Linter.Config} */
-const config = {
+/** @returns {ReturnType<typeof defineConfig>} */
+export default defineConfig({
+  name: '@strv/eslint-config-react',
+  extends: [
+    base,
+  ],
   plugins: {
-    ...base.plugins,
     react,
     'jsx-a11y': a11y,
     'react-hooks': hooks,
@@ -22,8 +26,6 @@ const config = {
     react: { version: 'detect' },
   },
   rules: {
-    ...base.rules,
-
     // Enforces consistent naming for boolean props
     // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/boolean-prop-naming.md
     'react/boolean-prop-naming': [
@@ -525,6 +527,4 @@ const config = {
     'import/exports-last': 'off',
     'import/no-default-export': 'error',
   },
-}
-
-export default config
+})

packages/eslint-config-react/style.mjs

@@ -1,15 +1,17 @@
+import { defineConfig } from 'eslint/config'
 import style from '@strv/eslint-config-base/style'
 import react from 'eslint-plugin-react'
 
-/** @type {import("eslint").Linter.Config} */
-const config = {
+/** @returns {ReturnType<typeof defineConfig>} */
+export default defineConfig({
+  name: '@strv/eslint-config-react/style',
+  extends: [
+    style,
+  ],
   plugins: {
-    ...style.plugins,
     react,
   },
   rules: {
-    ...style.rules,
-
     // Enforce consistent usage of destructuring assignment of props, state, and context
     'react/destructuring-assignment': [
       'warn',
@@ -120,6 +122,4 @@ const config = {
     // when trying to auto fix this rule it breaks React syntax
     'arrow-body-style': 'off',
   },
-}
-
-export default config
+})

packages/eslint-config-typescript/index.mjs

@@ -1,12 +1,13 @@
+import { defineConfig } from 'eslint/config'
 import base from '@strv/eslint-config-base'
 import ts from '@typescript-eslint/eslint-plugin'
 import parser from '@typescript-eslint/parser'
 import stylisticts from '@stylistic/eslint-plugin-ts'
 
-/** @type {import("eslint").Linter.Config} */
-const config = {
+/** @returns {ReturnType<typeof defineConfig>} */
+export default defineConfig({
+  name: '@strv/eslint-config-typescript',
   plugins: {
-    ...base.plugins,
     '@typescript-eslint': ts,
     '@stylistic/ts': stylisticts,
   },
@@ -20,7 +21,6 @@ const config = {
     'import/resolver': { typescript: {} },
   },
   rules: {
-    ...base.rules,
     // Disabled because it generates false positives with interface declarations and TypeScript
     // blows up anyway during compilation when it encouters an undefined variable.
     'no-undef': 'off',
@@ -90,7 +90,7 @@ const config = {
     // Use of the Array constructor to construct a new array is generally discouraged in favor of
     // array literal notation because of the single-argument pitfall and because the Array global
     // may be redefined.
-    '@typescript-eslint/no-array-constructor': base.rules['no-array-constructor'],
+    '@typescript-eslint/no-array-constructor': base[0].rules['no-array-constructor'],
     'no-array-constructor': 'off',
 
     // Require that .toString() is only called on objects which provide useful information
@@ -101,7 +101,7 @@ const config = {
     '@typescript-eslint/no-base-to-string': 'warn',
 
     // Disallow duplicate class members
-    '@typescript-eslint/no-dupe-class-members': base.rules['no-dupe-class-members'],
+    '@typescript-eslint/no-dupe-class-members': base[0].rules['no-dupe-class-members'],
     'no-dupe-class-members': 'off',
 
     // Disallow duplicate enum member values
@@ -153,7 +153,7 @@ const config = {
     '@typescript-eslint/no-for-in-array': 'error',
 
     // Disallow the use of `eval()`-like methods
-    '@typescript-eslint/no-implied-eval': base.rules['no-implied-eval'],
+    '@typescript-eslint/no-implied-eval': base[0].rules['no-implied-eval'],
     'no-implied-eval': 'off',
 
     // Disallows explicit type declarations for builtin primitive values
@@ -169,7 +169,7 @@ const config = {
     '@typescript-eslint/no-invalid-void-type': 'warn',
 
     // Disallow function declarations that contain unsafe references inside loop statements
-    '@typescript-eslint/no-loop-func': base.rules['no-loop-func'],
+    '@typescript-eslint/no-loop-func': base[0].rules['no-loop-func'],
     'no-loop-func': 'off',
 
     // Enforce valid definition of new and constructor
@@ -233,7 +233,7 @@ const config = {
 
     // Disallow Shadowing
     // This rule aims to eliminate shadowed variable declarations.
-    '@typescript-eslint/no-shadow': base.rules['no-shadow'],
+    '@typescript-eslint/no-shadow': base[0].rules['no-shadow'],
     'no-shadow': 'off',
 
     // Disallow aliasing this
@@ -248,7 +248,7 @@ const config = {
     // the `Error` object as base objects for user-defined exceptions. The fundamental benefit of
     // `Error` objects is that they automatically keep track of where they were built and
     // originated.
-    '@typescript-eslint/only-throw-error': [base.rules['no-throw-literal'], {
+    '@typescript-eslint/only-throw-error': [base[0].rules['no-throw-literal'], {
       allowThrowingAny: false,
       allowThrowingUnknown: false,
     }],
@@ -299,13 +299,13 @@ const config = {
     // Disallow Unused Expressions
     // This rule aims to eliminate unused expressions which have no effect on the state of the
     // program.
-    '@typescript-eslint/no-unused-expressions': base.rules['no-unused-expressions'],
+    '@typescript-eslint/no-unused-expressions': base[0].rules['no-unused-expressions'],
     'no-unused-expressions': 'off',
 
     // Variables that are declared and not used anywhere in the code are most likely an error due
     // to incomplete refactoring. Such variables take up space in the code and can lead to
     // confusion by readers.
-    '@typescript-eslint/no-unused-vars': base.rules['no-unused-vars'],
+    '@typescript-eslint/no-unused-vars': base[0].rules['no-unused-vars'],
     'no-unused-vars': 'off',
 
     // Disallow the use of variables before they are defined
@@ -321,7 +321,7 @@ const config = {
     // Disallow unnecessary constructors
     // This rule flags class constructors that can be safely removed without changing how the class
     // works.
-    '@typescript-eslint/no-useless-constructor': base.rules['no-useless-constructor'],
+    '@typescript-eslint/no-useless-constructor': base[0].rules['no-useless-constructor'],
     'no-useless-constructor': 'off',
 
     // Disallow empty exports that don't change anything in a module file
@@ -375,7 +375,7 @@ const config = {
     '@typescript-eslint/require-array-sort-compare': 'error',
 
     // Disallow async functions which have no await expression
-    '@typescript-eslint/require-await': base.rules['require-await'],
+    '@typescript-eslint/require-await': base[0].rules['require-await'],
     'require-await': 'off',
 
     // When adding two variables, operands must both be of type number or of type string
@@ -427,6 +427,4 @@ const config = {
     // applications it's too much.
     '@typescript-eslint/explicit-function-return-type': ['off', {}],
   },
-}
-
-export default config
+})