Started working on flat config for eslint

Author: AndreasArvidsson

.eslintrc.json

@@ -17,7 +17,6 @@ jobs:
     runs-on: ubuntu-latest
     env:
       CURSORLESS_REPO_ROOT: ${{ github.workspace }}
-      ESLINT_USE_FLAT_CONFIG: false
 
     steps:
       - name: Checkout repository

.github/workflows/pre-commit.yml

@@ -0,0 +1,143 @@
+import eslintJs from "@eslint/js";
+import eslintPrettier from "eslint-config-prettier/flat";
+import path from "node:path";
+import eslintTs from "typescript-eslint";
+import unusedImports from "eslint-plugin-unused-imports";
+import importPlugin from "eslint-plugin-import";
+import mochaPlugin from "eslint-plugin-mocha";
+import eslintPluginUnicorn from "eslint-plugin-unicorn";
+import type { Linter } from "eslint";
+import cursorlessOrgConfig from "./packages/cursorless-org/eslint.config.mts";
+
+export default eslintTs.config(
+  {
+    ignores: [
+      "**/generated/**/*",
+      "**/out/**/*",
+      "**/dist/**/*",
+      "**/build/**/*",
+      "**/vendor/**/*",
+      "**/.next/**/*",
+      "**/.docusaurus/**/*",
+      "data/playground/**/*",
+    ],
+  },
+  eslintJs.configs.recommended,
+  // We want to enable this in the long run. For now there are a lot of errors that needs to be handled.
+  // eslintTs.configs.recommendedTypeChecked,
+  eslintTs.configs.recommended,
+  eslintPrettier,
+  {
+    plugins: {
+      "unused-imports": unusedImports,
+      import: importPlugin,
+      unicorn: eslintPluginUnicorn,
+      mocha: mochaPlugin,
+    },
+
+    languageOptions: {
+      parser: eslintTs.parser,
+      ecmaVersion: 6,
+      sourceType: "module",
+      parserOptions: {
+        project: true,
+      },
+    },
+
+    settings: {
+      "import/resolver": {
+        typescript: {
+          alwaysTryTypes: true, // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
+          project: ["tsconfig.json", "packages/*/tsconfig.json"],
+        },
+      },
+    },
+
+    rules: {
+      "import/no-relative-packages": "error",
+      "@typescript-eslint/consistent-type-imports": "error",
+      "@typescript-eslint/consistent-type-assertions": [
+        "error",
+        {
+          assertionStyle: "as",
+        },
+      ],
+      "@typescript-eslint/naming-convention": [
+        "error",
+        {
+          selector: ["objectLiteralProperty"],
+          format: ["camelCase"],
+          filter: {
+            regex: "[.]",
+            match: false,
+          },
+        },
+      ],
+      "@typescript-eslint/no-floating-promises": "error",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-inferrable-types": "off",
+      "@typescript-eslint/no-non-null-assertion": "off",
+      "unused-imports/no-unused-imports": "error",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          argsIgnorePattern: "^_",
+          varsIgnorePattern: "^_",
+          caughtErrorsIgnorePattern: "^_",
+          ignoreRestSiblings: true,
+        },
+      ],
+      curly: "error",
+      eqeqeq: [
+        "error",
+        "always",
+        {
+          null: "never",
+        },
+      ],
+      "no-constant-condition": [
+        "error",
+        {
+          checkLoops: false,
+        },
+      ],
+      "no-restricted-syntax": [
+        "error",
+        "MemberExpression[object.property.name='constructor'][property.name='name']",
+      ],
+      "no-throw-literal": "error",
+      semi: "off",
+      "unicorn/prefer-module": "error",
+      "mocha/no-pending-tests": "error",
+      "mocha/no-exclusive-tests": "error",
+    },
+  },
+  {
+    files: ["**/*.tsx"],
+    rules: {
+      "@typescript-eslint/naming-convention": [
+        "error",
+        {
+          selector: ["function"],
+          format: ["PascalCase", "camelCase"],
+        },
+      ],
+    },
+  },
+  {
+    files: [
+      "**/jest.config.ts",
+      "**/docusaurus.config.mts",
+      "**/mdx-components.tsx",
+      "**/scripts/**",
+      "**/resources/**",
+      "typings/**",
+      "**/*.js",
+      "**/*.mjs",
+      "eslint.config.mts",
+    ],
+
+    extends: [eslintTs.configs.disableTypeChecked],
+  },
+  cursorlessOrgConfig,
+);

eslint.config.mts

@@ -18,7 +18,7 @@
     "fix:syncpack": "pnpm syncpack fix-mismatches",
     "init-vscode-sandbox": "pnpm --filter=@cursorless/cursorless-vscode init-launch-sandbox",
     "lint:meta": "pnpm run meta-updater:base --test",
-    "lint:ts": "cross-env ESLINT_USE_FLAT_CONFIG=false eslint packages --ext ts,tsx,mts",
+    "lint:ts": "eslint packages --ext ts,tsx,mts",
     "lint": "pnpm run lint:meta && syncpack list-mismatches && pnpm run lint:ts",
     "meta-updater:base": "pnpm --filter=@cursorless/meta-updater build && meta-updater",
     "preinstall": "npx only-allow pnpm",
@@ -31,23 +31,23 @@
     "watch:tsc": "tsc --build --watch"
   },
   "devDependencies": {
+    "@eslint/js": "^9.31.0",
+    "@eslint/eslintrc": "^3.3.1",
     "@pnpm/meta-updater": "^2.0.6",
     "@types/node": "^24.0.15",
-    "@typescript-eslint/eslint-plugin": "^8.38.0",
-    "@typescript-eslint/parser": "^8.38.0",
-    "cross-env": "^7.0.3",
     "esbuild": "^0.25.8",
     "eslint": "^9.31.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-mocha": "^10.5.0",
-    "eslint-plugin-unicorn": "^56.0.1",
+    "eslint-plugin-mocha": "^11.1.0",
+    "eslint-plugin-unicorn": "^60.0.0",
     "eslint-plugin-unused-imports": "^4.1.4",
     "prettier": "~3.3.3",
     "prettier-plugin-tailwindcss": "^0.6.14",
     "syncpack": "^13.0.4",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.38.0"
   },
   "pnpm": {
     "patchedDependencies": {

package.json

@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-imports
 import type {
   Direction,
   Position,

packages/cursorless-engine/src/processTargets/.eslintrc.json

@@ -5,7 +5,6 @@
 // - https://github.com/microsoft/TypeScript/issues/43950
 // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-imports
 import type { ModifyIfUntypedStage } from "../processTargets/modifiers/ConditionalModifierStages";
-// eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-imports
 import type {
   GeneralizedRange,
   InsertionMode,

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/BaseScopeHandler.ts

@@ -0,0 +1,17 @@
+import { FlatCompat } from "@eslint/eslintrc";
+
+const compat = new FlatCompat({
+  baseDirectory: import.meta.dirname,
+});
+
+export default {
+  files: ["packages/cursorless-org/src/**/*"],
+
+  extends: [...compat.extends("next/core-web-vitals")],
+
+  settings: {
+    next: {
+      rootDir: "packages/cursorless-org",
+    },
+  },
+};

packages/cursorless-engine/src/typings/target.types.ts

@@ -43,7 +43,6 @@ async function runTest() {
     ],
   });
 
-  // eslint-disable-next-line no-restricted-properties
   const editor = window.activeTextEditor;
 
   if (editor == null) {