@howells/husky 0.1.0 → 0.1.2

package/README.md

@@ -18,7 +18,7 @@ In `package.json`:
     "prepare": "howells-husky"
   },
   "lint-staged": {
-    "*.{js,ts,jsx,tsx,json,jsonc,css}": "howells-format"
+    "*.{js,ts,jsx,tsx,json,jsonc,css}": "howells-ox-fix"
   }
 }
 ```
@@ -29,7 +29,9 @@ That's it. On `pnpm install`, the hooks are installed automatically.
 
 ### Pre-commit
 
-Runs `pnpm lint-staged` — formats staged files with `howells-format`.
+Runs `pnpm lint-staged` — formats staged files with the configured Howells formatter.
+Use `howells-ox-fix` for projects on the Ox lint path. `howells-format` remains supported
+for older projects.
 
 ### Pre-push
 
@@ -41,7 +43,7 @@ Your `package.json` must have:
 
 - `"typecheck"` script (e.g. `tsc --noEmit` or `turbo run typecheck`)
 - `"lint"` script (e.g. `howells-lint` or `turbo run lint`)
-- `"lint-staged"` config using `howells-format`
+- `"lint-staged"` config using `howells-ox-fix` or `howells-format`
 
 ## Why a package?
 

package/bin/howells-husky.mjs

@@ -16,13 +16,46 @@
  */
 
 import { spawnSync } from "node:child_process";
-import { copyFileSync, existsSync, mkdirSync, readFileSync, chmodSync } from "node:fs";
+import {
+  copyFileSync,
+  existsSync,
+  mkdirSync,
+  readFileSync,
+  chmodSync,
+} from "node:fs";
 import { dirname, join, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 
-const __dirname = dirname(fileURLToPath(import.meta.url));
+const __dirname = import.meta.dirname;
 const packageRoot = resolve(__dirname, "..");
 const projectRoot = process.cwd();
+// `howells-fix` is the current canonical @howells/lint fixer; `howells-ox-fix`
+// and `howells-format` are earlier names still in use by repos mid-migration.
+// Accept all three so a correct lint-staged config never draws a false warning.
+const lintStagedFormatterCommands = [
+  "howells-fix",
+  "howells-ox-fix",
+  "howells-format",
+];
+const recommendedLintStagedCommand = "howells-fix";
+
+function lintStagedCommandValues(config) {
+  return Object.values(config).flatMap((value) => {
+    if (typeof value === "string") {
+      return [value];
+    }
+    if (Array.isArray(value)) {
+      return value.filter((item) => typeof item === "string");
+    }
+    return [];
+  });
+}
+
+function usesSupportedFormatter(command) {
+  return lintStagedFormatterCommands.some((formatter) =>
+    command.includes(formatter)
+  );
+}
 
 // Skip in CI environments — hooks aren't needed there
 if (process.env.CI === "true" || process.env.VERCEL === "1") {
@@ -38,19 +71,22 @@ if (!existsSync(join(projectRoot, ".git"))) {
 const huskyBin = resolve(packageRoot, "node_modules", ".bin", "husky");
 const huskyResult = spawnSync(huskyBin, [], {
   cwd: projectRoot,
-  stdio: "inherit",
   env: process.env,
+  stdio: "inherit",
 });
 
 if (huskyResult.error) {
   // Fallback: try resolving husky from the project's node_modules
   const fallbackResult = spawnSync("npx", ["husky"], {
     cwd: projectRoot,
-    stdio: "inherit",
     env: process.env,
+    stdio: "inherit",
   });
 
-  if (fallbackResult.error || (fallbackResult.status !== null && fallbackResult.status !== 0)) {
+  if (
+    fallbackResult.error ||
+    (fallbackResult.status !== null && fallbackResult.status !== 0)
+  ) {
     console.error("[@howells/husky] Failed to initialise husky");
     process.exit(1);
   }
@@ -75,30 +111,28 @@ for (const hook of hooks) {
 // Step 3: Validate lint-staged config
 const packageJsonPath = join(projectRoot, "package.json");
 if (existsSync(packageJsonPath)) {
-  const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf8"));
+  const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
 
   if (!packageJson["lint-staged"]) {
     console.warn(
-      '[@howells/husky] Warning: no "lint-staged" config found in package.json.',
+      '[@howells/husky] Warning: no "lint-staged" config found in package.json.'
     );
     console.warn(
-      '  Add: "lint-staged": { "*.{js,ts,jsx,tsx,json,jsonc,css}": "howells-format" }',
+      `  Add: "lint-staged": { "*.{js,ts,jsx,tsx,json,jsonc,css}": "${recommendedLintStagedCommand}" }`
     );
   }
 
-  // Check that the lint-staged command uses howells-format
+  // Check that the lint-staged command uses a supported Howells formatter.
   const lsConfig = packageJson["lint-staged"];
   if (lsConfig) {
-    const commands = Object.values(lsConfig);
-    const usesHowells = commands.some(
-      (cmd) => typeof cmd === "string" && cmd.includes("howells-format"),
-    );
+    const commands = lintStagedCommandValues(lsConfig);
+    const usesHowells = commands.some(usesSupportedFormatter);
     if (!usesHowells) {
       console.warn(
-        "[@howells/husky] Warning: lint-staged should use howells-format.",
+        "[@howells/husky] Warning: lint-staged should use a supported Howells formatter."
       );
       console.warn(
-        '  Expected: "*.{js,ts,jsx,tsx,json,jsonc,css}": "howells-format"',
+        `  Expected: "*.{js,ts,jsx,tsx,json,jsonc,css}": "${recommendedLintStagedCommand}"`
       );
     }
   }
@@ -107,12 +141,12 @@ if (existsSync(packageJsonPath)) {
   const scripts = packageJson.scripts || {};
   if (!scripts.typecheck) {
     console.warn(
-      '[@howells/husky] Warning: no "typecheck" script found. Pre-push hook requires it.',
+      '[@howells/husky] Warning: no "typecheck" script found. Pre-push hook requires it.'
     );
   }
   if (!scripts.lint) {
     console.warn(
-      '[@howells/husky] Warning: no "lint" script found. Pre-push hook requires it.',
+      '[@howells/husky] Warning: no "lint" script found. Pre-push hook requires it.'
     );
   }
 }

package/package.json

@@ -1,21 +1,29 @@
 {
   "name": "@howells/husky",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Standardised git hooks for Howells projects. Immutable pre-commit and pre-push configuration.",
   "license": "MIT",
+  "bin": {
+    "howells-husky": "bin/howells-husky.mjs"
+  },
   "files": [
     "bin/*.mjs",
     "hooks/*",
     "README.md"
   ],
-  "bin": {
-    "howells-husky": "bin/howells-husky.mjs"
+  "exports": {
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "lint": "howells-ox-check --config=oxlint.config.ts package.json bin hooks README.md oxlint.config.ts oxfmt.config.ts",
+    "lint:fix": "howells-ox-fix --config=oxlint.config.ts package.json bin hooks README.md oxlint.config.ts oxfmt.config.ts",
+    "format": "howells-oxfmt --write package.json bin hooks README.md oxlint.config.ts oxfmt.config.ts README.md"
   },
   "dependencies": {
     "husky": "^9.1.7",
     "lint-staged": "^16.4.0"
   },
-  "exports": {
-    "./package.json": "./package.json"
+  "devDependencies": {
+    "@howells/lint": "^0.2.1"
   }
 }