@qlik/eslint-config 1.2.3 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qlik/eslint-config",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "description": "Qlik's ESLint configs",
   "repository": "git@github.com:qlik-oss/dev-tools-js.git",
   "license": "ISC",
@@ -15,10 +15,10 @@
     "!**/__tests__"
   ],
   "dependencies": {
-    "@eslint-react/eslint-plugin": "^1.37.2",
+    "@eslint-react/eslint-plugin": "^1.38.0",
     "@eslint/js": "^9.23.0",
-    "@typescript-eslint/parser": "^8.27.0",
-    "@typescript-eslint/utils": "^8.27.0",
+    "@typescript-eslint/parser": "^8.28.0",
+    "@typescript-eslint/utils": "^8.28.0",
     "@vitest/eslint-plugin": "^1.1.38",
     "confusing-browser-globals": "^1.0.11",
     "eslint-config-prettier": "^10.1.1",
@@ -33,14 +33,14 @@
     "eslint-plugin-testing-library": "^7.1.1",
     "globals": "^16.0.0",
     "svelte-eslint-parser": "^1.1.0",
-    "typescript-eslint": "^8.27.0"
+    "typescript-eslint": "^8.28.0"
   },
   "devDependencies": {
     "@types/confusing-browser-globals": "^1.0.3",
     "@types/eslint-config-prettier": "^6.11.3",
     "@types/eslint-plugin-jsx-a11y": "^6.10.0",
     "@types/eslint__js": "^9.14.0",
-    "@types/node": "^22.13.11",
+    "@types/node": "^22.13.13",
     "eslint": "^9.23.0",
     "prettier": "^3.5.3",
     "vitest": "^3.0.9",

package/src/configs/cjs.js

@@ -1,58 +1,63 @@
 // @ts-check
 import prettier from "eslint-config-prettier";
-import globals from "globals";
 import { mergeConfigs } from "../utils/config.js";
-import { recommendedJS, recommendedTS } from "./recommended.js";
-import nodeRules from "./rules/node.js";
-
-/**
- * @satisfies {import("../types/index.js").ESLintFlatConfig['rules']}
- */
-const cjsRules = {
-  ...nodeRules,
-  // modify rules for node commonjs here
-};
+import { baseCjsJS, baseCjsTS, baseEsmJS, baseEsmTS } from "./shared/node.js";
 
 /**
+ * CJS config for javascript in node
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
 const cjsJS = mergeConfigs(
   // base it on the recommended javascript config
-  recommendedJS,
+  baseCjsJS,
   // add qlik's recommended node commonjs config for javascript
   {
     name: "node-cjs-js",
     files: ["**/*.{js,cjs}"],
-    languageOptions: {
-      globals: globals.node,
-      sourceType: "commonjs",
-    },
-    rules: cjsRules,
   },
   prettier,
 );
 
 /**
+ * CJS config for typescript in node
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
 const cjsTS = mergeConfigs(
   // base it on the recommended typescript config
-  recommendedTS,
+  baseCjsTS,
   // add qlik's recommended node commonjs config for typescript
   {
     name: "node-cjs-ts",
     files: ["**/*.{ts,cts}"],
-    languageOptions: {
-      globals: globals.node,
-      sourceType: "commonjs",
-    },
-    rules: {
-      ...cjsRules,
-      // modify ts specific rules for node here
-    },
   },
   prettier,
 );
 
-export default [cjsJS, cjsTS];
+/**
+ * Adding esm config for .mjs files
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ */
+const cjsMJS = mergeConfigs(
+  baseEsmJS,
+  {
+    name: "node-cjs-mjs",
+    files: ["**/*.mjs"],
+  },
+  prettier,
+);
+
+/**
+ * Adding esm config for .mts files
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ */
+const cjsMTS = mergeConfigs(
+  baseEsmTS,
+  {
+    name: "node-cjs-mts",
+    files: ["**/*.mts"],
+  },
+  prettier,
+);
+
+export default [cjsJS, cjsTS, cjsMJS, cjsMTS];
 export { cjsJS, cjsTS };

package/src/configs/esbrowser.js

@@ -2,7 +2,8 @@
 import prettier from "eslint-config-prettier";
 import globals from "globals";
 import { mergeConfigs } from "../utils/config.js";
