Replace eslint and prettier with oxlint and oxfmt (#3250)

Author: AndreasArvidsson

.meta-updater/main.mjs

@@ -1,4 +1,3 @@
-// eslint-disable-next-line import/no-relative-packages
 import { updater } from "../packages/tool-meta-updater/src/index.ts";
 
 export default updater;

.oxfmtrc.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "sortPackageJson": false,
+  "ignorePatterns": [
+    "/packages/app-vscode/src/keyboard/grammar/generated/",
+    "/packages/lib-engine/src/customCommandGrammar/generated/",
+    "/packages/lib-engine/src/snippets/vendor/",
+    "/resources/fixtures/recorded/**/*.yml"
+  ]
+}

.oxlintrc.json

@@ -0,0 +1,142 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": ["eslint", "typescript", "unicorn", "oxc", "import"],
+  "jsPlugins": [
+    {
+      "name": "mocha",
+      "specifier": "eslint-plugin-mocha"
+    }
+  ],
+
+  "ignorePatterns": [
+    "resources/playground/**",
+    "packages/app-neovim/cursorless.nvim/**",
+    "packages/app-vscode/src/keyboard/grammar/generated/**",
+    "packages/lib-engine/src/customCommandGrammar/generated/**",
+    "packages/lib-engine/src/snippets/vendor/**"
+  ],
+
+  "options": {
+    "typeAware": true,
+    "typeCheck": false
+  },
+
+  "rules": {
+    "curly": "warn",
+    "eqeqeq": [
+      "warn",
+      "always",
+      {
+        "null": "never"
+      }
+    ],
+    "eslint/no-constant-condition": [
+      "warn",
+      {
+        "checkLoops": false
+      }
+    ],
+    "eslint/no-restricted-imports": [
+      "warn",
+      {
+        "patterns": [
+          {
+            "group": ["../*/src", "../*/src/*", "../../*/src", "../../*/src/*"],
+            "message": "Relative package imports are not allowed"
+          }
+        ]
+      }
+    ],
+    "eslint/no-throw-literal": "warn",
+    "eslint/no-unused-vars": [
+      "warn",
+      {
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_",
+        "caughtErrorsIgnorePattern": "^_",
+        "ignoreRestSiblings": true
+      }
+    ],
+    "import/no-duplicates": "warn",
+    "mocha/no-exclusive-tests": "warn",
+    "mocha/no-pending-tests": "warn",
+    "no-warning-comments": [
+      "warn",
+      {
+        "terms": ["todo"]
+      }
+    ],
+    "typescript/consistent-type-assertions": [
+      "warn",
+      {
+        "assertionStyle": "as"
+      }
+    ],
+    "typescript/consistent-type-imports": "warn",
+    "typescript/no-base-to-string": "off",
+    "typescript/restrict-template-expressions": "off",
+    "typescript/unbound-method": "off",
+    "unicorn/prefer-module": "warn",
+    "unicorn/throw-new-error": "warn"
+  },
+  "overrides": [
+    {
+      "files": ["packages/app-vscode/src/scripts/**/*.ts"],
+      "rules": {
+        "no-restricted-imports": [
+          "warn",
+          {
+            "paths": [
+              {
+                "name": "vscode",
+                "message": "Scripts shouldn't depend on vscode"
+              }
+            ]
+          }
+        ]
+      }
+    },
+
+    {
+      "files": ["packages/lib-common/**/*.ts", "packages/lib-engine/**/*.ts"],
+      "rules": {
+        "import/no-nodejs-modules": "warn"
+      }
+    },
+
+    {
+      "files": [
+        "packages/lib-common/**/*.test.ts",
+        "packages/lib-engine/**/*.test.ts",
+        "packages/lib-engine/src/scripts/**/*.ts",
+        "packages/lib-engine/src/testUtil/**/*.ts"
+      ],
+      "rules": {
+        "import/no-nodejs-modules": "off"
+      }
+    },
+
+    {
+      "files": ["packages/lib-common/src/types/command/**/*.ts"],
+      "rules": {
+        "eslint/no-restricted-imports": [
+          "warn",
+          {
+            "patterns": [
+              {
+                "group": ["@cursorless/*", "../*"],
+                "message": "API types shouldn't have any dependencies"
+              }
+            ],
+            "paths": [
+              {
+                "name": "@*",
+                "message": "API types shouldn't have any dependencies"
+              }
+            ]
+          }
+        ]
+      }
+    }
+  ]
+}

.pre-commit-config.yaml

@@ -58,21 +58,21 @@ repos:
 
   - repo: local
     hooks:
-      - id: eslint
-        name: eslint
+      - id: oxlint
+        name: oxlint
         files: \.(ts|tsx)$
         language: system
-        entry: pnpm exec eslint
+        entry: pnpm exec oxlint
         args: [--fix]
 
   - repo: local
     hooks:
-      - id: prettier
-        name: prettier
+      - id: oxfmt
+        name: oxfmt
         types: [text]
         language: system
-        entry: pnpm exec prettier
-        args: [--write, --list-different, --ignore-unknown]
+        entry: pnpm exec oxfmt
+        args: [--write, --no-error-on-unmatched-pattern]
 
   - repo: local
     hooks:

.prettierignore

@@ -4,8 +4,7 @@
   "recommendations": [
     "AndreasArvidsson.andreas-talon",
     "charliermarsh.ruff",
-    "dbaeumer.vscode-eslint",
-    "esbenp.prettier-vscode",
+    "oxc.oxc-vscode",
     "jrieken.vscode-tree-sitter-query",
     "wenkokke.talonfmt-vscode",
     "usernamehw.commands",

.vscode/extensions.json

@@ -18,8 +18,7 @@
     "pojo",
     "subword"
   ],
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "eslint.workingDirectories": [{ "pattern": "packages/*/" }],
+  "editor.defaultFormatter": "oxc.oxc-vscode",
   "files.associations": {
     ".busted": "lua"
   },