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

package/src/configs/react.js

@@ -1,48 +1,9 @@
 // @ts-check
+import eslintReact from "@eslint-react/eslint-plugin";
 import prettier from "eslint-config-prettier";
-import jsxA11y from "eslint-plugin-jsx-a11y";
-import eslintPluginReact from "eslint-plugin-react";
-import reactHooks from "eslint-plugin-react-hooks";
 import { mergeConfigs } from "../utils/config.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 {import("../types/index.js").ESLintFlatConfig}
- */
-const reactBaseConfig = mergeConfigs(
-  // base it on the recommended react plugins config
-  eslintPluginReact.configs.flat.recommended,
-  jsxA11y.flatConfigs.recommended,
-  reactHooks.configs.flat["recommended-latest"],
-
-  // add qlik's recommended react config
-  {
-    languageOptions: {
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true,
-        },
-        jsxPragma: null, // for @typescript/eslint-parser
-      },
-    },
-
-    settings: {
-      react: {
-        version: "detect",
-      },
-    },
-
-    rules: {
-      ...reactRules,
-      ...reactA11yRules,
-      ...reactHooksRules,
-    },
-  },
-);
+import reactRules from "./shared/default-rules/react.js";
 
 /**
  * @type {import("../types/index.js").ESLintFlatConfig}
@@ -50,15 +11,15 @@ const reactBaseConfig = mergeConfigs(
 const reactJS = mergeConfigs(
   // base it on the recommended javascript config
   baseConfigJS,
-  // add the base react config
-  reactBaseConfig,
+  // add the react config
+  eslintReact.configs.strict,
   // add qlik's recommended react config for javascript
   {
     name: "react-js",
     files: ["**/*.js", "**/*.jsx"],
     rules: {
       // turn on/off or modify js rules necessary for react
-      "react/jsx-filename-extension": [2, { extensions: [".js", ".jsx"] }],
+      ...reactRules,
     },
   },
   prettier,
@@ -70,48 +31,19 @@ const reactJS = mergeConfigs(
 const reactTS = mergeConfigs(
   // base it on the recommended typescript config
   baseConfigTS,
-  // add the base react config
-  reactBaseConfig,
+  // add the react config
+  eslintReact.configs["strict-typescript"],
   // add qlik's recommended react config for typescript
   {
     name: "react-ts",
     files: ["**/*.ts", "**/*.tsx"],
     rules: {
       // turn on/off or modify js/ts rules necessary for react
-      "react/jsx-filename-extension": [2, { extensions: [".js", ".jsx", ".ts", ".tsx"] }],
-      // avoid double linting of class-methods-use-this in typescript
-      "class-methods-use-this": "off",
-      "@typescript-eslint/class-methods-use-this": reactBaseConfig.rules?.["class-methods-use-this"] || "off",
+      ...reactRules,
     },
   },
   prettier,
 );
 
-/**
- * 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 default [reactJS, reactTS];
 export { reactJS, reactTS };

package/src/configs/shared/base.js

@@ -1,21 +1,25 @@
 import js from "@eslint/js";
-import tsParser from "@typescript-eslint/parser";
-import eslintPluginImportX from "eslint-plugin-import-x";
+import { importX } 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";
+import eslintCoreRules from "./default-rules/eslint-core.js";
+import typescriptRules from "./default-rules/typescript.js";
+import importXRules from "./default-rules/import-x.js";
 
 /**
+ * This is the base config that all other configs in this package extend from.
+ * It includes the recommended eslint rules and some basic settings for parsing
+ * modern javascript and typescript, as well as some of qlik's custom rules that
+ * are not specific to any framework or environment. This config is meant to be
+ * extended by other configs and not used directly.
  * @type {import("../../types/index.js").ESLintFlatConfig}
  */
 const baseConfig = mergeConfigs(
   // basic js config
   js.configs.recommended,
-  // import-x plugin config
-  eslintPluginImportX.flatConfigs.recommended,
+  // import-x recommended config
+  importX.flatConfigs.recommended,
   {
     languageOptions: {
       globals: globals.browser,
@@ -26,7 +30,7 @@ const baseConfig = mergeConfigs(
       sourceType: "module",
     },
     rules: {
-      // add our recommended rules
+      // add or modify recommended default rules
       ...eslintCoreRules,
       ...importXRules,
     },
@@ -34,6 +38,11 @@ const baseConfig = mergeConfigs(
 );
 
 /**
+ * This config is meant to be extended by javascript specific configs, it is not meant to be used directly.
+ * Note that we are using the typescript parser to parse javascript files as well,
+ * this is because it can handle all modern javascript syntax and features, and it
+ * allows us to have a single parser for both javascript and typescript configs.
+ * We can turn off typescript specific rules in the javascript configs if needed.
  * @type {import("../../types/index.js").ESLintFlatConfig}
  */
 const baseConfigJS = mergeConfigs(
@@ -44,24 +53,27 @@ const baseConfigJS = mergeConfigs(
 );
 
 /**
+ * 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 baseConfigTS = mergeConfigs(
   // base it on base config
   baseConfig,
+  // typescript settings for import-x
+  importX.flatConfigs.typescript,
   // add recommended typescript config
-  ...tsconfig.configs.recommended,
-  // add import-x recommended typescript config
-  eslintPluginImportX.flatConfigs.typescript,
-  // add qlik's recommended typescript config
+  ...tsconfig.configs.recommendedTypeChecked,
   {
     languageOptions: {
       parserOptions: {
-        parser: tsParser,
         projectService: true,
       },
     },
-    rules: typescriptRules,
+    rules: {
+      ...typescriptRules,
+      // add qlik's recommended typescript config for typescript here if needed
+    },
   },
 );
 

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

@@ -0,0 +1,455 @@
+// @ts-check
+import confusingBrowserGlobals from "confusing-browser-globals";
+
+/**
+ * @satisfies {import("../../../types/index.js").ESLintFlatConfig["rules"]}
+ *
+ * eslint core recommended config https://github.com/eslint/eslint/blob/main/packages/js/src/configs/eslint-recommended.js
+ */
+const rules = {
+  // modify/add rules from eslint core package here additionally to the recommended rules
+
+  // require return statements to either always or never specify values
+  // https://eslint.org/docs/rules/consistent-return
+  "consistent-return": "error",
+
+  // require default case in switch statements
+  // https://eslint.org/docs/rules/default-case
+  "default-case": ["error", { commentPattern: "^no default$" }],
+
+  // Enforce default clauses in switch statements to be last
+  // https://eslint.org/docs/rules/default-case-last
+  "default-case-last": "error",
+
+  // Enforce default parameters to be last
+  // https://eslint.org/docs/rules/default-param-last
+  "default-param-last": "error",
+
+  // require the use of === and !==
+  // https://eslint.org/docs/rules/eqeqeq
+  eqeqeq: ["error", "always", { null: "ignore" }],
+
+  // disallow the use of alert, confirm, and prompt
+  // https://eslint.org/docs/rules/no-alert
+  "no-alert": "error",
+
+  // Disallow returning value in constructor
+  // https://eslint.org/docs/rules/no-constructor-return
+  "no-constructor-return": "error",
+
+  // disallow use of eval()
+  // https://eslint.org/docs/rules/no-eval
+  "no-eval": "error",
+
+  // disallow adding to native types
+  // https://eslint.org/docs/rules/no-extend-native
+  "no-extend-native": "error",
+
+  // disallow unnecessary function binding
+  // https://eslint.org/docs/rules/no-extra-bind
+  "no-extra-bind": "error",
+
+  // disallow use of eval()-like methods
+  // https://eslint.org/docs/rules/no-implied-eval
+  "no-implied-eval": "error",
+
+  // disallow unnecessary nested blocks
+  // https://eslint.org/docs/rules/no-lone-blocks
+  "no-lone-blocks": "error",
+
+  // disallow creation of functions within loops
+  // https://eslint.org/docs/rules/no-loop-func
+  "no-loop-func": "error",
+
+  // disallow use of new operator for Function object
+  // https://eslint.org/docs/rules/no-new-func
+  "no-new-func": "error",
+
+  // Disallow calls to the Object constructor without an argument
+  // https://eslint.org/docs/latest/rules/no-object-constructor
+  "no-object-constructor": "error",
+
+  // disallow use of octal escape sequences in string literals, such as
+  // var foo = 'Copyright \251';
+  // https://eslint.org/docs/rules/no-octal-escape
+  "no-octal-escape": "error",
+
+  // disallow reassignment of function parameters
+  // disallow parameter object manipulation except for specific exclusions
+  // rule: https://eslint.org/docs/rules/no-param-reassign.html
+  "no-param-reassign": [
+    "error",
+    {
+      props: true,
+      ignorePropertyModificationsFor: [
+        "prev", // for reduce accumulators
+        "acc", // for reduce accumulators
+        "accumulator", // for reduce accumulators
+        "e", // for e.returnvalue
+        "ctx", // for Koa routing
+        "context", // for Koa routing
+        "req", // for Express requests
+        "request", // for Express requests
+        "res", // for Express responses
+        "response", // for Express responses
+        "$scope", // for Angular 1 scopes
+        "staticContext", // for ReactRouter context
+        "sharedState", // for shared state in reducers
+        "state", // for shared state in reducers
+      ],
+    },
+  ],
+
+  // disallow usage of __proto__ property
+  // 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": [
+    "error",
+    {
+      object: "arguments",
+      property: "callee",
+      message: "arguments.callee is deprecated",
+    },
+    {
+      object: "global",
+      property: "isFinite",
+      message: "Please use Number.isFinite instead",
+    },
+    {
+      object: "self",
+      property: "isFinite",
+      message: "Please use Number.isFinite instead",
+    },
+    {
+      object: "window",
+      property: "isFinite",
+      message: "Please use Number.isFinite instead",
+    },
+    {
+      object: "global",
+      property: "isNaN",
+      message: "Please use Number.isNaN instead",
+    },
+    {
+      object: "self",
+      property: "isNaN",
+      message: "Please use Number.isNaN instead",
+    },
+    {
+      object: "window",
+      property: "isNaN",
+      message: "Please use Number.isNaN instead",
+    },
+    {
+      property: "__defineGetter__",
+      message: "Please use Object.defineProperty instead.",
+    },
+    {
+      property: "__defineSetter__",
+      message: "Please use Object.defineProperty instead.",
+    },
+  ],
+
+  // disallow use of assignment in return statement
+  // https://eslint.org/docs/rules/no-return-assign
+  "no-return-assign": ["error", "always"],
+
+  // disallow use of `javascript:` urls.
+  // https://eslint.org/docs/rules/no-script-url
+  "no-script-url": "error",
+
+  // disallow comparisons where both sides are exactly the same
+  // https://eslint.org/docs/rules/no-self-compare
+  "no-self-compare": "error",
+
+  // disallow use of comma operator
+  // https://eslint.org/docs/rules/no-sequences
+  "no-sequences": "error",
+
+  // restrict what can be thrown as an exception
+  // https://eslint.org/docs/rules/no-throw-literal
+  "no-throw-literal": "error",
+
+  // disallow unmodified conditions of loops
+  // https://eslint.org/docs/rules/no-unmodified-loop-condition
+  "no-unmodified-loop-condition": "error",
+
+  // disallow usage of expressions in statement position
+  // https://eslint.org/docs/rules/no-unused-expressions
+  "no-unused-expressions": [
+    "error",
+    {
+      allowShortCircuit: false,
+      allowTernary: false,
+      allowTaggedTemplates: false,
+    },
+  ],
+
+  // disallow unnecessary .call() and .apply()
+  // https://eslint.org/docs/rules/no-useless-call
+  "no-useless-call": "error",
+
+  // disallow useless string concatenation
+  // https://eslint.org/docs/rules/no-useless-concat
+  "no-useless-concat": "error",
+
+  // disallow redundant return; keywords
+  // https://eslint.org/docs/rules/no-useless-return
+  "no-useless-return": "error",
+
+  // require using Error objects as Promise rejection reasons
+  // https://eslint.org/docs/rules/prefer-promise-reject-errors
+  "prefer-promise-reject-errors": ["error", { allowEmptyReject: true }],
+
+  // Prefer Object.hasOwn() over Object.prototype.hasOwnProperty.call()
+  // https://eslint.org/docs/rules/prefer-object-has-own
+  "prefer-object-has-own": "error",
+
+  // https://eslint.org/docs/rules/prefer-regex-literals
+  "prefer-regex-literals": [
+    "error",
+    {
+      disallowRedundantWrapping: true,
+    },
+  ],
+
+  // require use of the second argument for parseInt()
+  // https://eslint.org/docs/rules/radix
+  radix: "error",
+
+  // require or disallow Yoda conditions
+  // https://eslint.org/docs/rules/yoda
+  yoda: "error",
+
+  // Disallow await inside of loops
+  // https://eslint.org/docs/rules/no-await-in-loop
+  "no-await-in-loop": "error",
+
+  // disallow use of console
+  "no-console": "warn",
+
+  // disallow function or variable declarations in nested blocks
+  "no-inner-declarations": "error",
+
+  // Disallow returning values from Promise executor functions
+  // https://eslint.org/docs/rules/no-promise-executor-return
+  "no-promise-executor-return": "error",
+
+  // Disallow template literal placeholder syntax in regular strings
+  // https://eslint.org/docs/rules/no-template-curly-in-string
+  "no-template-curly-in-string": "error",
+
+  // Disallow loops with a body that allows only one iteration
+  // https://eslint.org/docs/rules/no-unreachable-loop
+  "no-unreachable-loop": [
+    "error",
+    {
+      ignore: [], // WhileStatement, DoWhileStatement, ForStatement, ForInStatement, ForOfStatement
+    },
+  ],
+
+  // disallow use of optional chaining in contexts where the undefined value is not allowed
+  // https://eslint.org/docs/rules/no-unsafe-optional-chaining
+  "no-unsafe-optional-chaining": ["error", { disallowArithmeticOperators: true }],
+
+  // ensure that the results of typeof are compared against a valid string
+  // https://eslint.org/docs/rules/valid-typeof
+  "valid-typeof": ["error", { requireStringLiterals: true }],
+
+  // Disallow specified names in exports
+  // https://eslint.org/docs/rules/no-restricted-exports
+  "no-restricted-exports": [
+    "error",
+    {
+      restrictedNamedExports: [
+        "default", // use `export default` to provide a default export
+        "then", // this will cause tons of confusion when your module is dynamically `import()`ed, and will break in most node ESM versions
+      ],
+    },
+  ],
+
+  // 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",
+
+  // disallow unnecessary constructor
+  // https://eslint.org/docs/rules/no-useless-constructor
+  "no-useless-constructor": "error",
+
+  // disallow renaming import, export, and destructured assignments to the same name
+  // https://eslint.org/docs/rules/no-useless-rename
+  "no-useless-rename": [
+    "error",
+    {
+      ignoreDestructuring: false,
+      ignoreImport: false,
+      ignoreExport: false,
+    },
+  ],
+
+  // require let or const instead of var
+  "no-var": "error",
+
+  // require method and property shorthand syntax for object literals
+  // https://eslint.org/docs/rules/object-shorthand
+  "object-shorthand": [
+    "error",
+    "always",
+    {
+      ignoreConstructors: false,
+      avoidQuotes: true,
+    },
+  ],
+
+  // suggest using of const declaration for variables that are never modified after declared
+  "prefer-const": [
+    "error",
+    {
+      destructuring: "any",
+      ignoreReadBeforeAssign: true,
+    },
+  ],
+
+  // disallow parseInt() in favor of binary, octal, and hexadecimal literals
+  // https://eslint.org/docs/rules/prefer-numeric-literals
+  "prefer-numeric-literals": "error",
+
+  // use rest parameters instead of arguments
+  // https://eslint.org/docs/rules/prefer-rest-params
+  "prefer-rest-params": "error",
+
+  // suggest using the spread syntax instead of .apply()
+  // https://eslint.org/docs/rules/prefer-spread
+  "prefer-spread": "error",
+
+  // suggest using template literals instead of string concatenation
+  // https://eslint.org/docs/rules/prefer-template
+  "prefer-template": "error",
+
+  // require a Symbol description
+  // https://eslint.org/docs/rules/symbol-description
+  "symbol-description": "error",
+
+  // disallow specific globals
+  // https://eslint.org/docs/latest/rules/no-restricted-globals
+  "no-restricted-globals": [
+    "error",
+    {
+      name: "isFinite",
+      message: "Use Number.isFinite instead",
+    },
+    {
+      name: "isNaN",
+      message: "Use Number.isNaN instead",
+    },
+    ...confusingBrowserGlobals.map((g) => ({
+      name: g,
+      message: `Use window.${g} instead`,
+    })),
+  ],
+
+  // disallow declaration of variables already declared in the outer scope
+  // https://eslint.org/docs/latest/rules/no-shadow
+  "no-shadow": "error",
+
+  // disallow use of undefined when initializing variables
+  // https://eslint.org/docs/latest/rules/no-undef-init
+  "no-undef-init": "error",
+
+  // require camel case names
+  // https://eslint.org/docs/latest/rules/camelcase
+  camelcase: ["error", { properties: "never", ignoreDestructuring: false }],
+
+  // require function expressions to have a name
+  // https://eslint.org/docs/rules/func-names
+  "func-names": "warn",
+
+  // require a capital letter for constructors
+  // https://eslint.org/docs/rules/new-cap
+  "new-cap": [
+    "error",
+    {
+      newIsCap: true,
+      newIsCapExceptions: [],
+      capIsNew: false,
+      capIsNewExceptions: ["Immutable.Map", "Immutable.Set", "Immutable.List"],
+    },
+  ],
+
+  // disallow use of the Array constructor
+  "no-array-constructor": "error",
+
+  // disallow if as the only statement in an else block
+  // https://eslint.org/docs/rules/no-lonely-if
+  "no-lonely-if": "error",
+
+  // disallow use of chained assignment expressions
+  // https://eslint.org/docs/rules/no-multi-assign
+  "no-multi-assign": ["error"],
+
+  // disallow nested ternary expressions
+  "no-nested-ternary": "error",
+
+  // disallow certain syntax forms
+  // https://eslint.org/docs/rules/no-restricted-syntax
+  "no-restricted-syntax": [
+    "error",
+    // {
+    //   selector: "ForInStatement",
+    //   message:
+    //     "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use for..of or Object.{keys,values,entries}, and iterate over the resulting array.",
+    // },
+    {
+      selector: "LabeledStatement",
+      message: "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.",
+    },
+    {
+      selector: "WithStatement",
+      message: "`with` is disallowed in strict mode because it makes code impossible to predict and optimize.",
+    },
+  ],
+
+  // disallow the use of Boolean literals in conditional expressions
+  // also, prefer `a || b` over `a ? a : b`
+  // https://eslint.org/docs/rules/no-unneeded-ternary
+  "no-unneeded-ternary": ["error", { defaultAssignment: false }],
+
+  // allow just one var statement per function
+  // https://eslint.org/docs/rules/one-var
+  "one-var": ["error", "never"],
+
+  // require assignment operator shorthand where possible or prohibit it entirely
+  // https://eslint.org/docs/rules/operator-assignment
+  "operator-assignment": ["error", "always"],
+
+  // Disallow the use of Math.pow in favor of the ** operator
+  // https://eslint.org/docs/rules/prefer-exponentiation-operator
+  "prefer-exponentiation-operator": "error",
+
+  // Prefer use of an object spread over Object.assign
+  // https://eslint.org/docs/rules/prefer-object-spread
+  "prefer-object-spread": "error",
+
+  // require or disallow the Unicode Byte Order Mark
+  // https://eslint.org/docs/rules/unicode-bom
+  "unicode-bom": ["error", "never"],
+};
+
+export default rules;