@verndale/ai-commit 2.5.1 → 2.5.3

package/README.md

@@ -42,12 +42,12 @@ pnpm exec ai-commit init
 | Action | Detail |
 | --- | --- |
 | Roots | **Package root** — walks up from the current directory toward the git root and uses the first directory that has **`package.json`** (if none, uses cwd). **Git root** — `git rev-parse --show-toplevel`. Env files and **`package.json`** use the package root; hooks use the git root. |
-| Env files | Merges **`.env`** and the **example env file** (see below). Keys already set in **`.env.local`** are treated as satisfied for the **`.env`** merge only (same as runtime load order). Init does not write **`.env.local`**. |
+| Env files | Merges ai-commit keys into **`.env.local`** when that file exists; otherwise into **`.env`** (creates **`.env`** from the bundled template if missing). **`.env`** is not used when **`.env.local`** is present. Also merges the **example env file** (see below). **`--force`** does not wholesale-replace **`.env.local`** (append / docs only). |
 | Example file | Uses **`.env.example`** if it exists; else **`.env-example`** if it exists; else creates **`.env.example`**. If both dot forms exist, init uses **`.env.example`** and prints a warning. The **bundled** template in the package remains [`.env-example`](.env-example) (hyphen). |
 | Husky | Runs **`npx husky@9 init`** at the **git root** if **`husky.sh`** is missing under the resolved hooks directory. |
 | Hooks directory | **`core.hooksPath`** relative to the git root when set; otherwise **`<git-root>/.husky`**. Falls back to **`.husky`** at the git root with a warning if the config path is invalid or outside the repo. |
 | `package.json` | Adds missing **`commit`**, **`prepare`**, **`husky`** entries when **`package.json`** exists at the package root. |
-| Hooks | Writes **`prepare-commit-msg`** and **`commit-msg`** in the hooks directory. If package root ≠ git root, each hook **`cd`s** into the package directory before **`pnpm exec ai-commit`** / **`npx`**. |
+| Hooks | Writes **`prepare-commit-msg`** and **`commit-msg`** in the hooks directory. If package root ≠ git root, each hook **`cd`s** into the package directory before **`pnpm exec ai-commit`** / **`npx`**. Removes a **stock** **`.husky/pre-commit`** that is only **`npm`**/**`pnpm`**/**`yarn`** **`test`** (Husky’s **`init`** default) so that hook does not block commits; custom **pre-commit** files are kept. |
 
 If **`package.json`** changed, run **`pnpm install`** (or `npm install`) again.
 
@@ -64,7 +64,7 @@ Set **`OPENAI_API_KEY`** in **`.env`** and/or **`.env.local`**. Duplicate keys:
 | *(none)* | Full setup: env files + Husky + hooks + `package.json` updates (when applicable). |
 | `--env-only` | You only want env / example-file updates—no Git hooks. |
 | `--husky` | Hooks + Husky only; skips **`package.json`** changes. Combine with **`--workspace`** if you need **`package.json`** merged again. |
-| `--force` | Replace **`.env`** and the resolved example file (see table above) with the bundled template **(destructive)** and/or overwrite existing Husky hook files. |
+| `--force` | Replace **`.env`** (when that is the merge target) and the resolved example file with the bundled template **(destructive)** and/or overwrite existing Husky hook files. Does **not** wholesale-replace **`.env.local`** (merge/append only). |
 
 **Edge cases**
 
@@ -72,9 +72,9 @@ Set **`OPENAI_API_KEY`** in **`.env`** and/or **`.env.local`**. Duplicate keys:
 | --- | --- |
 | Not in a git repo | Init updates env files only (under cwd) and reports that Git/Husky were skipped. |
 | Monorepo (package not at git root) | Run **`ai-commit init`** from the app folder that has **`package.json`** and the dependency. Hooks live at the repo root; hook scripts change into the package directory before running **`ai-commit`**. |
