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

package/src/configs/{rules → shared/default-rules}/import-x.js

@@ -1,7 +1,7 @@
 // @ts-check
 
 /**
- * @satisfies {import("../../types/index.js").ESLintFlatConfig["rules"]}
+ * @satisfies {import("../../../types/index.js").ESLintFlatConfig["rules"]}
  *
  * eslint-plugin-import-x package https://github.com/un-ts/eslint-plugin-import-x/blob/master/README.md
  */
@@ -12,22 +12,13 @@ const rules = {
   /* -------------------------------------------------------------------------- */
   // ensure imports point to files/modules that can be resolved
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-unresolved.md
-  "import-x/no-unresolved": ["error", { commonjs: true, caseSensitive: true }],
-  // ensure named imports coupled with named exports
-  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/named.md#when-not-to-use-it
-  "import-x/named": "error",
+  "import-x/no-unresolved": ["error", { commonjs: true }],
   /* -------------------------------------------------------------------------- */
   /*                              Helpful warnings:                             */
   /* -------------------------------------------------------------------------- */
-  // disallow invalid exports, e.g. multiple defaults
-  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/export.md
-  "import-x/export": "error",
   // do not allow a default import name to match a named export
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-named-as-default.md
   "import-x/no-named-as-default": "error",
-  // warn on accessing default export property names that are also named exports
-  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-named-as-default-member.md
-  "import-x/no-named-as-default-member": "off",
   // disallow use of jsdoc-marked-deprecated imports
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-deprecated.md
   "import-x/no-deprecated": "warn",
@@ -47,6 +38,7 @@ const rules = {
         "tests/**", // also common npm pattern
         "spec/**", // mocha, rspec-like pattern
         "**/__tests__/**", // jest pattern
+        "**/__test__/**", // jest pattern
         "**/__mocks__/**", // jest pattern
         "test.{js,jsx,ts,tsx}", // repos with a single test file
         "test-*.{js,jsx,ts,tsx}", // repos with multiple top-level test files
@@ -81,10 +73,6 @@ const rules = {
   // disallow AMD require/define
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-amd.md
   "import-x/no-amd": "error",
-  // No Node.js builtin modules
-  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-nodejs-modules.md
-  // TODO: enable?
-  "import-x/no-nodejs-modules": "off",
   /* -------------------------------------------------------------------------- */
   /*                                Style guide:                                */
   /* -------------------------------------------------------------------------- */
@@ -110,15 +98,12 @@ const rules = {
   // Require a newline after the last import-x/require in a group
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/newline-after-import.md
   "import-x/newline-after-import": "error",
-  // Require modules with a single export to use a default export
-  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/prefer-default-export.md
-  "import-x/prefer-default-export": "off",
   // Forbid import of modules using absolute paths
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-absolute-path.md
   "import-x/no-absolute-path": "error",
   // Forbid require() calls with expressions
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-dynamic-require.md
-  "import-x/no-dynamic-require": "error",
+  "import-x/no-dynamic-require": "warn",
   // Forbid Webpack loader syntax in imports
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-webpack-loader-syntax.md
   "import-x/no-webpack-loader-syntax": "error",
@@ -134,9 +119,6 @@ const rules = {
   // Ensures that there are no useless path segments
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-useless-path-segments.md
   "import-x/no-useless-path-segments": ["error", { commonjs: true }],
-  // Reports modules without any exports, or with unused exports
-  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-unused-modules.md
-  "import-x/no-unused-modules": "error",
   // Reports the use of import declarations with CommonJS exports in any module except for the main module.
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-import-module-exports.md
   "import-x/no-import-module-exports": [
@@ -146,16 +128,8 @@ const rules = {
     },
   ],
   // Use this rule to prevent importing packages through relative paths.
-  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-relative-packages-exports.md
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-relative-packages.md
   "import-x/no-relative-packages": "error",
-  // This seems conflicting with @typescript-eslint/no-import-type-side-effects
-  // enforce a consistent style for type specifiers (inline or top-level)
-  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/consistent-type-specifier-style.md
-  "import-x/consistent-type-specifier-style": "off",
-  // Makes importing runtime (`import type {} from ...`) types annoying
-  // Reports the use of empty named import blocks.
-  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-empty-named-blocks.md
-  "import-x/no-empty-named-blocks": "off",
 };
 
 export default rules;

package/src/configs/{rules → shared/default-rules}/node.js

@@ -1,7 +1,7 @@
 // @ts-check
 
 /**
- * @satisfies {import("../../types/index.js").ESLintFlatConfig["rules"]}
+ * @satisfies {import("../../../types/index.js").ESLintFlatConfig["rules"]}
  */
 const rules = {
   // TODO use eslint-plugin-n https://github.com/eslint-community/eslint-plugin-n

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

@@ -0,0 +1,22 @@
+// @ts-check
+
+/**
+ * This file contains rules related to react. It is meant to be extended by react specific configs,
+ * it is not meant to be used directly.
+ * We are using @eslint-react/eslint-plugin for react specific rules, but we are not extending their
+ * recommended config as it includes some rules that we do not want to enforce, and it does not include
+ * some rules that we do want to enforce. We are only using the rules that we find useful and relevant
+ * for our projects.
+ * For more information on the available rules and their options, please refer to the documentation of
+ * @eslint-react/eslint-plugin and @eslint-react/eslint-plugin-hooks:
+ * https://beta.eslint-react.xyz/docs/rules/overview
+ */
+
+/**
+ * @satisfies {import("../../../types/index.js").ESLintFlatConfig["rules"]}
+ */
+const rules = {
+  // Add or modify react specific rules here if needed - use https://beta.eslint-react.xyz/docs/rules/overview for reference
+};
+
+export default rules;

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

@@ -0,0 +1,45 @@
+// @ts-check
+import eslintCoreRules from "./eslint-core.js";
+
+/**
+ * @satisfies {import("../../../types/index.js").ESLintFlatConfig["rules"]}
+ *
+ * typesscript-eslint core recommended config https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslintrc/recommended-type-checked.ts
+ */
+const rules = {
+  // modify/add rules from typescript-eslint package here additionally to the recommended rules
+
+  // turn off core rules superseded by @typescript-eslint equivalents
+  // shadows from outer scopes are not allowed
+  // https://typescript-eslint.io/rules/no-shadow
+  "no-shadow": "off",
+  "@typescript-eslint/no-shadow": eslintCoreRules["no-shadow"],
+
+  // Replace camelcase' rule with '@typescript-eslint/naming-convention'
+  // https://typescript-eslint.io/rules/naming-convention/
+  camelcase: "off",
+  // The `@typescript-eslint/naming-convention` rule allows `leadingUnderscore` and `trailingUnderscore` settings. However, the existing `no-underscore-dangle` rule already takes care of this.
+  "@typescript-eslint/naming-convention": [
+    "error",
+    // Allow camelCase variables (23.2), PascalCase variables (23.8), and UPPER_CASE variables (23.10)
+    {
+      selector: "variable",
+      format: ["camelCase", "PascalCase", "UPPER_CASE"],
+    },
+    // Allow camelCase functions (23.2), and PascalCase functions (23.8)
+    {
+      selector: "function",
+      format: ["camelCase", "PascalCase"],
+    },
+    // Qlik recommends PascalCase for classes (23.3),
+    {
+      selector: "typeLike",
+      format: ["PascalCase"],
+    },
+  ],
+
+  // use tsconfig's noImplicitReturns option rather than this rule
+  "consistent-return": "off",
+};
+
+export default rules;

package/src/configs/shared/node.js

@@ -1,20 +1,35 @@
 // @ts-check
 import globals from "globals";
 import { mergeConfigs } from "../../utils/config.js";
-import nodeRules from "../rules/node.js";
 import { baseConfigJS, baseConfigTS } from "./base.js";
+import nodeRules from "./default-rules/node.js";
+
+// TODO use eslint-plugin-n https://github.com/eslint-community/eslint-plugin-n
 
 /**
- * @satisfies {import("../../types/index.js").ESLintFlatConfig['rules']}
+ * @satisfies {import("../../types/index.js").ESLintFlatConfig["rules"]}
  */
-const cjsRules = {
+const nodeEsmRules = {
   ...nodeRules,
-  // modify rules for node commonjs here
+  // 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",
+    },
+  ],
 };
 
 /**
  * CJS config for javascript in node
  * @type {import("../../types/index.js").ESLintFlatConfig}
+ * This config is meant to be extended by javascript specific configs, it is not meant to be used directly.
  */
 const baseCjsJS = mergeConfigs(
   // base it on the recommended javascript config
@@ -25,12 +40,16 @@ const baseCjsJS = mergeConfigs(
       globals: globals.node,
       sourceType: "commonjs",
     },
-    rules: cjsRules,
+    rules: {
+      ...nodeRules,
+      // modify javascript specific rules for node cjs here if needed
+    },
   },
 );
 
 /**
  * CJS config for typescript in node
+ * This config is meant to be extended by typescript specific configs, it is not meant to be used directly.
  * @type {import("../../types/index.js").ESLintFlatConfig}
  */
 const baseCjsTS = mergeConfigs(
@@ -43,32 +62,12 @@ const baseCjsTS = mergeConfigs(
       sourceType: "commonjs",
     },
     rules: {
-      ...cjsRules,
-      // modify ts specific rules for node here
+      ...nodeRules,
+      // modify typescript specific rules for node cjs here if needed
     },
   },
 );
 
-/**
- * @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}
@@ -82,7 +81,11 @@ const baseEsmJS = mergeConfigs(
       globals: globals.node,
       sourceType: "module",
     },
-    rules: nodeEsmRules,
+    rules: {
+      ...nodeRules,
+      ...nodeEsmRules,
+      // modify javascript specific rules for node esm here if needed
+    },
   },
 );
 
@@ -100,6 +103,7 @@ const baseEsmTS = mergeConfigs(
       sourceType: "module",
     },
     rules: {
+      ...nodeRules,
       ...nodeEsmRules,
       // modify typescript specific rules for node esm here if needed
     },

package/src/configs/vitest.js

@@ -5,7 +5,7 @@ import { mergeConfigs } from "../utils/config.js";
 
 /**
  * @type {import("../types/index.js").ESLintFlatConfig}
- * config for jest https://github.com/jest-community/eslint-plugin-jest
+ * config for vitest https://github.com/vitest/eslint-plugin-vitest
  */
 const vitest = mergeConfigs(
   // base it on the recommended vitest config
@@ -23,4 +23,3 @@ const vitest = mergeConfigs(
 );
 
 export default [vitest];
-export { vitest };

package/src/index.d.ts

@@ -1,40 +1,20 @@
 import cjs, { cjsJS, cjsTS } from "./configs/cjs.js";
 import esbrowser, { esbrowserJS, esbrowserTS } from "./configs/esbrowser.js";
 import esm, { esmJS, esmTS } from "./configs/esm.js";
-import jest from "./configs/jest.js";
-import playwright from "./configs/playwright.js";
 import react, { reactJS, reactTS } from "./configs/react.js";
 import recommended, { recommendedJS, recommendedTS } from "./configs/recommended.js";
-import svelte, { svelteJS } from "./configs/svelte.js";
 import vitest from "./configs/vitest.js";
-import compose from "./utils/compose.js";
 
 declare namespace qlikEslintConfig {
   export namespace configs {
     export { cjs };
     export { esbrowser };
     export { esm };
-    export { playwright };
-    export { jest };
     export { react };
     export { recommended };
-    export { svelte };
     export { vitest };
   }
-  export { compose };
 }
 
 export default qlikEslintConfig;
-export {
-  cjsJS,
-  cjsTS,
-  esbrowserJS,
-  esbrowserTS,
-  esmJS,
-  esmTS,
-  reactJS,
-  reactTS,
-  recommendedJS,
-  recommendedTS,
-  svelteJS,
-};
+export { cjsJS, cjsTS, esbrowserJS, esbrowserTS, esmJS, esmTS, reactJS, reactTS, recommendedJS, recommendedTS };

package/src/index.js

@@ -2,13 +2,9 @@
 import cjs, { cjsJS, cjsTS } from "./configs/cjs.js";
 import esbrowser, { esbrowserJS, esbrowserTS } from "./configs/esbrowser.js";
 import esm, { esmJS, esmTS } from "./configs/esm.js";
-import jest from "./configs/jest.js";
-import playwright from "./configs/playwright.js";
 import react, { reactJS, reactTS } from "./configs/react.js";
 import recommended, { recommendedJS, recommendedTS } from "./configs/recommended.js";
-import svelte, { svelteJS } from "./configs/svelte.js";
 import vitest from "./configs/vitest.js";
-import compose from "./utils/compose.js";
 
 /**
  * @satisfies {import("./types/index.js").QlikEslintConfig}
@@ -18,28 +14,12 @@ const qlikEslintConfig = {
     cjs,
     esbrowser,
     esm,
-    jest,
-    playwright,
     react,
     recommended,
-    svelte,
     vitest,
   },
-  compose,
 };
 
 export default qlikEslintConfig;
 
-export {
-  cjsJS,
-  cjsTS,
-  esbrowserJS,
-  esbrowserTS,
-  esmJS,
-  esmTS,
-  reactJS,
-  reactTS,
-  recommendedJS,
-  recommendedTS,
-  svelteJS,
-};
+export { cjsJS, cjsTS, esbrowserJS, esbrowserTS, esmJS, esmTS, reactJS, reactTS, recommendedJS, recommendedTS };

package/src/types/index.ts

@@ -1,52 +1,11 @@
-/* eslint-disable @typescript-eslint/no-empty-object-type */
-import { TSESLint } from "@typescript-eslint/utils";
+import type { Linter } from "eslint";
 
-interface ESLintFlatConfig extends TSESLint.FlatConfig.Config {}
-interface ESLintPlugin extends TSESLint.FlatConfig.Plugin {}
-interface ESLintLanguageOptions extends TSESLint.FlatConfig.LanguageOptions {}
-
-interface ESLintFlatConfigWithExtend extends ESLintFlatConfig {
-  /**
-   * Allows you to "extend" a set of configs similar to `extends` from the
-   * classic configs.
-   *
-   * This is just a convenience short-hand to help reduce duplication.
-   *
-   * ```js
-   * export default qlikEslint.compose({
-   *   files: ['** /*.ts'],
-   *   extend: [
-   *     ...qlikEslint.configs.ts,
-   *   ],
-   *   rules: {
-   *     '@typescript-eslint/array-type': 'error',
-   *     '@typescript-eslint/consistent-type-imports': 'error',
-   *   },
-   * })
-   *
-   * // expands to
-   *
-   * export default [
-   *   ...qlikEslint.configs.ts.map(conf => ({
-   *     ...conf,
-   *     files: ['** /*.ts'],
-   *   })),
-   *   {
-   *     files: ['** /*.ts'],
-   *     rules: {
-   *       '@typescript-eslint/array-type': 'error',
-   *       '@typescript-eslint/consistent-type-imports': 'error',
-   *     },
-   *   },
-   * ]
-   * ```
-   */
-  extend?: ESLintFlatConfig[];
-}
+type ESLintFlatConfig = Linter.Config;
+type ESLintPlugin = NonNullable<Linter.Config["plugins"]>[string];
+type ESLintLanguageOptions = NonNullable<Linter.Config["languageOptions"]>;
 
 type QlikEslintConfig = {
   configs: Record<string, ESLintFlatConfig[]>;
-  compose: (...configs: ESLintFlatConfigWithExtend[]) => ESLintFlatConfig[];
 };
 
-export type { ESLintFlatConfig, ESLintFlatConfigWithExtend, ESLintLanguageOptions, ESLintPlugin, QlikEslintConfig };
+export type { ESLintFlatConfig, ESLintLanguageOptions, ESLintPlugin, QlikEslintConfig };

package/src/utils/config.js

@@ -1,4 +1,3 @@
-import tsEslint from "typescript-eslint";
 import { merge } from "./merge.js";
 
 /**
@@ -18,5 +17,3 @@ export function mergeConfigs(...configs) {
   }
   return mergedConfig;
 }
-
-export const config = tsEslint.config;

package/src/utils/merge.js

@@ -3,10 +3,10 @@ const noNeedToDeepMerge = ["plugins", "rules", "parser"];
 const overWrite = ["files", "globals", "ignores"];
 
 /**
- *
+ * Deep merge two objects, with special handling for certain keys
  * @param {any} obj1
  * @param {any} obj2
- * @returns
+ * @returns {object}
  */
 export const merge = (obj1, obj2) => {
   // add error handling

package/src/configs/jest.js

@@ -1,27 +0,0 @@
-// @ts-check
-import jestPlugin from "eslint-plugin-jest";
-import testingLibraryPlugin from "eslint-plugin-testing-library";
-import { mergeConfigs } from "../utils/config.js";
-
-/**
- * @type {import("../types/index.js").ESLintFlatConfig}
- * config for jest https://github.com/jest-community/eslint-plugin-jest
- */
-const jest = mergeConfigs(
-  // base it on the recommended jest config
-  jestPlugin.configs["flat/recommended"],
-  // add testing-library plugin recommended config for react
-  testingLibraryPlugin.configs["flat/react"],
-  // add qlik's recommended jest config
-  {
-    name: "jest",
-    files: ["**/__test__/**/*.{js,jsx,ts,tsx}", "**/__tests__/**/*.{js,jsx,ts,tsx}"],
-    rules: {
-      // ...testingLibraryRules,
-      // modify rules from eslint-plugin-jest here
-    },
-  },
-);
-
-export default [jest];
-export { jest };

package/src/configs/playwright.js

@@ -1,24 +0,0 @@
-// @ts-check
-import playwrightEslint from "eslint-plugin-playwright";
-import { mergeConfigs } from "../utils/config.js";
-
-/**
- * @type {import("../types/index.js").ESLintFlatConfig}
- * config for Playwright https://github.com/playwright-community/eslint-plugin-playwright
- */
-const playwright = mergeConfigs(
-  // base it on the recommended config
-  playwrightEslint.configs["flat/recommended"],
-  // add qlik's recommended playwright config
-  {
-    name: "playwright",
-    files: ["tests/**", "test/**"],
-    rules: {
-      ...playwrightEslint.configs["flat/recommended"].rules,
-      // modify rules from eslint-plugin-playwright here
-    },
-  },
-);
-
-export default [playwright];
-export { playwright };