@qlik/eslint-config 2.0.0-next.0 → 2.0.0

package/README.md

@@ -21,8 +21,8 @@ import qlik from "@qlik/eslint-config";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig(
-  qlik.configs.react,
-  qlik.configs.vitest,
+  ...qlik.configs.react,
+  ...qlik.configs.vitest,
   {
     rules: {
       // Override rules if needed
@@ -44,8 +44,8 @@ import pluginQuery from "@tanstack/eslint-plugin-query";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig([
-  qlik.configs.react,
-  qlik.configs.vitest,
+  ...qlik.configs.react,
+  ...qlik.configs.vitest,
   pluginQuery.configs["flat/recommended"],
   {
     ignores: ["dist", "script", "my-special-no-linting.ts"],
@@ -75,7 +75,7 @@ import qlik from "@qlik/eslint-config";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig(
-  qlik.configs.recommended, // adds linting on .js, .jsx, .mjs, .cjs, .ts, .tsx, .cts, .mts files. use for pure browser environment
+  ...qlik.configs.recommended, // adds linting on .js, .jsx, .mjs, .cjs, .ts, .tsx, .cts, .mts files. use for pure browser environment
   {
     ignores: ["dist"],
   },
@@ -90,7 +90,7 @@ import qlik from "@qlik/eslint-config";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig(
-  qlik.configs.react, // based on the recommended config and adds react linting on .jsx and .tsx files
+  ...qlik.configs.react, // based on the recommended config and adds react linting on .jsx and .tsx files
   {
     ignores: ["dist"],
   },
@@ -105,7 +105,7 @@ import qlik from "@qlik/eslint-config";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig(
-  qlik.configs.esbrowser, // based on the recommended config and adds specific es module rules (file endings)
+  ...qlik.configs.esbrowser, // based on the recommended config and adds specific es module rules (file endings)
   {
     ignores: ["dist"],
   },
@@ -120,7 +120,7 @@ import qlik from "@qlik/eslint-config";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig(
-  qlik.configs.esm, // or qlik.configs.cjs for commonjs, recommended config with node environment enabled
+  ...qlik.configs.esm, // or qlik.configs.cjs for commonjs, recommended config with node environment enabled
   {
     ignores: ["dist"],
   },
@@ -135,9 +135,9 @@ import qlik from "@qlik/eslint-config";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig(
-  qlik.configs.recommended,  // pure browser environment
-  qlik.configs.vitest,       // enable vitest linting on files inside __test(s)__ folder
-  qlik.configs.playwright,   // enable playwright linting on files inside ./test(s) folder.
+  ...qlik.configs.recommended,  // pure browser environment
+  ...qlik.configs.vitest,       // enable vitest linting on files inside __test(s)__ folder
+  ...qlik.configs.playwright,   // enable playwright linting on files inside ./test(s) folder.
   {
     ignores: ["dist"],
   },
@@ -152,8 +152,8 @@ import qlik from "@qlik/eslint-config";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig(
-  qlik.configs.recommended, // pure browser environment
-  qlik.configs.vitest,      // enable vitest linting on files inside __test(s)__ folder
+  ...qlik.configs.recommended, // pure browser environment
+  ...qlik.configs.vitest,      // enable vitest linting on files inside __test(s)__ folder
   {
     files: ["playwright/**/*.{js,jsx,ts,tsx}"], // will lint the files inside ./playwright folder with the playwright plugin
     extends: [...qlik.configs.playwright],
@@ -173,8 +173,8 @@ import qlik from "@qlik/eslint-config";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig(
-  qlik.configs.react,  // based on the recommended config and adds react linting on .jsx and .tsx files
-  qlik.configs.vitest, // enable vitest linting on files inside __test(s)__ folder
+  ...qlik.configs.react,  // based on the recommended config and adds react linting on .jsx and .tsx files
+  ...qlik.configs.vitest, // enable vitest linting on files inside __test(s)__ folder
   {
     ignores: ["dist"],
   },
@@ -203,10 +203,10 @@ with typescript support
 import { reactJS, reactTS } from "@qlik/eslint-config";
 import { defineConfig } from "eslint/config";
 
-export default defineConfig([
+export default defineConfig(
   reactJS,
   reactTS,
-])
+)
 ```
 
 This is equal to:
@@ -216,7 +216,7 @@ import qlik from "@qlik/eslint-config";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig(
-  qlik.configs.react,
+  ...qlik.configs.react,
 )
 ```
 
@@ -229,7 +229,7 @@ import { defineConfig } from "eslint/config";
 
 export default defineConfig(
   // apply recommended config to all files
-  qlik.configs.recommended,
+  ...qlik.configs.recommended,
   {
     // set node esm config on .mjs files inside the tools folder
     files: ["tools/**/*.mjs"],
@@ -253,20 +253,136 @@ The biggest changes between v1 and v2 is the plugins used. Since a lot of plugin
 - `eslint-plugin-playwright` - Removed
 - `eslint-plugin-svelte` - Removed
 - `eslint-plugin-react` - Replaced with [@eslint-react/eslint-plugin](https://github.com/Rel1cx/eslint-react)
-- `eslint-plugin-react-hooks` - Replacd with [@eslint-react/eslint-plugin](https://github.com/Rel1cx/eslint-react)
+- `eslint-plugin-react-hooks` - Replaced with [@eslint-react/eslint-plugin](https://github.com/Rel1cx/eslint-react)
 
 When migrating from v1 -> v2 do the following:
 
+Automatic:
+
+Use the prompt [supplied below](#ai-prompt) and give to a co-pilot agent.
+
+Manual:
+
 1. Remove the `qlik.compose` function and replace it with `defineConfig`
 2. If you were using any of the removed plugins (e.g. eslint-plugin-jest) you will have to add it to the eslint config.
-3. Some rules might have changed, been added or removed so you will likely get new errors/warnings that needs to be addressed
+3. This new config has a stricter set of rules applied, especially in the typescript files. Also, some rules might have been removed (removed plugins) or changed. So you might see new lint errors after migrating. But it's highlighting possible problems in the code so spend some time fixing the errors. Disabling rules should only be done when you have good reasons.
 
 Example of migration:
 
 old config:
 
 ```js
+// @ts-check
+import qlik from "@qlik/eslint-config";
+import pluginQuery from "@tanstack/eslint-plugin-query";
+
+export default qlik.compose(
+  ...qlik.configs.react,
+  ...qlik.configs.vitest,
+  pluginQuery.configs["flat/recommended"],
+  {
+    rules: {
+      // Override rules if needed
+    },
+  },
+  // In its own object so it's global
+  {
+    ignores: ["dist", "node_modules", "script"],
+  },
+);
+```
+
+1. add `import { defineConfig } from "eslint/config";`
+2. replace `qlik.compose` with `defineConfig`
+3. replace `extend` with `extends` (if present)
+
+new config:
+
+```js
+// @ts-check
+import qlik from "@qlik/eslint-config";
+import pluginQuery from "@tanstack/eslint-plugin-query";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig(
+  ...qlik.configs.react,
+  ...qlik.configs.vitest,
+  pluginQuery.configs["flat/recommended"],
+  {
+    rules: {
+      // Override rules if needed
+    },
+  },
+  // In its own object so it's global
+  {
+    ignores: ["dist", "node_modules", "script"],
+  },
+);
+```
+
+If you are using jest the `eslint-plugin-jest` has been removed, so you may want to add it to your config.
+Add `eslint-plugin-jest` to your npm dependencies and simply add a new section targeting your jest files with the plugin added.
+Look at the [plugin's documentation](https://www.npmjs.com/package/eslint-plugin-jest)
+
+Same things applies to `eslint-plugin-playwright`
+
+### AI Prompt
+
+Use this prompt for migrating:
+
+```text
+I want to migrate this project from ESLint v9 to ESLint v10 and update `@qlik/eslint-config` to v2 which supports ESLint v10.
+
+The changes in `@qlik/eslint-config` from v1 -> v2 are mainly changes of which plugins are used.
+
+- `eslint-plugin-jsx-a11y` - Removed
+- `eslint-plugin-jest` - Removed
+- `eslint-plugin-playwright` - Removed
+- `eslint-plugin-svelte` - Removed
+- `eslint-plugin-react` - Replaced with [@eslint-react/eslint-plugin](https://github.com/Rel1cx/eslint-react)
+- `eslint-plugin-react-hooks` - Replaced with [@eslint-react/eslint-plugin](https://github.com/Rel1cx/eslint-react)
+
+The default settings now also include stricter typescript rules.
+
+Follow these steps carefully and explain changes where non-trivial:
+
+1. Update dependencies:
+   - Set `eslint` to the latest version (v10)
+   - Set `@qlik/eslint-config` to the latest version (v2)
+
+2. Install dependencies and ensure there are no version conflicts.
+
+3. Remove or update any constraints that block ESLint or upgrades:
+   - `resolutions`, `overrides`, or pinned versions in `package.json`
+   - `.ncurc.json` rules preventing upgrades
+
+4. Migrate ESLint config to be compatible with ESLint 10:
+   - Ensure flat config format is used (`eslint.config.js/ts`)
+   - Import `defineConfig` from `"eslint/config"`
+   - Replace any usage of `qlik.compose` with `defineConfig` where applicable
+   - Replace any usage of `extend` with `extends`
+   - Ensure plugins and configs are compatible with ESLint 10
+
+5. Run `npx eslint . --fix`
+
+6. Handle remaining issues:
+   - Prefer code fixes over disabling rules
+   - Only disable rules if absolutely necessary
+   - For every disabled rule, add a comment explaining why
+
+7. Validation:
+   - ESLint runs without errors
+   - No critical rules are disabled silently
+   - The project builds and tests still pass
+
+8. Output:
+   - Summary of changes made
+   - List of rules disabled (if any) with justification
+   - Any potential risks or follow-ups
 
+Important:
+- Do not make changes that alter runtime behavior or business logic.
+- If uncertain, ask before making destructive or unclear changes.
 ```
 
 <!-- prettier-ignore-end -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qlik/eslint-config",
-  "version": "2.0.0-next.0",
+  "version": "2.0.0",
   "description": "Qlik's ESLint configs",
   "license": "ISC",
   "repository": "git@github.com:qlik-oss/dev-tools-js.git",
@@ -19,18 +19,18 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@eslint-react/eslint-plugin": "^4.2.1",
+    "@eslint-react/eslint-plugin": "^4.2.3",
     "@eslint/js": "^10.0.1",
-    "@typescript-eslint/utils": "^8.58.0",
-    "@vitest/eslint-plugin": "^1.6.14",
+    "@typescript-eslint/utils": "^8.58.2",
+    "@vitest/eslint-plugin": "^1.6.16",
     "confusing-browser-globals": "^1.0.11",
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-node": "^0.3.10",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import-x": "^4.16.2",
     "eslint-plugin-testing-library": "^7.16.2",
-    "globals": "^17.4.0",
-    "typescript-eslint": "^8.58.0"
+    "globals": "^17.5.0",
+    "typescript-eslint": "^8.58.2"
   },
   "devDependencies": {
     "@types/confusing-browser-globals": "^1.0.3",
@@ -44,6 +44,8 @@
   },
   "scripts": {
     "check-types": "tsc --noEmit",
+    "format:check": "oxfmt --check .",
+    "format:write": "oxfmt .",
     "test": "vitest run && ./test/verify-configs.sh"
   }
 }

package/src/configs/shared/default-rules/eslint-core.js

@@ -104,6 +104,10 @@ const rules = {
   // https://eslint.org/docs/rules/no-proto
   "no-proto": "error",
 
+  // disallow declaring the same variable more than once
+  // https://eslint.org/docs/rules/no-redeclare
+  "no-redeclare": "error",
+
   // disallow certain object properties
   // https://eslint.org/docs/rules/no-restricted-properties
   "no-restricted-properties": [
@@ -271,6 +275,16 @@ const rules = {
     },
   ],
 
+  // disallow specific imports
+  // https://eslint.org/docs/rules/no-restricted-imports
+  "no-restricted-imports": [
+    "off",
+    {
+      paths: [],
+      patterns: [],
+    },
+  ],
+
   // disallow useless computed property keys
   // https://eslint.org/docs/rules/no-useless-computed-key
   "no-useless-computed-key": "error",

package/src/configs/shared/default-rules/typescript.js

@@ -9,12 +9,151 @@ import eslintCoreRules from "./eslint-core.js";
 const rules = {
   // modify/add rules from typescript-eslint package here additionally to the recommended rules
 
+  // note some eslint core rules are disabled by tsconfig https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslint-recommended-raw.ts
   // turn off core rules superseded by @typescript-eslint equivalents
+
+  // enforce consistent type imports
+  // https://typescript-eslint.io/rules/consistent-type-imports
+  "@typescript-eslint/consistent-type-imports": "error",
+
+  // enforce default parameters to be last
+  // https://typescript-eslint.io/rules/default-param-last
+  "default-param-last": "off",
+  "@typescript-eslint/default-param-last": eslintCoreRules["default-param-last"],
+
+  // enforce method signatures has the same style
+  // https://typescript-eslint.io/rules/method-signature-style
+  "@typescript-eslint/method-signature-style": "error",
+
+  // don't use the delete operator on dynamic properties
+  // https://typescript-eslint.io/rules/no-dynamic-delete
+  "@typescript-eslint/no-dynamic-delete": "error",
+
+  // use top-level type imports
+  // https://typescript-eslint.io/rules/no-import-type-side-effects
+  "@typescript-eslint/no-import-type-side-effects": "error",
+
+  // don't use void where it shouldn't be used
+  // https://typescript-eslint.io/rules/no-invalid-void-type
+  "@typescript-eslint/no-invalid-void-type": "error",
+
+  // don't do weird things in loops
+  // https://typescript-eslint.io/rules/no-loop-func
+  "no-loop-func": "off",
+  "@typescript-eslint/no-loop-func": eslintCoreRules["no-loop-func"],
+
+  // disallow non-null assertions in the left operand of a nullish coalescing operator.
+  // https://typescript-eslint.io/rules/no-non-null-asserted-nullish-coalescing
+  "@typescript-eslint/no-non-null-asserted-nullish-coalescing": "error",
+
+  // https://typescript-eslint.io/rules/no-non-null-assertion
+  "@typescript-eslint/no-non-null-assertion": "error",
+
+  // don't allow redeclaration of variables
+  // https://typescript-eslint.io/rules/no-redeclare
+  "no-redeclare": "off",
+  "@typescript-eslint/no-redeclare": eslintCoreRules["no-redeclare"],
+
+  // add forbidden imports if needed
+  // https://typescript-eslint.io/rules/no-restricted-imports
+  "no-restricted-imports": "off",
+  "@typescript-eslint/no-restricted-imports": eslintCoreRules["no-restricted-imports"],
+
+  // add forbidden types if needed
+  // https://typescript-eslint.io/rules/no-restricted-types
+  "@typescript-eslint/no-restricted-types": ["error", {}],
+
   // shadows from outer scopes are not allowed
   // https://typescript-eslint.io/rules/no-shadow
   "no-shadow": "off",
   "@typescript-eslint/no-shadow": eslintCoreRules["no-shadow"],
 
+  // no unnecessary assignment of constructor property parameter.
+  // https://typescript-eslint.io/rules/no-unnecessary-parameter-property-assignment
+  "@typescript-eslint/no-unnecessary-parameter-property-assignment": "error",
+
+  // don't use stuff that hasn't been defined
+  // https://typescript-eslint.io/rules/no-useless-constructor
+  "no-useless-constructor": "off",
+  "@typescript-eslint/no-useless-constructor": eslintCoreRules["no-useless-constructor"],
+
+  // yes, please initialize your enums
+  // https://typescript-eslint.io/rules/prefer-enum-initializers
+  "@typescript-eslint/prefer-enum-initializers": "error",
+
+  // enums are not based on dynamic values
+  // https://typescript-eslint.io/rules/prefer-literal-enum-member
+  "@typescript-eslint/prefer-literal-enum-member": "error",
+
+  // disallow two overloads that could be unified into one with a union or an optional/rest parameter.
+  // https://typescript-eslint.io/rules/unified-signatures
+  "@typescript-eslint/unified-signatures": "error",
+
+  // enforce explicityly set type exports
+  // https://typescript-eslint.io/rules/consistent-type-exports
+  "@typescript-eslint/consistent-type-exports": "error",
+
+  // void should not be assigned to variables
+  // https://typescript-eslint.io/rules/no-confusing-void-expression
+  "@typescript-eslint/no-confusing-void-expression": "error",
+
+  // https://typescript-eslint.io/rules/no-floating-promises
+  "@typescript-eslint/no-floating-promises": [
+    "error",
+    {
+      ignoreIIFE: true,
+    },
+  ],
+
+  // remove void when it's not needed
+  // https://typescript-eslint.io/rules/no-meaningless-void-operator
+  "@typescript-eslint/no-meaningless-void-operator": "error",
+
+  // https://typescript-eslint.io/rules/no-misused-promises
+  "@typescript-eslint/no-misused-promises": [
+    "error",
+    {
+      checksConditionals: false,
+    },
+  ],
+
+  // use constistent enum types
+  // https://typescript-eslint.io/rules/no-mixed-enums
+  "@typescript-eslint/no-mixed-enums": "error",
+
+  // don't do silly comparisons
+  // https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare
+  "@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
+
+  // no unnecessary namespace qualifiers.
+  // https://typescript-eslint.io/rules/no-unnecessary-qualifier
+  "@typescript-eslint/no-unnecessary-qualifier": "error",
+
+  // Disallow conditionals where the type is always truthy or always falsy - https://typescript-eslint.io/rules/no-unnecessary-condition
+  "@typescript-eslint/no-unnecessary-condition": "error",
+
+  // no need for template literals if they just refer to a string
+  // https://typescript-eslint.io/rules/no-unnecessary-template-expression
+  "@typescript-eslint/no-unnecessary-template-expression": "error",
+
+  // don't use type arguments when they're not needed
+  // https://typescript-eslint.io/rules/no-unnecessary-type-arguments
+  "@typescript-eslint/no-unnecessary-type-arguments": "error",
+
+  // reducers should be typed correctly
+  // https://typescript-eslint.io/rules/prefer-reduce-type-parameter
+  "@typescript-eslint/prefer-reduce-type-parameter": "error",
+
+  // https://typescript-eslint.io/rules/prefer-return-this-type
+  "@typescript-eslint/prefer-return-this-type": "error",
+
+  // Require switch-case statements to be exhaustive - https://typescript-eslint.io/rules/switch-exhaustiveness-check
+  "@typescript-eslint/switch-exhaustiveness-check": "error",
+
+  // enforce typing arguments in Promise rejection callbacks as unknown
+  // https://typescript-eslint.io/rules/use-unknown-in-catch-callback-variable
+  "@typescript-eslint/use-unknown-in-catch-callback-variable": "error",
+
   // Replace camelcase' rule with '@typescript-eslint/naming-convention'
   // https://typescript-eslint.io/rules/naming-convention/
   camelcase: "off",

package/src/configs/vitest.js

@@ -7,19 +7,48 @@ import { mergeConfigs } from "../utils/config.js";
  * @type {import("../types/index.js").ESLintFlatConfig}
  * config for vitest https://github.com/vitest/eslint-plugin-vitest
  */
-const vitest = mergeConfigs(
+const vitestJS = mergeConfigs(
   // base it on the recommended vitest config
   vitestPlugin.configs.recommended,
   // add testing-library plugin recommended config for react
   testingLibraryPlugin.configs["flat/react"],
   // add qlik's recommended vitest config
   {
-    name: "vitest",
-    files: ["**/__test__/**/*.{js,jsx,ts,tsx}", "**/__tests__/**/*.{js,jsx,ts,tsx}"],
+    name: "vitest-js",
+    files: ["**/__test__/**/*.{js,jsx}", "**/__tests__/**/*.{js,jsx}", "mocks/**/*.js"],
     rules: {
-      // modify rules from eslint-plugin-vitest here
+      // turn off/modify rules that suitable for tests in JavaScript
     },
   },
 );
 
-export default [vitest];
+/**
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ * TypeScript-only vitest overrides
+ */
+const vitestTS = mergeConfigs(
+  // base it on the recommended vitest config
+  vitestPlugin.configs.recommended,
+  // add testing-library plugin recommended config for react
+  testingLibraryPlugin.configs["flat/react"],
+  // add qlik's recommended vitest config
+  {
+    name: "vitest-ts",
+    files: ["**/__test__/**/*.{ts,tsx}", "**/__tests__/**/*.{ts,tsx}", "mocks/**/*.ts"],
+    rules: {
+      // turn off/modify rules that suitable for tests in TypeScript
+
+      // turn off all the rules that are too strict for tests, and warn on any explicit any types
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "@typescript-eslint/no-unsafe-return": "off",
+      "@typescript-eslint/unbound-method": "off",
+      "@typescript-eslint/no-non-null-assertion": "off",
+      "@typescript-eslint/no-explicit-any": "warn",
+    },
+  },
+);
+
+export default [vitestJS, vitestTS];