-| **`.env.local`** | **`OPENAI_API_KEY`** / **`COMMIT_AI_MODEL`** there count as already present when merging **`.env`**, so init will not add duplicate placeholders for those keys. |
+| **`.env.local`** | If this file exists, init merges ai-commit keys **only** here and does not create or update **`.env`** (see [Env files](#2-run-init) row). |
 | Bundled vs consumer example name | The npm package ships **`.env-example`** (hyphen) as the template source; the file init merges into on disk follows **`.env.example`** first, then **`.env-example`**, then default **`.env.example`**. |
-| Without **`--force`** | Missing example file is created (**`.env.example`** when neither exists); otherwise missing ai-commit keys are **appended** to **`.env`** and the example file without wiping them. |
+| Without **`--force`** | Missing example file is created (**`.env.example`** when neither dot form exists); otherwise missing ai-commit keys are **appended** to the env merge target (**`.env.local`** or **`.env`**) and the example file without wiping them. |
 
 ---
 
@@ -129,7 +129,7 @@ pnpm exec ai-commit init --force
 | Command | Purpose |
 | --- | --- |
 | **`ai-commit run`** | Build a message from the staged diff and run **`git commit`**. |
-| **`ai-commit init`** | Env merge (**`.env`** + resolved example file; **`.env.local`** satisfies keys for the **`.env`** merge only), Husky at git root if needed, **`package.json`** at package root, hooks in **`core.hooksPath`** or **`.husky`**. See [flags](#init-flags-and-shortcuts). |
+| **`ai-commit init`** | Env merge into **`.env.local`** or **`.env`** (see [Env files](#2-run-init)) plus resolved example file; Husky at git root if needed, **`package.json`** at package root, hooks in **`core.hooksPath`** or **`.husky`**. See [flags](#init-flags-and-shortcuts). |
 | **`ai-commit prepare-commit-msg <file> [source]`** | Hook: fill an empty message; skips `merge` / `squash`. |
 | **`ai-commit lint --edit <file>`** | Hook: commitlint with this package’s default config. |
 
@@ -171,6 +171,8 @@ pnpm exec ai-commit lint --edit "$1"
 
 Hooks from **`init`** use **`pnpm exec ai-commit`** when **`pnpm-lock.yaml`** exists in the **package root**; otherwise **`npx --no ai-commit`**. In a monorepo, generated hooks **`cd`** from the git root into that package directory first. Edit the files if you use another runner.
 
+**`pre-commit`:** Husky’s **`init`** often adds **`.husky/pre-commit`** with only **`pnpm test`** (or **`npm test`** / **`yarn test`**). That can block **`git commit`** when tests fail. On each **`ai-commit init`**, **`init`** removes **only** that stock one-liner (or the same command behind a minimal **`husky.sh`** wrapper). If you add other lines (e.g. **lint-staged**), the file is left unchanged. Add your own **pre-commit** or rely on **CI** if you still want tests on every commit.
+
 **Already using Husky?** If **`.husky/_/husky.sh`** exists, **`init`** does not run **`npx husky@9 init`**. **`package.json`** is only amended for missing **`commit`**, **`prepare`**, or **`devDependencies.husky`**. Existing **`.husky/prepare-commit-msg`** and **`.husky/commit-msg`** are not overwritten unless you use **`ai-commit init --force`**.
 
 ---

package/bin/cli.js

@@ -16,12 +16,13 @@ const {
   hasStagedChanges,
   commitFromFile,
 } = require("../lib/core/git.js");
-const { mergeAiCommitEnvFile, parseDotenvAssignedKeys } = require("../lib/init-env.js");
+const { mergeAiCommitEnvFile } = require("../lib/init-env.js");
 const { resolveEnvExamplePath, findPackageRoot } = require("../lib/init-paths.js");
 const {
   detectPackageExec,
   hookScript,
   runHuskyInit,
+  removeHuskyDefaultPreCommitIfPresent,
   mergePackageJsonForAiCommit,
   warnIfPrepareMissingHusky,
 } = require("../lib/init-workspace.js");
@@ -45,7 +46,7 @@ Usage:
 
 Commands:
   run                  Generate a message from the staged diff and run git commit.
-  init                 Merge env, then Husky + package.json + hooks (from a git repo). \`--env-only\` stops after env files. \`--husky\` skips package.json. \`--force\` replaces \`.env\` / example env file / hooks (example path: existing \`.env.example\` or \`.env-example\`, default \`.env.example\`).
+  init                 Merge env, then Husky + package.json + hooks (from a git repo). \`--env-only\` stops after env files. \`--husky\` skips package.json. Env merge targets \`.env.local\` when that file exists, else \`.env\`. \`--force\` replaces \`.env\` / example file / hooks (not a wholesale replace of \`.env.local\`).
   prepare-commit-msg   Git hook: fill an empty commit message file (merge/squash skipped).
   lint                 Run commitlint with the package default config (for commit-msg hook).
 
@@ -99,14 +100,8 @@ function cmdInit(argv) {
   const gitRoot = inGit ? getGitRoot(cwd) : null;
   const packageRoot = findPackageRoot(cwd, gitRoot);
 
-  const extraAssignedKeys = new Set();
   const envLocalPath = path.join(packageRoot, ".env.local");
-  if (fs.existsSync(envLocalPath)) {
-    const localContent = fs.readFileSync(envLocalPath, "utf8");
-    for (const k of parseDotenvAssignedKeys(localContent)) {
-      extraAssignedKeys.add(k);
-    }
-  }
+  const envPath = path.join(packageRoot, ".env");
 
   if (
     inGit &&
@@ -118,12 +113,21 @@ function cmdInit(argv) {
     );
   }
 
-  const envDest = path.join(packageRoot, ".env");
-  const envResult = mergeAiCommitEnvFile(envDest, bundledExamplePath, {
-    force,
-    extraAssignedKeys,
+  /** When `.env.local` exists it is the only env merge target (no `.env` created or updated). */
+  const envMergePath = fs.existsSync(envLocalPath) ? envLocalPath : envPath;
+  const mergeEnvIntoLocal =
+    path.resolve(envMergePath) === path.resolve(envLocalPath);
+  /** Never `--force`-replace `.env.local` with the bundled template (would wipe secrets). */
+  const envForce = force && !mergeEnvIntoLocal;
+  if (force && mergeEnvIntoLocal) {
+    process.stderr.write(
+      "note: --force does not replace .env.local with the bundled template; ai-commit keys are merged (append / docs) only.\n",
+    );
+  }
+  const envResult = mergeAiCommitEnvFile(envMergePath, bundledExamplePath, {
+    force: envForce,
   });
-  const envRel = path.relative(cwd, envDest) || ".env";
+  const envRel = path.relative(cwd, envMergePath) || path.basename(envMergePath);
   switch (envResult.kind) {
     case "replaced":
       process.stdout.write(`Replaced ${envRel} with bundled template (--force).\n`);
@@ -136,7 +140,9 @@ function cmdInit(argv) {
       break;
     case "unchanged":
       process.stdout.write(
-        `No missing @verndale/ai-commit keys in ${envRel}; left unchanged. Use --force to replace the file with the bundled template.\n`,
+        mergeEnvIntoLocal
+          ? `No missing @verndale/ai-commit keys in ${envRel}; left unchanged.\n`
+          : `No missing @verndale/ai-commit keys in ${envRel}; left unchanged. Use --force to replace the file with the bundled template.\n`,
       );
       break;
     default:
@@ -224,6 +230,13 @@ function cmdInit(argv) {
     fs.mkdirSync(huskyDir, { recursive: true });
   }
 
+  for (const abs of removeHuskyDefaultPreCommitIfPresent(gitRoot, huskyDir)) {
+    const rel = path.relative(cwd, abs) || path.basename(abs);
+    process.stdout.write(
+      `Removed Husky default pre-commit (${rel}); add your own .husky/pre-commit or use CI if you want tests on every commit.\n`,
+    );
+  }
+
   const execPrefix = detectPackageExec(packageRoot);
   const preparePath = path.join(huskyDir, "prepare-commit-msg");
   const commitMsgPath = path.join(huskyDir, "commit-msg");

package/lib/init-workspace.js

@@ -61,6 +61,92 @@ function runHuskyInit(cwd) {
   return { ok: status === 0, status };
 }
 
+/**
+ * Husky `init` writes `.husky/pre-commit` with only `(npm|pnpm|yarn) test` (see husky bin.js).
+ * That often breaks commits when tests fail or are slow. Match that template and optional
+ * minimal shebang + husky.sh wrapper so we do not delete custom hooks.
+ * @param {string} raw
+ * @returns {boolean}
+ */
+function isHuskyDefaultPreCommitContent(raw) {
+  const text = raw.replace(/\r\n/g, "\n").trim();
+  const nonEmpty = text
+    .split("\n")
+    .map((l) => l.trim())
+    .filter((l) => {
+      if (l.length === 0) {
+        return false;
+      }
+      if (/^#!\//.test(l)) {
+        return true;
+      }
+      return !/^\s*#/.test(l);
+    });
+  if (nonEmpty.length === 0) {
+    return false;
+  }
+  if (nonEmpty.length === 1) {
+    return /^(npm|pnpm|yarn)\s+test$/i.test(nonEmpty[0]);
+  }
+  const last = nonEmpty[nonEmpty.length - 1];
+  if (!/^(npm|pnpm|yarn)\s+test$/i.test(last)) {
+    return false;
+  }
+  const head = nonEmpty.slice(0, -1);
+  const shebang = /^#!\/usr\/bin\/env\s+sh$/.test(head[0]);
+  const huskySource = head.some((l) => {
+    if (/\bhusky\.sh\b/.test(l)) {
+      return true;
+    }
+    if (l.includes("$(dirname") && (l.includes("_/husky.sh") || l.includes('_/h"'))) {
+      return true;
+    }
+    return false;
+  });
+  return shebang && huskySource && head.length <= 3;
+}
+
+/**
+ * Remove Husky’s stock `pre-commit` (e.g. `pnpm test`) from common paths. Custom hooks are kept.
+ * @param {string} gitRoot
+ * @param {string} huskyDir Resolved hooks directory (from `core.hooksPath` or `.husky`)
+ * @returns {string[]} Absolute paths of removed files
+ */
+function removeHuskyDefaultPreCommitIfPresent(gitRoot, huskyDir) {
+  const candidates = [
+    path.join(huskyDir, "pre-commit"),
+    path.join(gitRoot, ".husky", "pre-commit"),
+  ];
+  const seen = new Set();
+  const removed = [];
+  for (const filePath of candidates) {
+    const abs = path.resolve(filePath);
+    if (seen.has(abs)) {
+      continue;
+    }
+    seen.add(abs);
+    if (!fs.existsSync(abs)) {
+      continue;
+    }
+    let raw;
+    try {
+      raw = fs.readFileSync(abs, "utf8");
+    } catch {
+      continue;
+    }
+    if (!isHuskyDefaultPreCommitContent(raw)) {
+      continue;
+    }
+    try {
+      fs.unlinkSync(abs);
+      removed.push(abs);
+    } catch {
+      // ignore
+    }
+  }
+  return removed;
+}
+
 /**
  * Ensure `commit` script, `prepare` for husky, and `devDependencies.husky`. Does not remove existing scripts.
  * @param {string} packageJsonPath
@@ -117,6 +203,7 @@ module.exports = {
   detectPackageExec,
   hookScript,
   runHuskyInit,
+  removeHuskyDefaultPreCommitIfPresent,
   mergePackageJsonForAiCommit,
   warnIfPrepareMissingHusky,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verndale/ai-commit",
-  "version": "2.5.1",
+  "version": "2.5.3",
   "description": "AI-assisted conventional commits with bundled commitlint — one install, aligned rules",
   "license": "MIT",
   "author": "Verndale",