chore: add oxlint and pre-commit hooks (#61)

Author: benvinegar

.github/workflows/ci.yml

@@ -33,6 +33,9 @@ jobs:
       - name: Format check
         run: bun run format:check
 
+      - name: Lint
+        run: bun run lint
+
       - name: Typecheck
         run: bun run typecheck
 

.github/workflows/pr-ci.yml

@@ -36,6 +36,9 @@ jobs:
       - name: Format check
         run: bun run format:check
 
+      - name: Lint
+        run: bun run lint
+
       - name: Typecheck
         run: bun run typecheck
 

.lintstagedrc.json

@@ -0,0 +1,4 @@
+{
+  "*.{ts,tsx,js,jsx,mjs,cjs,mts,cts}": ["oxfmt --write", "oxlint --fix --deny-warnings"],
+  "*.{json,jsonc,md,yml,yaml}": "oxfmt --write"
+}

.oxlintrc.json

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "no-control-regex": "off"
+  }
+}

CONTRIBUTING.md

@@ -41,6 +41,15 @@ bun run format
 bun run format:check
 ```
 
+Lint the JS/TS codebase:
+
+```bash
+bun run lint
+bun run lint:fix
+```
+
+`bun install` also installs a local `pre-commit` hook that runs `lint-staged`, so staged JS/TS files are auto-formatted and linted before commit.
+
 Build and verify the npm package:
 
 ```bash

bun.lock

@@ -45,6 +45,9 @@
     "typecheck": "tsc --noEmit",
     "format": "oxfmt --write .",
     "format:check": "oxfmt --check .",
+    "lint": "oxlint . --deny-warnings",
+    "lint:fix": "oxlint . --fix",
+    "prepare": "simple-git-hooks",
     "test": "bun test",
     "test:tty-smoke": "HUNK_RUN_TTY_SMOKE=1 bun test test/tty-render-smoke.test.ts",
     "check:pack": "bun run ./scripts/check-pack.ts",
@@ -69,9 +72,15 @@
   "devDependencies": {
     "@types/bun": "latest",
     "@types/react": "^19.2.14",
+    "lint-staged": "^16.4.0",
     "oxfmt": "^0.41.0",
+    "oxlint": "^1.56.0",
+    "simple-git-hooks": "^2.13.1",
     "typescript": "^5.9.3"
   },
+  "simple-git-hooks": {
+    "pre-commit": "bunx lint-staged"
+  },
   "engines": {
     "node": ">=18"
   },

package.json

@@ -111,6 +111,6 @@ for (const directory of directories) {
 
 console.log(
   options.dryRun
-    ? `Completed npm publish dry-run for staged prebuilt packages with dist-tag \"${options.npmTag}\".`
-    : `Published staged prebuilt packages to npm with dist-tag \"${options.npmTag}\".`,
+    ? `Completed npm publish dry-run for staged prebuilt packages with dist-tag "${options.npmTag}".`
+    : `Published staged prebuilt packages to npm with dist-tag "${options.npmTag}".`,
 );

scripts/publish-prebuilt-npm.ts

@@ -2,15 +2,6 @@ import fs from "node:fs";
 import { dirname, join, resolve } from "node:path";
 import type { CliInput, CommonOptions, LayoutMode, PersistedViewPreferences } from "./types";
 
-const CONFIG_SECTION_NAMES = [
-  "pager",
-  "git",
-  "diff",
-  "show",
-  "stash-show",
-  "patch",
-  "difftool",
-] as const;
 const DEFAULT_VIEW_PREFERENCES: PersistedViewPreferences = {
   mode: "auto",
   showLineNumbers: true,

src/core/config.ts

@@ -7,14 +7,12 @@ import type {
   HunkSessionRegistration,
   HunkSessionSnapshot,
   ListedSession,
-  ListCommentsToolInput,
   NavigateToHunkToolInput,
   NavigatedSelectionResult,
   RemoveCommentToolInput,
   RemovedCommentResult,
   SelectedSessionContext,
   SessionCommandResult,
-  SessionLiveCommentSummary,
   SessionServerMessage,
   SessionTargetInput,
 } from "./types";