@howells/husky 0.1.1 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel Howells
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -18,7 +18,7 @@ In `package.json`:
     "prepare": "howells-husky"
   },
   "lint-staged": {
-    "*.{js,ts,jsx,tsx,json,jsonc,css}": "howells-ox-fix"
+    "*.{js,ts,jsx,tsx,json,jsonc,css}": "howells-fix"
   }
 }
 ```
@@ -29,9 +29,7 @@ That's it. On `pnpm install`, the hooks are installed automatically.
 
 ### Pre-commit
 
-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.
+Runs `pnpm lint-staged` — formats staged files with the configured Howells formatter. Use `howells-fix`. The older names `howells-ox-fix` and `howells-format` are still accepted (legacy) for projects mid-migration.
 
 ### Pre-push
 
@@ -43,7 +41,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-ox-fix` or `howells-format`
+- `"lint-staged"` config using `howells-fix` (`howells-ox-fix` and `howells-format` still accepted, legacy)
 
 ## Why a package?
 

package/bin/detect.mjs

@@ -0,0 +1,62 @@
+/**
+ * Pure formatter-detection helpers for @howells/husky.
+ *
+ * Kept free of side effects so the install-time bin can stay a thin shell
+ * around behaviour that is unit-testable in isolation.
+ */
+
+// `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.
+export const lintStagedFormatterCommands = [
+  "howells-fix",
+  "howells-ox-fix",
+  "howells-format",
+];
+
+export const recommendedLintStagedCommand = "howells-fix";
+
+/**
+ * Flatten a lint-staged config object into the list of command strings it runs.
+ * Values may be a single command string or an array of them.
+ */
+export 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 [];
+  });
+}
+
+/**
+ * True when a single lint-staged command invokes a supported Howells formatter.
+ */
+export function usesSupportedFormatter(command) {
+  return lintStagedFormatterCommands.some((formatter) =>
+    command.includes(formatter)
+  );
+}
+
+/**
+ * Decide whether the primary `husky` spawn failed to launch and we should
+ * fall back to `npx husky`. A spawn that launched but exited non-zero is not a
+ * launch failure — only a spawn `error` (e.g. ENOENT) warrants the fallback.
+ */
+export function shouldUseNpxFallback(primaryResult) {
+  return Boolean(primaryResult.error);
+}
+
+/**
+ * True when the npx fallback itself failed — either it could not launch, or it
+ * launched and exited with a non-zero status.
+ */
+export function fallbackFailed(fallbackResult) {
+  return Boolean(
+    fallbackResult.error ||
+    (fallbackResult.status !== null && fallbackResult.status !== 0)
+  );
+}

package/bin/howells-husky.mjs

@@ -16,31 +16,26 @@
  */
 
 import { spawnSync } from "node:child_process";
-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 packageRoot = resolve(__dirname, "..");
+import {
+  copyFileSync,
+  existsSync,
+  mkdirSync,
+  readFileSync,
+  chmodSync,
+} from "node:fs";
+import path from "node:path";
+
+import {
+  fallbackFailed,
+  lintStagedCommandValues,
+  recommendedLintStagedCommand,
+  shouldUseNpxFallback,
+  usesSupportedFormatter,
+} from "./detect.mjs";
+
+const scriptDir = import.meta.dirname;
+const packageRoot = path.resolve(scriptDir, "..");
 const projectRoot = process.cwd();
-const lintStagedFormatterCommands = ["howells-format", "howells-ox-fix"];
-const recommendedLintStagedCommand = "howells-ox-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") {
@@ -48,59 +43,59 @@ if (process.env.CI === "true" || process.env.VERCEL === "1") {
 }
 
 // Skip if not in a git repo (e.g. during npm pack)
-if (!existsSync(join(projectRoot, ".git"))) {
+if (!existsSync(path.join(projectRoot, ".git"))) {
   process.exit(0);
 }
 
 // Step 1: Run husky to initialise .husky/ directory
-const huskyBin = resolve(packageRoot, "node_modules", ".bin", "husky");
+const huskyBin = path.resolve(packageRoot, "node_modules", ".bin", "husky");
 const huskyResult = spawnSync(huskyBin, [], {
   cwd: projectRoot,
-  stdio: "inherit",
   env: process.env,
+  stdio: "inherit",
 });
 
-if (huskyResult.error) {
+if (shouldUseNpxFallback(huskyResult)) {
   // 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 (fallbackFailed(fallbackResult)) {
     console.error("[@howells/husky] Failed to initialise husky");
     process.exit(1);
   }
 }
 
 // Step 2: Copy canonical hook scripts
-const huskyDir = join(projectRoot, ".husky");
+const huskyDir = path.join(projectRoot, ".husky");
 if (!existsSync(huskyDir)) {
   mkdirSync(huskyDir, { recursive: true });
 }
 
 const hooks = ["pre-commit", "pre-push"];
-const hooksDir = join(packageRoot, "hooks");
+const hooksDir = path.join(packageRoot, "hooks");
 
 for (const hook of hooks) {
-  const source = join(hooksDir, hook);
-  const dest = join(huskyDir, hook);
+  const source = path.join(hooksDir, hook);
+  const dest = path.join(huskyDir, hook);
   copyFileSync(source, dest);
   chmodSync(dest, 0o755);
 }
 
 // Step 3: Validate lint-staged config
-const packageJsonPath = join(projectRoot, "package.json");
+const packageJsonPath = path.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}": "${recommendedLintStagedCommand}" }`,
+      `  Add: "lint-staged": { "*.{js,ts,jsx,tsx,json,jsonc,css}": "${recommendedLintStagedCommand}" }`
     );
   }
 
@@ -111,10 +106,10 @@ if (existsSync(packageJsonPath)) {
     const usesHowells = commands.some(usesSupportedFormatter);
     if (!usesHowells) {
       console.warn(
-        "[@howells/husky] Warning: lint-staged should use a supported Howells formatter.",
+        "[@howells/husky] Warning: lint-staged should use a supported Howells formatter."
       );
       console.warn(
-        `  Expected: "*.{js,ts,jsx,tsx,json,jsonc,css}": "${recommendedLintStagedCommand}"`,
+        `  Expected: "*.{js,ts,jsx,tsx,json,jsonc,css}": "${recommendedLintStagedCommand}"`
       );
     }
   }
@@ -123,12 +118,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,41 @@
 {
   "name": "@howells/husky",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Standardised git hooks for Howells projects. Immutable pre-commit and pre-push configuration.",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/commoninstruments/husky.git"
+  },
+  "bin": {
+    "howells-husky": "bin/howells-husky.mjs"
+  },
   "files": [
-    "bin/*.mjs",
+    "bin/detect.mjs",
+    "bin/howells-husky.mjs",
     "hooks/*",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
-  "bin": {
-    "howells-husky": "bin/howells-husky.mjs"
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "lint": "howells-check --config=oxlint.config.ts package.json bin hooks README.md oxlint.config.ts oxfmt.config.ts",
+    "lint:fix": "howells-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",
+    "test": "node --test bin/detect.test.mjs"
   },
   "dependencies": {
     "husky": "^9.1.7",
     "lint-staged": "^16.4.0"
   },
-  "exports": {
-    "./package.json": "./package.json"
-  }
+  "devDependencies": {
+    "@howells/lint": "^1.1.0"
+  },
+  "engines": {
+    "node": ">=24.15.0"
+  },
+  "packageManager": "pnpm@11.11.0"
 }