eslint: convert to new flat config format

Convert from `.eslintrc` to `eslint.config` file format. Remove the old config and ignore files. The ignore was not needed anyway. Replaced the trojan detection with `eslint-plugin-security`, which includes other checks. Added `typescript-eslint` for ts checks. Added `@stylistic` for lints moved out of eslint. Some of these were intended to override prettier but that is not working. Set `prettier` to warn. It is too opinionated to be allowed to error. Signed-off-by: Chris. Webster <[email protected]>
firoj0 · Aug 22, 2024 · 71e25ba · 71e25ba
1 parent 554fd9c
commit 71e25ba
Show file tree

Hide file tree

Showing 5 changed files with 702 additions and 794 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,192 @@
+import eslint from "@eslint/js";
+import stylistic from "@stylistic/eslint-plugin";
+import jsdoc from "eslint-plugin-jsdoc";
+import eslintConfigPrettier from "eslint-config-prettier";
+import eslintPluginPrettier from "eslint-plugin-prettier";
+import eslintPluginSecurity from "eslint-plugin-security";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  {
+    // ignore these directories and files (not included on command line)
+    ignores: ["**/build/**"],
+  },
+  eslint.configs.recommended,
+  eslintPluginSecurity.configs.recommended,
+  {
+    plugins: {
+      jsdoc,
+      "@stylistic": stylistic,
+      ...eslintConfigPrettier.plugins,
+      prettier: eslintPluginPrettier,
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+
+      ecmaVersion: "latest",
+      sourceType: "module",
+    },
+
+    rules: {
+      ...eslintConfigPrettier.rules,
+      "@stylistic/function-call-argument-newline": [
+        "warn",
+        "consistent",
+      ],
+      "@stylistic/function-paren-newline": [
+        "error",
+        "consistent",
+      ],
+      "@stylistic/max-len": [
+        "error",
+        {
+          code: 120,
+        },
+      ],
+      "@stylistic/new-parens": "error",
+      "@stylistic/no-multi-spaces": [
+        "error",
+        {
+          ignoreEOLComments: true,
+        },
+      ],
+      "@stylistic/spaced-comment": [
+        "error",
+        "always",
+        {
+          markers: ["/"],
+        },
+      ],
+
+      "arrow-body-style": "off",
+      complexity: "off",
+      "constructor-super": "error",
+      eqeqeq: ["error", "smart"],
+      "guard-for-in": "error",
+
+      "id-denylist": [
+        "error",
+        "any",
+        "Number",
+        "String",
+        "string",
+        "Boolean",
+        "boolean",
+        "Undefined",
+        "undefined",
+      ],
+
+      "id-match": "error",
+      "jsdoc/check-alignment": "error",
+
+      "jsdoc/check-indentation": [
+        "error",
+        {
+          excludeTags: ["param"],
+        },
+      ],
+
+      "jsdoc/tag-lines": [
+        "error",
+        "any",
+        {
+          startLines: 1,
+        },
+      ],
+
+      "max-classes-per-file": [
+        "error",
+        2,
+      ],
+
+      "no-bitwise": "error",
+      "no-caller": "error",
+      "no-cond-assign": "error",
+      "no-console": "off",
+      "no-debugger": "error",
+      "no-empty": "error",
+      "no-eval": "error",
+      "no-fallthrough": "off",
+      "no-invalid-this": "off",
+      "no-new-wrappers": "error",
+
+      "no-shadow": [
+        "error",
+        {
+          hoist: "never",
+        },
+      ],
+
+      "no-throw-literal": "error",
+      "no-undef-init": "error",
+      "no-underscore-dangle": "error",
+      "no-unsafe-finally": "error",
+      "no-unused-labels": "error",
+      "no-unused-vars": "off",
+      "object-shorthand": "error",
+      "one-var": ["error", "never"],
+      "prefer-arrow-callback": "off",
+      "prettier/prettier": "warn",
+      radix: "error",
+      "use-isnan": "error",
+    },
+  },
+  {
+    files: ["tests/*.ts", "lib/*.ts", "script/*.ts"],
+    extends: [...tseslint.configs.recommendedTypeChecked],
+    languageOptions: {
+      parserOptions: {
+        project: "tsconfig.eslint.json",
+      },
+    },
+    rules: {
+      "@typescript-eslint/array-type": [
+        "error",
+        {
+          default: "array-simple",
+        },
+      ],
+
+      "@typescript-eslint/consistent-type-assertions": "error",
+      "@typescript-eslint/dot-notation": "error",
+
+      "@typescript-eslint/naming-convention": [
+        "error",
+        {
+          selector: "variable",
+          format: ["camelCase", "snake_case"],
+        },
+      ],
+
+      "@typescript-eslint/no-explicit-any": [
+        "error",
+        {
+          ignoreRestArgs: true,
+        },
+      ],
+
+      "@typescript-eslint/no-unused-expressions": "error",
+      "@typescript-eslint/no-unused-vars": "off",
+      "@typescript-eslint/prefer-for-of": "error",
+      "@typescript-eslint/prefer-function-type": "error",
+      "@typescript-eslint/prefer-regexp-exec": "off",
+      "@typescript-eslint/restrict-template-expressions": "off",
+
+      "@typescript-eslint/triple-slash-reference": [
+        "error",
+        {
+          path: "always",
+          types: "prefer-import",
+          lib: "always",
+        },
+      ],
+
+      "@typescript-eslint/unified-signatures": "error",
+    },
+  },
+  // eslintPluginPrettierRecommended,
+);