Upgrade ESLint, rework config (#2577)

Author: davidjgoss

.eslintrc.yml

@@ -23,18 +23,16 @@ ignoreErrors:
   unused:
     - '@cucumber/compatibility-kit' # files dynamically loaded in cck test, not required
     - '@cucumber/junit-xml-formatter' # formatter dynamically imported at runtime
+    - '@eslint/compat' # used by eslint
+    - '@eslint/eslintrc' # used by eslint
+    - '@eslint/js' # used by eslint
     - '@typescript-eslint/eslint-plugin' # peer dependency of standard-with-typescript
     - '@typescript-eslint/parser' # peer dependency of @typescript-eslint/eslint-plugin
     - '@types/*' # type definitions
     - bluebird # features/generator_step_definitions.feature
     - coffeescript # features/compiler.feature
-    - eslint-config-prettier # .eslintrc.yml - extends - prettier
-    - eslint-config-standard-with-typescript # .eslintrc.yml - extends - standard-with-typescript
     - eslint-plugin-import # peer dependency of eslint-config-standard-with-typescript
     - eslint-plugin-n # peer dependency of eslint-config-standard-with-typescript
-    - eslint-plugin-prettier # .eslintrc.yml - extends - prettier
-    - eslint-plugin-promise # peer dependency of eslint-config-standard-with-typescript
-    - eslint-plugin-standard # peer dependency of eslint-config-standard-with-typescript
     - eslint-plugin-unicorn # used in eslint config
     - prettier # peer dependency of eslint-plugin-prettier
     - ts-node # .mocharc.yml / cucumber.js

dependency-lint.yml

@@ -0,0 +1,69 @@
+import { fileURLToPath } from 'node:url'
+import path from 'node:path'
+import { defineConfig, globalIgnores } from 'eslint/config'
+import { fixupConfigRules, fixupPluginRules } from '@eslint/compat'
+import _import from 'eslint-plugin-import'
+import n from 'eslint-plugin-n'
+import unicorn from 'eslint-plugin-unicorn'
+import typescriptEslint from '@typescript-eslint/eslint-plugin'
+import tsParser from '@typescript-eslint/parser'
+import js from '@eslint/js'
+import { FlatCompat } from '@eslint/eslintrc'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+})
+
+export default defineConfig([
+  globalIgnores(['**/tmp']),
+  {
+    extends: fixupConfigRules(
+      compat.extends(
+        'eslint:recommended',
+        'plugin:import/typescript',
+        'plugin:@typescript-eslint/eslint-recommended',
+        'plugin:@typescript-eslint/recommended'
+      )
+    ),
+
+    plugins: {
+      import: fixupPluginRules(_import),
+      n,
+      unicorn,
+      '@typescript-eslint': fixupPluginRules(typescriptEslint),
+    },
+
+    languageOptions: {
+      parser: tsParser,
+      ecmaVersion: 5,
+      sourceType: 'script',
+
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+
+    rules: {
+      'no-console': 'error',
+      'import/order': 'error',
+      'unicorn/prefer-node-protocol': 'error',
+      '@typescript-eslint/strict-boolean-expressions': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-inferrable-types': 'off',
+      '@typescript-eslint/no-unsafe-function-type': 'off',
+      '@typescript-eslint/no-unused-expressions': 'off',
+      '@typescript-eslint/ban-types': 'off',
+
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+        },
+      ],
+    },
+  },
+])

eslint.config.mjs

@@ -76,7 +76,7 @@ When(
   }
 )
 
-Then('it passes', () => {}) // eslint-disable-line @typescript-eslint/no-empty-function
+Then('it passes', () => {})
 
 Then('it fails', function (this: World) {
   const actualCode: number = doesHaveValue(this.lastRun.error)

features/step_definitions/cli_steps.ts

@@ -20,7 +20,7 @@ Then(
     actual = normalizeMessageOutput(actual, this.tmpDir)
     actual = stripMetaMessages(actual)
     const fixturePath = path.join(__dirname, '..', 'fixtures', filePath)
-    const expected = require(fixturePath) // eslint-disable-line @typescript-eslint/no-var-requires
+    const expected = require(fixturePath) // eslint-disable-line @typescript-eslint/no-require-imports
     try {
       expect(actual).excludingEvery(ignorableKeys).to.deep.eq(expected)
     } catch (e) {
@@ -44,7 +44,7 @@ Then(
     const actualJson = await fs.readFile(actualPath, 'utf8')
     const actual = normalizeJsonOutput(actualJson, this.tmpDir)
     const fixturePath = path.join(__dirname, '..', 'fixtures', filePath)
-    const expected = require(fixturePath) // eslint-disable-line @typescript-eslint/no-var-requires
+    const expected = require(fixturePath) // eslint-disable-line @typescript-eslint/no-require-imports
     try {
       expect(actual).to.eql(expected)
     } catch (e) {
@@ -55,7 +55,6 @@ Then(
           'utf-8'
         )
       } else {
-        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         e.message = `${e.message}\n\nTry running again with GOLDEN=1 if you believe the fixtures need to be overwritten with actual results`
         throw e
       }