-import { recommendedJS, recommendedTS } from "./recommended.js";
+import { baseConfigJS, baseConfigTS } from "./shared/base.js";
+import { baseCjsJS, baseCjsTS } from "./shared/node.js";
 
 /**
  * @satisfies {import("../types/index.js").ESLintFlatConfig["rules"]}
@@ -24,11 +25,12 @@ const browserEsmRules = {
 };
 
 /**
+ * ESM config for javascript in browsers
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
 const esbrowserJS = mergeConfigs(
   // base it on the recommended javascript config
-  recommendedJS,
+  baseConfigJS,
   // add qlik's recommended node esm config for javascript
   {
     name: "esbrowser-js",
@@ -46,11 +48,12 @@ const esbrowserJS = mergeConfigs(
 );
 
 /**
+ * ESM config for typescript in browsers
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
 const esbrowserTS = mergeConfigs(
   // base it on the recommended typescript config
-  recommendedTS,
+  baseConfigTS,
   // add qlik's recommended node esm config for typescript
   {
     name: "esbrowser-ts",
@@ -67,5 +70,31 @@ const esbrowserTS = mergeConfigs(
   prettier,
 );
 
-export default [esbrowserJS, esbrowserTS];
+/**
+ * Adding commonjs config for .cjs files
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ */
+const esbrowserCJS = mergeConfigs(
+  baseCjsJS,
+  {
+    name: "browser-esm-cjs",
+    files: ["**/*.cjs"],
+  },
+  prettier,
+);
+
+/**
+ * Adding commonjs config for .cts files
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ */
+const esbrowserCTS = mergeConfigs(
+  baseCjsTS,
+  {
+    name: "browser-esm-cts",
+    files: ["**/*.cts"],
+  },
+  prettier,
+);
+
+export default [esbrowserJS, esbrowserTS, esbrowserCJS, esbrowserCTS];
 export { esbrowserJS, esbrowserTS };

package/src/configs/esm.js

@@ -2,8 +2,9 @@
 import prettier from "eslint-config-prettier";
 import globals from "globals";
 import { mergeConfigs } from "../utils/config.js";
-import { recommendedJS, recommendedTS } from "./recommended.js";
 import nodeRules from "./rules/node.js";
+import { baseConfigJS, baseConfigTS } from "./shared/base.js";
+import { baseCjsJS, baseCjsTS } from "./shared/node.js";
 
 /**
  * @satisfies {import("../types/index.js").ESLintFlatConfig["rules"]}
@@ -26,11 +27,12 @@ const nodeEsmRules = {
 };
 
 /**
+ * ESM config for javascript in node
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
 const esmJS = mergeConfigs(
   // base it on the recommended javascript config
-  recommendedJS,
+  baseConfigJS,
   // add qlik's recommended node esm config for javascript
   {
     name: "node-esm-js",
@@ -45,11 +47,12 @@ const esmJS = mergeConfigs(
 );
 
 /**
+ * ESM config for typescript in node
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
 const esmTS = mergeConfigs(
   // base it on the recommended typescript config
-  recommendedTS,
+  baseConfigTS,
   // add qlik's recommended node esm config for typescript
   {
     name: "node-esm-ts",
@@ -66,5 +69,31 @@ const esmTS = mergeConfigs(
   prettier,
 );
 
-export default [esmJS, esmTS];
+/**
+ * Adding commonjs config for .cjs files
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ */
+const esmCJS = mergeConfigs(
+  baseCjsJS,
+  {
+    name: "node-esm-cjs",
+    files: ["**/*.cjs"],
+  },
+  prettier,
+);
+
+/**
+ * Adding commonjs config for .cts files
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ */
+const esmCTS = mergeConfigs(
+  baseCjsTS,
+  {
+    name: "node-esm-cts",
+    files: ["**/*.cts"],
+  },
+  prettier,
+);
+
+export default [esmJS, esmTS, esmCJS, esmCTS];
 export { esmJS, esmTS };

package/src/configs/react.js

@@ -3,13 +3,13 @@ import react from "@eslint-react/eslint-plugin";
 import prettier from "eslint-config-prettier";
 import jsxA11y from "eslint-plugin-jsx-a11y";
 import eslintPluginReact from "eslint-plugin-react";
-// @ts-expect-error no types for this plugin yet
 import reactHooks from "eslint-plugin-react-hooks";
 import { mergeConfigs } from "../utils/config.js";
-import { recommendedJS, recommendedTS } from "./recommended.js";
 import reactA11yRules from "./rules/react-a11y.js";
 import reactHooksRules from "./rules/react-hooks.js";
 import reactRules from "./rules/react.js";
+import { baseConfigJS, baseConfigTS } from "./shared/base.js";
+import { baseCjsJS, baseCjsTS } from "./shared/node.js";
 
 /** @type {any} */
 const reactPlugin = eslintPluginReact;
