@qlik/eslint-config 2.0.0-next.1 → 2.0.1

package/README.md

@@ -253,13 +253,19 @@ 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:
 
@@ -288,8 +294,7 @@ export default qlik.compose(
 
 1. add `import { defineConfig } from "eslint/config";`
 2. replace `qlik.compose` with `defineConfig`
-3. remove the `...` from the imported configs
-4. replace `extend` with `extends` (if present)
+3. replace `extend` with `extends` (if present)
 
 new config:
 
@@ -315,4 +320,69 @@ export default defineConfig(
 );
 ```
 
+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.1",
+  "version": "2.0.1",
   "description": "Qlik's ESLint configs",
   "license": "ISC",
   "repository": "git@github.com:qlik-oss/dev-tools-js.git",
@@ -21,16 +21,16 @@
   "dependencies": {
     "@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/base.js

@@ -1,5 +1,6 @@
 import js from "@eslint/js";
-import { importX } from "eslint-plugin-import-x";
+import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";
+import { createNodeResolver, importX } from "eslint-plugin-import-x";
 import globals from "globals";
 import tsconfig from "typescript-eslint";
 import { mergeConfigs } from "../../utils/config.js";
@@ -70,6 +71,12 @@ const baseConfigTS = mergeConfigs(
         projectService: true,
       },
     },
+    settings: {
+      // Use import-x resolver-next for TypeScript and keep node resolution as fallback.
+      "import-x/resolver-next": [createTypeScriptImportResolver({ alwaysTryTypes: true }), createNodeResolver()],
+      // Disable legacy resolver config from the import-x TypeScript preset.
+      "import-x/resolver": false,
+    },
     rules: {
       ...typescriptRules,
       // add qlik's recommended typescript config for typescript here if needed

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];