@qlik/eslint-config 1.0.0 → 1.0.2

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@qlik/eslint-config",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Qlik's ESLint configs",
   "repository": "git@github.com:qlik-oss/dev-tools-js.git",
   "license": "ISC",
   "type": "module",
   "exports": {
-    ".": "./lib/index.js"
+    ".": "./src/index.js"
   },
   "module": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -19,7 +19,7 @@
     "@eslint-react/eslint-plugin": "1.17.1",
     "@eslint/js": "^9.15.0",
     "@typescript-eslint/utils": "^8.16.0",
-    "@vitest/eslint-plugin": "^1.1.10",
+    "@vitest/eslint-plugin": "^1.1.11",
     "confusing-browser-globals": "^1.0.11",
     "eslint-import-resolver-typescript": "^3.6.3",
     "eslint-plugin-import-x": "^4.4.3",

package/src/configs/cjs.js

@@ -2,12 +2,13 @@
 import globals from "globals";
 import { mergeConfigs } from "../utils/config.js";
 import { recommendedJS, recommendedTS } from "./recommended.js";
+import rules from "./rules/index.js";
 
 /**
  * @satisfies {import("../types/index.js").ESLintFlatConfig['rules']}
  */
 const cjsRules = {
-  // modify rules for node here
+  // modify rules for node commonjs here
 };
 
 /**
@@ -21,6 +22,7 @@ const cjsJS = mergeConfigs(recommendedJS, {
     sourceType: "commonjs",
   },
   rules: {
+    ...rules.nodeRules,
     ...cjsRules,
   },
 });
@@ -36,6 +38,7 @@ const cjsTS = mergeConfigs(recommendedTS, {
     sourceType: "commonjs",
   },
   rules: {
+    ...rules.nodeRules,
     ...cjsRules,
     // modify ts specific rules for node here
   },

package/src/configs/esm.js

@@ -1,6 +1,7 @@
 // @ts-check
+import globals from "globals";
 import { mergeConfigs } from "../utils/config.js";
-import { cjsJS, cjsTS } from "./cjs.js";
+import { recommendedJS, recommendedTS } from "./recommended.js";
 
 /**
  * @satisfies {import("../types/index.js").ESLintFlatConfig["rules"]}
@@ -13,10 +14,11 @@ const nodeEsmRules = {
 /**
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
-const esmJS = mergeConfigs(cjsJS, {
+const esmJS = mergeConfigs(recommendedJS, {
   name: "node-esm-js",
   files: ["**/*.{js,mjs}"],
   languageOptions: {
+    globals: globals.node,
     sourceType: "module",
   },
   rules: {
@@ -27,10 +29,11 @@ const esmJS = mergeConfigs(cjsJS, {
 /**
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
-const esmTS = mergeConfigs(cjsTS, {
+const esmTS = mergeConfigs(recommendedTS, {
   name: "node-esm-ts",
   files: ["**/*.{ts,mts}"],
   languageOptions: {
+    globals: globals.node,
     sourceType: "module",
   },
   rules: {

package/src/configs/react.js

@@ -14,7 +14,7 @@ const reactPlugin = eslintPluginReact;
 /**
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
-const reactConfig = mergeConfigs({
+const reactConfig = {
   languageOptions: {
     parserOptions: {
       ecmaFeatures: {
@@ -45,12 +45,12 @@ const reactConfig = mergeConfigs({
     ...reactHooks.configs.recommended.rules,
     ...rules.reactHooksRules,
   },
-});
+};
 
 /**
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
-const reactJS = mergeConfigs(reactConfig, recommendedJS, {
+const reactJS = mergeConfigs(reactConfig, {
   name: "react-js",
   files: ["**/*.jsx"],
   rules: {
@@ -62,7 +62,7 @@ const reactJS = mergeConfigs(reactConfig, recommendedJS, {
 /**
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
-const reactTS = mergeConfigs(reactConfig, recommendedTS, {
+const reactTS = mergeConfigs(reactConfig, {
   name: "react-ts",
   files: ["**/*.tsx"],
   rules: {

package/src/configs/recommended.js

@@ -7,27 +7,20 @@ import tsconfig from "typescript-eslint";
 import { mergeConfigs } from "../utils/config.js";
 import rules from "./rules/index.js";
 
-/**
- * @type {import("../types/index.js").ESLintFlatConfig}
- */
-const recommendedJS = mergeConfigs(
+const baseConfig = mergeConfigs(
   {
-    files: ["**/*.js", "**/*.jsx", "**/*.mjs", "**/*.cjs"],
     languageOptions: {
       globals: globals.browser,
       parserOptions: {
         warnOnUnsupportedTypeScriptVersion: false,
       },
-      ecmaVersion: 2021,
+      ecmaVersion: "latest",
       sourceType: "module",
     },
   },
-  // tsconfig.configs.base sets eslint parser to use the typescript parser to parse .js files - handles all modern syntax
-  tsconfig.configs.base,
   js.configs.recommended,
   eslintPluginImportX.flatConfigs.recommended,
   {
-    name: "recommended-js",
     rules: {
       ...rules.importXRules,
       ...rules.eslintCoreRules,
@@ -35,19 +28,30 @@ const recommendedJS = mergeConfigs(
   },
 );
 
+/**
+ * @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,
+  {
+    name: "recommended-js",
+    files: ["**/*.js", "**/*.mjs", "**/*.cjs"],
+  },
+);
+
 /**
  * @type {import("../types/index.js").ESLintFlatConfig}
  */
 const recommendedTS = mergeConfigs(
-  recommendedJS,
+  baseConfig,
   {
     files: ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts", "**/*.d.ts"],
     languageOptions: {
       parserOptions: {
         parser: tsParser,
         projectService: true,
-        ecmaVersion: "latest",
-        sourceType: "module",
       },
     },
   },

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

@@ -208,6 +208,8 @@ const rules = {
         "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
       ],
     },
   ],
@@ -706,15 +708,15 @@ const rules = {
     "error",
     {
       name: "isFinite",
-      message: "Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite",
+      message: "Use Number.isFinite instead",
     },
     {
       name: "isNaN",
-      message: "Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan",
+      message: "Use Number.isNaN instead",
     },
     ...confusingBrowserGlobals.map((g) => ({
       name: g,
-      message: `Use window.${g} instead. https://github.com/facebook/create-react-app/blob/HEAD/packages/confusing-browser-globals/README.md`,
+      message: `Use window.${g} instead`,
     })),
   ],
 
@@ -866,15 +868,7 @@ const rules = {
 
   // disallow dangling underscores in identifiers
   // https://eslint.org/docs/rules/no-underscore-dangle
-  "no-underscore-dangle": [
-    "error",
-    {
-      allow: [],
-      allowAfterThis: false,
-      allowAfterSuper: false,
-      enforceInMethodNames: true,
-    },
-  ],
+  "no-underscore-dangle": "off",
 
   // disallow the use of Boolean literals in conditional expressions
   // also, prefer `a || b` over `a ? a : b`

package/src/configs/rules/index.js

@@ -1,5 +1,6 @@
 import eslintCoreRules from "./eslint-core.js";
 import importXRules from "./import-x.js";
+import nodeRules from "./node.js";
 import reactA11yRules from "./react-a11y.js";
 import reactHooksRules from "./react-hooks.js";
 import reactRules from "./react.js";
@@ -7,11 +8,12 @@ import testingLibraryRules from "./testing-library.js";
 import typescriptRules from "./typescript.js";
 
 export default {
-  importXRules,
   eslintCoreRules,
-  typescriptRules,
+  importXRules,
+  nodeRules,
   reactRules,
   reactA11yRules,
   reactHooksRules,
   testingLibraryRules,
+  typescriptRules,
 };

package/src/configs/rules/node.js

@@ -5,6 +5,7 @@
  */
 const rules = {
   // TODO use eslint-plugin-n https://github.com/eslint-community/eslint-plugin-n
+  "no-console": "off",
 };
 
 export default rules;

package/src/configs/rules/react.js

@@ -387,13 +387,11 @@ const rules = {
 
   // Enforce state initialization style
   // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/state-in-constructor.md
-  // TODO: set to "never" once babel-preset-airbnb supports public class fields
-  "react/state-in-constructor": ["error", "always"],
+  "react/state-in-constructor": ["error", "never"],
 
   // Enforces where React component static properties should be positioned
   // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/static-property-placement.md
-  // TODO: set to "static public field" once babel-preset-airbnb supports public class fields
-  "react/static-property-placement": ["error", "property assignment"],
+  "react/static-property-placement": "error",
 
   // This has valid cases but best practice to be explicit about the props
   // Disallow JSX props spreading

package/src/configs/rules/typescript.js

@@ -151,7 +151,7 @@ const rules = {
   // Lots of false/iffy positives
   // watch out for always truthy conditions
   // https://typescript-eslint.io/rules/no-unnecessary-condition
-  "@typescript-eslint/no-unnecessary-condition": "off",
+  "@typescript-eslint/no-unnecessary-condition": "error",
 
   // no unnecessary namespace qualifiers.
   // https://typescript-eslint.io/rules/no-unnecessary-qualifier
@@ -201,7 +201,7 @@ const rules = {
   // https://typescript-eslint.io/rules/use-unknown-in-catch-callback-variable
   "@typescript-eslint/use-unknown-in-catch-callback-variable": "error",
 
-  // Replace Airbnb 'camelcase' rule with '@typescript-eslint/naming-convention'
+  // Replace camelcase' rule with '@typescript-eslint/naming-convention'
   // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/naming-convention.md
   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.
@@ -217,7 +217,7 @@ const rules = {
       selector: "function",
       format: ["camelCase", "PascalCase"],
     },
-    // Airbnb recommends PascalCase for classes (23.3), and although Airbnb does not make TypeScript recommendations, we are assuming this rule would similarly apply to anything "type like", including interfaces, type aliases, and enums
+    // Qlik recommends PascalCase for classes (23.3),
     {
       selector: "typeLike",
       format: ["PascalCase"],