@@ -62,7 +62,7 @@ const reactBaseConfig = mergeConfigs(
  */
 const reactJS = mergeConfigs(
   // base it on the recommended javascript config
-  recommendedJS,
+  baseConfigJS,
   // add the base react config
   reactBaseConfig,
   // add qlik's recommended react config for javascript
@@ -82,7 +82,7 @@ const reactJS = mergeConfigs(
  */
 const reactTS = mergeConfigs(
   // base it on the recommended typescript config
-  recommendedTS,
+  baseConfigTS,
   // add the base react config
   reactBaseConfig,
   // add qlik's recommended react config for typescript
@@ -100,5 +100,31 @@ const reactTS = mergeConfigs(
   prettier,
 );
 
-export default [reactJS, reactTS];
+/**
+ * Adding commonjs config for .cjs files
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ */
+const reactCJS = mergeConfigs(
+  baseCjsJS,
+  {
+    name: "react-cjs",
+    files: ["**/*.cjs"],
+  },
+  prettier,
+);
+
+/**
+ * Adding commonjs config for .cts files
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ */
+const reactCTS = mergeConfigs(
+  baseCjsTS,
+  {
+    name: "react-cts",
+    files: ["**/*.cts"],
+  },
+  prettier,
+);
+
+export default [reactJS, reactTS, reactCJS, reactCTS];
 export { reactJS, reactTS };

package/src/configs/recommended.js

@@ -1,48 +1,17 @@
 // @ts-check
-import js from "@eslint/js";
-import tsParser from "@typescript-eslint/parser";
 import prettier from "eslint-config-prettier";
-import eslintPluginImportX from "eslint-plugin-import-x";
-import globals from "globals";
-import tsconfig from "typescript-eslint";
 import { mergeConfigs } from "../utils/config.js";
-import eslintCoreRules from "./rules/eslint-core.js";
-import importXRules from "./rules/import-x.js";
-import typescriptRules from "./rules/typescript.js";
-
-const baseConfig = mergeConfigs(
-  // basic js config
-  js.configs.recommended,
-  // import-x plugin config
-  eslintPluginImportX.flatConfigs.recommended,
-  {
-    languageOptions: {
-      globals: globals.browser,
-      parserOptions: {
-        warnOnUnsupportedTypeScriptVersion: false,
-      },
-      ecmaVersion: "latest",
-      sourceType: "module",
-    },
-    rules: {
-      // add our recommended rules
-      ...eslintCoreRules,
-      ...importXRules,
-    },
-  },
-);
+import { baseConfigJS, baseConfigTS } from "./shared/base.js";
+import { baseCjsJS, baseCjsTS } from "./shared/node.js";
 
 /**
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
 const recommendedJS = mergeConfigs(
-  baseConfig,
-  // tsconfig.configs.base sets eslint parser to use the typescript parser to parse .js files - handles all modern syntax
-  tsconfig.configs.base,
-  // add qlik's recommended javascript config
+  baseConfigJS,
   {
     name: "recommended-js",
-    files: ["**/*.js", "**/*.mjs", "**/*.cjs"],
+    files: ["**/*.js", "**/*.mjs"],
   },
   prettier,
 );
@@ -51,26 +20,39 @@ const recommendedJS = mergeConfigs(
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
 const recommendedTS = mergeConfigs(
-  // base it on base config
-  baseConfig,
-  // add recommended typescript config
-  ...tsconfig.configs.recommended,
-  // add import-x recommended typescript config
-  eslintPluginImportX.flatConfigs.typescript,
-  // add qlik's recommended typescript config
+  baseConfigTS,
   {
     name: "recommended-ts",
-    files: ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts", "**/*.d.ts"],
-    languageOptions: {
-      parserOptions: {
-        parser: tsParser,
-        projectService: true,
-      },
-    },
-    rules: typescriptRules,
+    files: ["**/*.ts", "**/*.mts", "**/*.d.ts"],
+  },
+  prettier,
+);
+
+/**
+ * A .cjs file is a CommonJS file, which is a module format used in Node.js.
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ */
+const recommendedCJS = mergeConfigs(
+  baseCjsJS,
+  {
+    name: "recommended-cjs",
+    files: ["**/*.cjs"],
+  },
+  prettier,
+);
+
+/**
+ * A .cts file is a CommonJS file, which is a module format used in Node.js.
+ * @type {import("../types/index.js").ESLintFlatConfig}
+ */
+const recommendedCTS = mergeConfigs(
+  baseCjsTS,
+  {
+    name: "recommended-cts",
+    files: ["**/*.cts"],
   },
   prettier,
 );
 
-export default [recommendedJS, recommendedTS];
+export default [recommendedJS, recommendedTS, recommendedCJS, recommendedCTS];
 export { recommendedJS, recommendedTS };

package/src/configs/shared/base.js

@@ -0,0 +1,68 @@
+import js from "@eslint/js";
+import tsParser from "@typescript-eslint/parser";
+import eslintPluginImportX from "eslint-plugin-import-x";
+import globals from "globals";
+import tsconfig from "typescript-eslint";
+import { mergeConfigs } from "../../utils/config.js";
+import eslintCoreRules from "../rules/eslint-core.js";
+import importXRules from "../rules/import-x.js";
+import typescriptRules from "../rules/typescript.js";
+
+/**
+ * @type {import("../../types/index.js").ESLintFlatConfig}
+ */
+const baseConfig = mergeConfigs(
+  // basic js config
+  js.configs.recommended,
+  // import-x plugin config
+  eslintPluginImportX.flatConfigs.recommended,
+  {
+    languageOptions: {
+      globals: globals.browser,
+      parserOptions: {
+        warnOnUnsupportedTypeScriptVersion: false,
+      },
+      ecmaVersion: "latest",
+      sourceType: "module",
+    },
+    rules: {
+      // add our recommended rules
+      ...eslintCoreRules,
+      ...importXRules,
+    },
+  },
+);
+
+/**
+ * @type {import("../../types/index.js").ESLintFlatConfig}
+ */
+const baseConfigJS = mergeConfigs(
+  baseConfig,
+  // tsconfig.configs.base sets eslint parser to use the typescript parser to parse .js files - handles all modern syntax
+  tsconfig.configs.base,
+  // add qlik's recommended javascript config
+);
+
+/**
+ * @type {import("../../types/index.js").ESLintFlatConfig}
+ */
+const baseConfigTS = mergeConfigs(
+  // base it on base config
+  baseConfig,
+  // add recommended typescript config
+  ...tsconfig.configs.recommended,
+  // add import-x recommended typescript config
+  eslintPluginImportX.flatConfigs.typescript,
+  // add qlik's recommended typescript config
+  {
+    languageOptions: {
+      parserOptions: {
+        parser: tsParser,
+        projectService: true,
+      },
+    },
+    rules: typescriptRules,
+  },
+);
+
+export { baseConfigJS, baseConfigTS };

package/src/configs/shared/node.js

@@ -0,0 +1,109 @@
+// @ts-check
+import globals from "globals";
+import { mergeConfigs } from "../../utils/config.js";
+import nodeRules from "../rules/node.js";
+import { baseConfigJS, baseConfigTS } from "./base.js";
+
+/**
+ * @satisfies {import("../../types/index.js").ESLintFlatConfig['rules']}
+ */
+const cjsRules = {
+  ...nodeRules,
+  // modify rules for node commonjs here
+};
+
+/**
+ * CJS config for javascript in node
+ * @type {import("../../types/index.js").ESLintFlatConfig}
+ */
+const baseCjsJS = mergeConfigs(
+  // base it on the recommended javascript config
+  baseConfigJS,
+  // add qlik's recommended node commonjs config for javascript
+  {
+    languageOptions: {
+      globals: globals.node,
+      sourceType: "commonjs",
+    },
+    rules: cjsRules,
+  },
+);
+
+/**
+ * CJS config for typescript in node
+ * @type {import("../../types/index.js").ESLintFlatConfig}
+ */
+const baseCjsTS = mergeConfigs(
+  // base it on the recommended typescript config
+  baseConfigTS,
+  // add qlik's recommended node commonjs config for typescript
+  {
+    languageOptions: {
+      globals: globals.node,
+      sourceType: "commonjs",
+    },
+    rules: {
+      ...cjsRules,
+      // modify ts specific rules for node here
+    },
+  },
+);
+
+/**
+ * @satisfies {import("../../types/index.js").ESLintFlatConfig["rules"]}
+ */
+const nodeEsmRules = {
+  ...nodeRules,
+  // modify rules for node esm here
+
+  // Ensure consistent use of file extension within the import path
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/extensions.md
+  "import-x/extensions": [
+    "error",
+    "ignorePackages",
+    {
+      ts: "never",
+      mts: "never",
+      tsx: "never",
+    },
+  ],
+};
+
+/**
+ * ESM config for javascript in node
+ * @type {import("../../types/index.js").ESLintFlatConfig}
+ */
+const baseEsmJS = mergeConfigs(
+  // base it on the recommended javascript config
+  baseConfigJS,
+  // add qlik's recommended node esm config for javascript
+  {
+    languageOptions: {
+      globals: globals.node,
+      sourceType: "module",
+    },
+    rules: nodeEsmRules,
+  },
+);
+
+/**
+ * ESM config for typescript in node
+ * @type {import("../../types/index.js").ESLintFlatConfig}
+ */
+const baseEsmTS = mergeConfigs(
+  // base it on the recommended typescript config
+  baseConfigTS,
+  // add qlik's recommended node esm config for typescript
+  {
+    languageOptions: {
+      globals: globals.node,
+      sourceType: "module",
+    },
+    rules: {
+      ...nodeEsmRules,
+      // modify typescript specific rules for node esm here if needed
+    },
+  },
+);
+
+export { baseCjsJS, baseCjsTS, baseEsmJS, baseEsmTS };