Merge pull request #2024 from github/koesie10/eslint-config

Unify ESLint configuration

Author: koesie10

extensions/ql-vscode/.eslintignore

@@ -1,6 +1,7 @@
 .vscode-test/
 node_modules/
 out/
+build/
 
 # Include the Storybook config
 !.storybook

extensions/ql-vscode/.eslintrc.js

@@ -1,15 +1,20 @@
-module.exports = {
+const { resolve } = require("path");
+
+const baseConfig = {
   parser: "@typescript-eslint/parser",
   parserOptions: {
     ecmaVersion: 2018,
     sourceType: "module",
-    project: ["tsconfig.json", "./src/**/tsconfig.json", "./test/**/tsconfig.json", "./gulpfile.ts/tsconfig.json", "./scripts/tsconfig.json", "./.storybook/tsconfig.json"],
+    project: [
+      resolve(__dirname, "tsconfig.lint.json"),
+      resolve(__dirname, "src/**/tsconfig.json"),
+      resolve(__dirname, "test/**/tsconfig.json"),
+      resolve(__dirname, "gulpfile.ts/tsconfig.json"),
+      resolve(__dirname, "scripts/tsconfig.json"),
+      resolve(__dirname, ".storybook/tsconfig.json"),
+    ],
   },
-  plugins: [
-    "github",
-    "@typescript-eslint",
-    "etc"
-  ],
+  plugins: ["github", "@typescript-eslint", "etc"],
   env: {
     node: true,
     es6: true,
@@ -21,7 +26,7 @@ module.exports = {
     "plugin:github/typescript",
     "plugin:jest-dom/recommended",
     "plugin:prettier/recommended",
-    "plugin:@typescript-eslint/recommended"
+    "plugin:@typescript-eslint/recommended",
   ],
   rules: {
     "@typescript-eslint/no-use-before-define": 0,
@@ -37,14 +42,14 @@ module.exports = {
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/no-non-null-assertion": "off",
     "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-floating-promises": [ "error", { ignoreVoid: true } ],
+    "@typescript-eslint/no-floating-promises": ["error", { ignoreVoid: true }],
     "@typescript-eslint/no-invalid-this": "off",
     "@typescript-eslint/no-shadow": "off",
     "prefer-const": ["warn", { destructuring: "all" }],
     "@typescript-eslint/no-throw-literal": "error",
     "no-useless-escape": 0,
-    "camelcase": "off",
-    "eqeqeq": "off",
+    camelcase: "off",
+    eqeqeq: "off",
     "escompat/no-regexp-lookbehind": "off",
     "etc/no-implicit-any-catch": "error",
     "filenames/match-regex": "off",
@@ -72,3 +77,102 @@ module.exports = {
     "github/no-then": "off",
   },
 };
+
+module.exports = {
+  root: true,
+  ...baseConfig,
+  overrides: [
+    {
+      files: ["src/stories/**/*"],
+      parserOptions: {
+        project: resolve(__dirname, "src/stories/tsconfig.json"),
+      },
+      extends: [
+        ...baseConfig.extends,
+        "plugin:react/recommended",
+        "plugin:react-hooks/recommended",
+        "plugin:storybook/recommended",
+      ],
+      rules: {
+        ...baseConfig.rules,
+      },
+      settings: {
+        react: {
+          version: "detect",
+        },
+      },
+    },
+    {
+      files: ["src/view/**/*"],
+      parserOptions: {
+        project: resolve(__dirname, "src/view/tsconfig.json"),
+      },
+      extends: [
+        ...baseConfig.extends,
+        "plugin:react/recommended",
+        "plugin:react-hooks/recommended",
+      ],
+      rules: {
+        ...baseConfig.rules,
+      },
+      settings: {
+        react: {
+          version: "detect",
+        },
+      },
+    },
+    {
+      files: ["test/**/*"],
+      parserOptions: {
+        project: resolve(__dirname, "test/tsconfig.json"),
+      },
+      env: {
+        jest: true,
+      },
+    },
+    {
+      files: ["test/vscode-tests/**/*"],
+      parserOptions: {
+        project: resolve(__dirname, "test/tsconfig.json"),
+      },
+      env: {
+        jest: true,
+      },
+      rules: {
+        ...baseConfig.rules,
+        "@typescript-eslint/ban-types": [
+          "error",
+          {
+            // For a full list of the default banned types, see:
+            // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md
+            extendDefaults: true,
+            types: {
+              // Don't complain about the `Function` type in test files. (Default is `true`.)
+              Function: false,
+            },
+          },
+        ],
+      },
+    },
+    {
+      files: [
+        ".eslintrc.js",
+        "test/**/jest-runner-vscode.config.js",
+        "test/**/jest-runner-vscode.config.base.js",
+      ],
+      parser: undefined,
+      plugins: ["github"],
+      extends: [
+        "eslint:recommended",
+        "plugin:github/recommended",
+        "plugin:prettier/recommended",
+      ],
+      rules: {
+        "import/no-commonjs": "off",
+        "prefer-template": "off",
+        "filenames/match-regex": "off",
+        "@typescript-eslint/no-var-requires": "off",
+      },
+    },
+  ],
+};

extensions/ql-vscode/package.json

@@ -1330,7 +1330,7 @@
     "cli-integration": "jest --projects test/vscode-tests/cli-integration",
     "update-vscode": "node ./node_modules/vscode/bin/install",
     "format": "prettier --write **/*.{ts,tsx} && eslint . --ext .ts,.tsx --fix",
-    "lint": "eslint . --ext .ts,.tsx --max-warnings=0",
+    "lint": "eslint . --ext .js,.ts,.tsx --max-warnings=0",
     "format-staged": "lint-staged",
     "storybook": "start-storybook -p 6006",
     "build-storybook": "build-storybook",

extensions/ql-vscode/src/stories/.eslintrc.js

@@ -2,7 +2,6 @@ import { expect } from "@jest/globals";
 import type { MatcherFunction } from "expect";
 import { pathsEqual } from "../../src/pure/files";
 
-// eslint-disable-next-line func-style -- We need to have access to this and specify the type of the function
 const toEqualPath: MatcherFunction<[expectedPath: unknown]> = function (
   actual,
   expectedPath,
@@ -15,20 +14,16 @@ const toEqualPath: MatcherFunction<[expectedPath: unknown]> = function (
   if (pass) {
     return {
       message: () =>
-        // eslint-disable-next-line @typescript-eslint/no-invalid-this
         `expected ${this.utils.printReceived(
           actual,
-          // eslint-disable-next-line @typescript-eslint/no-invalid-this
         )} to equal path ${this.utils.printExpected(expectedPath)}`,
       pass: true,
     };
   } else {
     return {
       message: () =>
-        // eslint-disable-next-line @typescript-eslint/no-invalid-this
         `expected ${this.utils.printReceived(
           actual,
-          // eslint-disable-next-line @typescript-eslint/no-invalid-this
         )} to equal path ${this.utils.printExpected(expectedPath)}`,
       pass: false,
     };

extensions/ql-vscode/src/view/.eslintrc.js

@@ -1,6 +1,6 @@
 {
   "extends": "../tsconfig.json",
-  "include": ["**/*.ts", "../src/**/*.ts"],
+  "include": ["**/*.ts", "../src/**/*.ts", "**/.eslintrc.js", "**/*.config.js"],
   "exclude": [],
   "compilerOptions": {
     "noEmit": true,

extensions/ql-vscode/test/.eslintrc.js

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*.ts", "**/.eslintrc.js", "jest.config.js"]
+}