eslint-config-seek 0.0.0-rulesdir-20230605003131 → 0.0.0-try-fix-20240925053654

package/README.md

@@ -5,35 +5,31 @@
 
 This package includes the shareable ESLint configuration used by [SEEK](https://github.com/seek-oss/).
 
-## Usage in sku Projects
+## Usage in sku and skuba Projects
 
-The easiest way to use this configuration is with [sku](https://github.com/seek-oss/sku), which includes it by default.
+The easiest way to use this configuration is with [sku](https://github.com/seek-oss/sku) or [skuba](https://github.com/seek-oss/skuba).
 
-**You don’t need to install it separately in sku projects.**
+**You don’t need to install it separately in sku and skuba projects.**
 
-## Usage Outside of sku
+## Usage Outside of sku and skuba
 
-If you want to use this ESLint configuration in a project not built with sku, you can install it with following steps.
+If you want to use this ESLint configuration in a project not built with sku or skuba, you can install it with following steps.
 
-First, install this package, ESLint and the necessary plugins listed in this project's [package.json](package.json).
+First, install this package, and the necessary peer dependencies listed in this project's [package.json](package.json).
 
-Then create a file named `.eslintrc` with following contents in the root folder of your project:
+Then create a file named `eslint.config.js` with the following contents in the root folder of your project:
 
-```json
-{
-  "extends": "seek"
-}
+```js
+module.exports = require('eslint-config-seek');
 ```
 
 The default configuration includes support for React projects. For projects that are not based on React, the "base" configuration should be used instead:
 
-```json
-{
-  "extends": "seek/base"
-}
+```js
+module.exports = require('eslint-config-seek/base');
 ```
 
-You can override the settings from `eslint-config-seek` by editing the `.eslintrc` file. Learn more about [configuring ESLint](http://eslint.org/docs/user-guide/configuring) on the ESLint website.
+You can override the settings from `eslint-config-seek` by editing the `eslint.config.js` file. Learn more about [configuring ESLint](https://eslint.org/docs/latest/use/configure/) on the ESLint website.
 
 ## License
 

package/base.js

@@ -1,12 +1,13 @@
-const path = require('path');
-const root = require('find-root')(process.cwd());
+const importX = require('eslint-plugin-import-x');
+const globals = require('globals');
+const jestPlugin = require('eslint-plugin-jest');
+const cypress = require('eslint-plugin-cypress');
+const eslintConfigPrettier = require('eslint-config-prettier');
+const tseslint = require('typescript-eslint');
 
 const OFF = 0;
 const ERROR = 2;
 
-const rulesDirPlugin = require('eslint-plugin-rulesdir');
-rulesDirPlugin.RULES_DIR = path.resolve('rules', path.dirname(__filename));
-
 const baseRules = {
   // Possible Errors
   'no-console': ERROR,
@@ -24,6 +25,7 @@ const baseRules = {
   'no-eval': ERROR,
   'no-extend-native': ERROR,
   'no-extra-bind': ERROR,
+  'no-fallthrough': ERROR,
   'no-floating-decimal': ERROR,
   'no-implicit-coercion': ERROR,
   'no-implied-eval': ERROR,
@@ -82,150 +84,160 @@ const baseRules = {
 const { js: jsExtensions, ts: tsExtensions } = require('./extensions');
 const allExtensions = [...jsExtensions, ...tsExtensions];
 
-/** @type {import('eslint').Linter.Config} */
-const baseConfig = {
-  parser: '@babel/eslint-parser',
-  parserOptions: {
-    requireConfigFile: false,
-    sourceType: 'module',
-  },
-  root: true,
-  env: {
+const settings = {
+  'import-x/resolver': {
+    typescript: true,
     node: true,
   },
-  plugins: ['import'],
-  extends: [
-    // this config enables eslint-plugin-import to resolve JavaScript and TypeScript files
-    // https://github.com/import-js/eslint-plugin-import/blob/v2.26.0/config/typescript.js
-    // Some rules provided by eslint-plugin-import e.g. `import/no-duplicates` don't work without it
-    'plugin:import/typescript',
-    'prettier',
-  ],
-  rules: {
-    ...baseRules,
+};
+
+module.exports = [
+  eslintConfigPrettier,
+  {
+    plugins: {
+      'import-x': importX,
+      jest: jestPlugin,
+      cypress,
+      '@typescript-eslint': tseslint.plugin,
+    },
   },
-  overrides: [
-    {
-      // TypeScript config
-      files: [`**/*.{${tsExtensions}}`],
-      parser: '@typescript-eslint/parser',
+  importX.flatConfigs.typescript,
+  {
+    rules: importX.flatConfigs.errors.rules,
+    files: [`**/*.{${jsExtensions}}`],
+  },
+  {
+    rules: importX.flatConfigs.warnings.rules,
+    files: [`**/*.{${jsExtensions}}`],
+  },
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+
       parserOptions: {
-        ecmaVersion: 2018,
+        requireConfigFile: false,
+        ecmaVersion: 'latest',
         sourceType: 'module',
-        project: true,
-      },
-      extends: [
-        'plugin:@typescript-eslint/eslint-recommended',
-        'plugin:@typescript-eslint/recommended',
-        'prettier',
-      ],
-      settings: {
-        // adds comprehensive TypeScript support to eslint-plugin-import
-        // https://github.com/import-js/eslint-import-resolver-typescript
-        'import/resolver': {
-          typescript: {},
-        },
       },
-      rules: {
-        '@typescript-eslint/no-unused-expressions': ERROR,
-        '@typescript-eslint/no-unused-vars': [
-          ERROR,
-          { argsIgnorePattern: '^_', ignoreRestSiblings: true },
-        ],
-        '@typescript-eslint/no-use-before-define': OFF,
-        '@typescript-eslint/no-non-null-assertion': OFF,
-        '@typescript-eslint/ban-ts-comment': OFF,
-        '@typescript-eslint/no-explicit-any': OFF,
-        '@typescript-eslint/explicit-function-return-type': OFF,
-        '@typescript-eslint/no-empty-function': OFF,
-        '@typescript-eslint/no-empty-interface': OFF,
-        '@typescript-eslint/no-inferrable-types': [
-          ERROR,
-          { ignoreParameters: true },
-        ],
-        // prefer TypeScript exhaustiveness checking
-        // https://www.typescriptlang.org/docs/handbook/advanced-types.html#exhaustiveness-checking
-        'default-case': OFF,
-        'arrow-body-style': [ERROR, 'as-needed'],
-        // Use `typescript-eslint`'s no-shadow to avoid false positives with enums
-        // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-shadow.md
-        'no-shadow': OFF,
-        '@typescript-eslint/no-shadow': ERROR,
+    },
+    settings,
+    rules: baseRules,
+  },
+  ...[...tseslint.configs.recommended, ...tseslint.configs.stylistic].map(
+    (config) => ({
+      ...config,
+      plugins: undefined,
+      files: [`**/*.{${tsExtensions}}`],
+    }),
+  ),
+  {
+    files: [`**/*.{${tsExtensions}}`],
 
-        // These two rules deal with autofixing type imports/exports
-        // https://typescript-eslint.io/rules/consistent-type-imports
-        '@typescript-eslint/consistent-type-imports': [
-          ERROR,
-          { fixStyle: 'inline-type-imports' },
-        ],
-        // https://typescript-eslint.io/rules/consistent-type-exports
-        '@typescript-eslint/consistent-type-exports': [
-          ERROR,
-          { fixMixedExportsWithInlineTypeSpecifier: true },
-        ],
-        // https://typescript-eslint.io/rules/no-import-type-side-effects
-        '@typescript-eslint/no-import-type-side-effects': ERROR,
+    languageOptions: {
+      parser: tseslint.parser,
 
-        // This rule deals with merging multiple imports from the same module.
-        // In this case, we want type imports to be inlined when merging with the other imports.
-        // However, there is a pending PR which improves the behaviour of this rule https://github.com/import-js/eslint-plugin-import/pull/2716
-        // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-duplicates.md#inline-type-imports
-        'import/no-duplicates': [ERROR, { 'prefer-inline': true }],
+      parserOptions: {
+        projectService: true,
+        warnOnUnsupportedTypeScriptVersion: false,
       },
     },
-    {
-      // JavaScript config
-      files: [`**/*.{${jsExtensions}}`],
-      env: {
-        es6: true,
-      },
-      extends: ['plugin:import/errors', 'plugin:import/warnings'],
-      settings: {
-        'import/resolver': {
-          node: {
-            moduleDirectory: [root, path.join(root, 'node_modules')],
-          },
-        },
-      },
-      rules: {
-        'no-undef': ERROR,
-        'no-use-before-define': [ERROR, { functions: false }],
-        'no-unused-expressions': ERROR,
-        'import/no-unresolved': [
-          ERROR,
-          { commonjs: true, amd: true, ignore: ['.svg$', '^file?'] },
-        ],
-        'import/no-duplicates': ERROR,
-      },
+    settings,
+    rules: {
+      '@typescript-eslint/array-type': [ERROR, { default: 'array-simple' }],
+      '@typescript-eslint/consistent-type-definitions': OFF,
+      '@typescript-eslint/no-unused-expressions': ERROR,
+      '@typescript-eslint/no-unused-vars': [
+        ERROR,
+        { argsIgnorePattern: '^_', ignoreRestSiblings: true },
+      ],
+      '@typescript-eslint/no-use-before-define': OFF,
+      '@typescript-eslint/no-non-null-assertion': OFF,
+      '@typescript-eslint/ban-ts-comment': OFF,
+      '@typescript-eslint/no-explicit-any': OFF,
+      '@typescript-eslint/explicit-function-return-type': OFF,
+      '@typescript-eslint/no-empty-function': OFF,
+      '@typescript-eslint/no-empty-interface': OFF,
+      '@typescript-eslint/no-inferrable-types': [
+        ERROR,
+        { ignoreParameters: true },
+      ],
+      // prefer TypeScript exhaustiveness checking
+      // https://www.typescriptlang.org/docs/handbook/advanced-types.html#exhaustiveness-checking
+      'default-case': OFF,
+      'arrow-body-style': [ERROR, 'as-needed'],
+      // Use `typescript-eslint`'s no-shadow to avoid false positives with enums
+      // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-shadow.md
+      'no-shadow': OFF,
+      '@typescript-eslint/no-shadow': ERROR,
+
+      // These two rules deal with autofixing type imports/exports
+      // https://typescript-eslint.io/rules/consistent-type-imports
+      '@typescript-eslint/consistent-type-imports': [
+        ERROR,
+        { fixStyle: 'inline-type-imports' },
+      ],
+      // https://typescript-eslint.io/rules/consistent-type-exports
+      '@typescript-eslint/consistent-type-exports': [
+        ERROR,
+        { fixMixedExportsWithInlineTypeSpecifier: true },
+      ],
+      // https://typescript-eslint.io/rules/no-import-type-side-effects
+      '@typescript-eslint/no-import-type-side-effects': ERROR,
+
+      // This rule deals with merging multiple imports from the same module.
+      // In this case, we want type imports to be inlined when merging with the other imports.
+      // However, there is a pending PR which improves the behaviour of this rule https://github.com/import-js/eslint-plugin-import/pull/2716
+      // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-duplicates.md#inline-type-imports
+      'import-x/no-duplicates': [ERROR, { 'prefer-inline': true }],
     },
-    {
-      // Jest config
-      files: [
-        `**/__tests__/**/*.{${allExtensions}}`,
-        `**/*.@(spec|test).{${allExtensions}}`,
+  },
+  {
+    files: [`**/*.{${jsExtensions}}`],
+    languageOptions: {
+      globals: {},
+    },
+    settings,
+    rules: {
+      'no-undef': ERROR,
+      'no-use-before-define': [ERROR, { functions: false }],
+      'no-unused-expressions': ERROR,
+      'import-x/no-unresolved': [
+        ERROR,
+        { commonjs: true, amd: true, ignore: ['.svg$', '^file?'] },
       ],
-      env: {
-        jest: true,
-      },
-      extends: ['plugin:jest/recommended'],
-      plugins: ['jest'],
+      'import-x/no-duplicates': ERROR,
     },
-    {
-      // Cypress config
-      files: [`**/cypress/**/*.{${allExtensions}}`],
-      // eslint-plugin-cypress doesn't support ESLint v8.
-      // Use fork by `@finsit` until this is solved.
-      // https://github.com/cypress-io/eslint-plugin-cypress/issues/89
-      extends: ['plugin:@finsit/cypress/recommended'],
-      env: {
-        '@finsit/cypress/globals': true,
+  },
+  {
+    ...jestPlugin.configs['flat/recommended'],
+    files: [
+      `**/__tests__/**/*.{${allExtensions}}`,
+      `**/*.@(spec|test).{${allExtensions}}`,
+    ],
+  },
+  {
+    files: [
+      `**/__tests__/**/*.{${allExtensions}}`,
+      `**/*.@(spec|test).{${allExtensions}}`,
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.jest,
       },
-      plugins: ['@finsit/cypress', 'rulesdir'],
-      rules: {
-        'rulesdir/unsafe-to-chain-command': ERROR,
+    },
+  },
+  {
+    ...cypress.configs.recommended,
+    files: [`**/cypress/**/*.{${allExtensions}}`],
+  },
+  {
+    files: [`**/cypress/**/*.{${allExtensions}}`],
+    languageOptions: {
+      globals: {
+        ...cypress.environments.globals.globals,
       },
     },
-  ],
-};
-
-module.exports = baseConfig;
+  },
+];

package/index.js

@@ -1,3 +1,10 @@
+const react = require('eslint-plugin-react');
+const reactHooks = require('eslint-plugin-react-hooks');
+const base = require('./base');
+const { fixupPluginRules } = require('@eslint/compat');
+
+const globals = require('globals');
+
 const OFF = 0;
 const ERROR = 2;
 
@@ -10,28 +17,47 @@ const reactRules = {
   'react/no-children-prop': ERROR,
   'react/display-name': OFF,
   'react/prop-types': OFF,
+  'react/jsx-curly-brace-presence': [
+    ERROR,
+    { props: 'never', children: 'ignore', propElementValues: 'always' },
+  ],
 };
 
-/** @type {import('eslint').Linter.Config} */
-const eslintConfig = {
-  env: {
-    browser: true,
-  },
-  settings: {
-    react: {
-      version: 'detect',
+module.exports = [
+  react.configs.flat.recommended,
+  react.configs.flat['jsx-runtime'],
+  ...base,
+  {
+    plugins: {
+      react,
+      'react-hooks': fixupPluginRules(reactHooks),
     },
-  },
-  plugins: ['react', 'react-hooks'],
-  extends: ['plugin:react/recommended', './base.js'],
-  parserOptions: {
-    babelOptions: {
-      presets: [require.resolve('@babel/preset-react')],
+
+    languageOptions: {
+      globals: globals.browser,
     },
+
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+
+    rules: reactRules,
   },
-  rules: {
-    ...reactRules,
-  },
-};
+  {
+    files: ['**/*.tsx'],
 
-module.exports = eslintConfig;
+    rules: {
+      // temporary override until everybody removes the React import
+      '@typescript-eslint/no-unused-vars': [
+        ERROR,
+        {
+          argsIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+          varsIgnorePattern: '^React$',
+        },
+      ],
+    },
+  },
+];

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "eslint-config-seek",
-  "version": "0.0.0-rulesdir-20230605003131",
+  "version": "0.0.0-try-fix-20240925053654",
   "description": "ESLint configuration used by SEEK",
   "main": "index.js",
   "files": [
     "index.js",
     "base.js",
-    "extensions.js",
-    "rules/*"
+    "extensions.js"
   ],
   "repository": {
     "type": "git",
@@ -20,35 +19,33 @@
   },
   "homepage": "https://github.com/seek-oss/eslint-config-seek#readme",
   "dependencies": {
-    "@babel/core": "^7.21.0",
-    "@babel/eslint-parser": "^7.19.1",
-    "@babel/preset-react": "^7.18.6",
-    "@finsit/eslint-plugin-cypress": "^3.1.1",
-    "@typescript-eslint/eslint-plugin": "^5.53.0",
-    "@typescript-eslint/parser": "^5.53.0",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-import-resolver-typescript": "3.5.3",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-react": "^7.32.2",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-rulesdir": "^0.2.2",
-    "find-root": "^1.1.0"
+    "@eslint/compat": "^1.1.1",
+    "typescript-eslint": "^8.6.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-cypress": "^3.5.0",
+    "eslint-plugin-import-x": "^4.2.1",
+    "eslint-plugin-jest": "^28.8.0",
+    "eslint-plugin-react": "^7.35.0",
+    "eslint-plugin-react-hooks": "^4.6.2",
+    "globals": "^15.9.0"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.26.0",
-    "@changesets/get-github-info": "^0.5.2",
-    "eslint": "^8.34.0",
-    "prettier": "^2.8.4",
-    "typescript": "~4.9.5"
+    "@changesets/cli": "^2.27.7",
+    "@changesets/get-github-info": "^0.6.0",
+    "eslint": "^9.8.0",
+    "prettier": "^3.3.3",
+    "typescript": "~5.5.4"
   },
   "peerDependencies": {
-    "eslint": ">=6",
-    "typescript": ">=4.5"
+    "eslint": ">=9.9.1",
+    "typescript": ">=5.5.4"
+  },
+  "engines": {
+    "node": ">=18.18.0"
   },
-  "packageManager": "pnpm@8.5.1",
   "volta": {
-    "node": "16.19.1"
+    "node": "18.18.0"
   },
   "scripts": {
     "release": "changeset publish",

package/rules/unsafe-to-chain-command.js

@@ -1,88 +0,0 @@
-/** This rule is copied from the original `eslint-plugin-cypress` so we can use the fork (which
- * supports eslint 8) while having the same recommended rules as the upstream
- * https://github.com/foretagsplatsen/eslint-plugin-cypress
- * https://github.com/cypress-io/eslint-plugin-cypress/blob/c626ad543f65babf1def5caabd1bc9bb9900d2c7/lib/rules/unsafe-to-chain-command.js
- */
-// eslint-disable-next-line strict
-'use strict';
-
-module.exports = {
-  meta: {
-    docs: {
-      description: 'Actions should be in the end of chains, not in the middle',
-      category: 'Possible Errors',
-      recommended: true,
-      url: 'https://docs.cypress.io/guides/core-concepts/retry-ability#Actions-should-be-at-the-end-of-chains-not-the-middle',
-    },
-    schema: [],
-    messages: {
-      unexpected:
-        'It is unsafe to chain further commands that rely on the subject after this command. It is best to split the chain, chaining again from `cy.` in a next command line.',
-    },
-  },
-  create(context) {
-    return {
-      CallExpression(node) {
-        if (
-          isRootCypress(node) &&
-          isActionUnsafeToChain(node) &&
-          node.parent.type === 'MemberExpression'
-        ) {
-          context.report({ node, messageId: 'unexpected' });
-        }
-      },
-    };
-  },
-};
-
-function isRootCypress(node) {
-  while (node.type === 'CallExpression') {
-    if (node.callee.type !== 'MemberExpression') {
-      return false;
-    }
-
-    if (
-      node.callee.object.type === 'Identifier' &&
-      node.callee.object.name === 'cy'
-    ) {
-      return true;
-    }
-
-    // eslint-disable-next-line no-param-reassign
-    node = node.callee.object;
-  }
-
-  return false;
-}
-
-function isActionUnsafeToChain(node) {
-  // commands listed in the documentation with text: 'It is unsafe to chain further commands that rely on the subject after xxx'
-  const unsafeToChainActions = [
-    'blur',
-    'clear',
-    'click',
-    'check',
-    'dblclick',
-    'each',
-    'focus',
-    'rightclick',
-    'screenshot',
-    'scrollIntoView',
-    'scrollTo',
-    'select',
-    'selectFile',
-    'spread',
-    'submit',
-    'type',
-    'trigger',
-    'uncheck',
-    'within',
-  ];
-
-  return (
-    node.callee &&
-    node.callee.property &&
-    node.callee.property.type === 'Identifier' &&
-    unsafeToChainActions.includes(node.callee.property.name)
-  );
-}