@webywz/vibe-commit 0.1.3 → 0.1.5

package/README.md

@@ -61,6 +61,10 @@ vibe-commit install                 # optional prepare-commit-msg hook
 | `uninstall [--path]` | Remove the managed hook · 卸载钩子 |
 | `-h` / `-v` | Help / version · 帮助 / 版本 |
 
+Offline heuristic also marks breaking when the staged diff removes public `export`s or bumps a `package.json` major version, and always attaches a `BREAKING CHANGE:` footer when `breaking` is true (so `--json` body matches the formatted message). Dry-run prints a one-line cause; `--json` may include `breakingReason`.
+
+离线启发式在删掉公开 `export`、或 `package.json` 主版本升级时也会标 breaking；只要 `breaking` 为真就会补上 `BREAKING CHANGE:` footer（`--json` 的 body 与格式化输出一致）。干跑会打一行原因；`--json` 可带 `breakingReason`。
+
 **Vibes** · 语气
 
 - **pro** — default. Imperative, review-ready. · 默认：祈使句，可进 review。
@@ -142,7 +146,9 @@ console.log(formatCommit(message));
    - new files / `export function` → `feat`
 3. Optional AI draft with automatic heuristic fallback.
    可选 AI 草稿，失败自动回退启发式。
-4. Managed `prepare-commit-msg` hook via `install` / `uninstall`.
+4. **Breaking** when the diff removes a public `export`, bumps a `package.json` major, adds a `BREAKING CHANGE:` footer, or you pass `--breaking`. Dry-run shows why; `--json` may include `breakingReason`.
+   **破坏性变更**：删公开 `export`、主版本升级、diff 里已有 footer，或传 `--breaking`。干跑说明原因；`--json` 可带 `breakingReason`。
+5. Managed `prepare-commit-msg` hook via `install` / `uninstall`.
    通过 `install` / `uninstall` 管理 `prepare-commit-msg` 钩子。
 
 ---

package/dist/git.js

@@ -13,7 +13,8 @@ export function inspectStaged(cwd = process.cwd()) {
     const raw = git(["diff", "--cached", "-M", "--unified=3"], cwd);
     const diff = assembleDiff(nameStatus, numstat, raw);
     if (diff.files.length === 0) {
-        throw new GitError("No staged changes. Stage files first: git add -p  (or git add <path>)");
+        throw new GitError("No staged changes. Stage files first: git add -p (or git add <path>)\n" +
+            "暂存区为空。请先暂存：git add -p（或 git add <path>）");
     }
     return diff;
 }

package/dist/heuristic.d.ts

@@ -4,6 +4,8 @@ export interface HeuristicInput {
     type?: CommitType;
     scope?: string;
     vibe: Vibe;
+    /** Force breaking: true (ORs with inferBreaking). */
+    breaking?: boolean;
 }
 export declare function proposeHeuristic(input: HeuristicInput): ProposedMessage;
 export declare function inferType(diff: StagedDiff): CommitType;
@@ -11,5 +13,18 @@ export declare function primaryRole(path: string): CommitType;
 export declare function classifyPath(path: string): CommitType[];
 export declare function inferScope(files: StagedFile[]): string | undefined;
 export declare function inferSubject(diff: StagedDiff, type: CommitType, scope?: string): string;
+export type BreakingKind = "export-removed" | "major-bump" | "footer" | "forced";
+export declare function inferBreaking(diff: StagedDiff): boolean;
+/** Why breaking was set — heuristic signal first, then --breaking. */
+export declare function detectBreakingKind(diff: StagedDiff, forced?: boolean): BreakingKind | undefined;
+/** One-line bilingual cause for dry-run / --json.breakingReason. */
+export declare function formatBreakingReason(kind: BreakingKind): string;
+/** Detail text for the BREAKING CHANGE footer, or undefined when not inferred. */
+export declare function breakingFooterDetail(diff: StagedDiff): string | undefined;
+/**
+ * Ensure body carries a conventional BREAKING CHANGE footer when breaking.
+ * Skips if the body already mentions one. Uses subject as a last-resort reason.
+ */
+export declare function ensureBreakingFooter(message: ProposedMessage, reason?: string): ProposedMessage;
 export declare function collectAddedIdentifiers(hunks: DiffHunk[]): string[];
 export declare function stem(path: string): string;

package/dist/heuristic.js

@@ -28,9 +28,16 @@ export function proposeHeuristic(input) {
     const scope = input.scope ?? inferScope(diff.files);
     const subject = inferSubject(diff, type, scope);
     const body = inferBody(diff, type);
-    const breaking = inferBreaking(diff);
+    const forced = Boolean(input.breaking);
+    const kind = detectBreakingKind(diff, forced);
+    const breaking = Boolean(kind);
     const styled = applyVibe({ type, scope, subject, body, breaking }, vibe);
-    return { ...styled, engine: "heuristic" };
+    const message = {
+        ...styled,
+        engine: "heuristic",
+        breakingReason: kind ? formatBreakingReason(kind) : undefined,
+    };
+    return ensureBreakingFooter(message, breakingFooterDetail(diff));
 }
 export function inferType(diff) {
     const files = diff.files;
@@ -216,8 +223,158 @@ function inferBody(diff, type) {
             : "Changed files:";
     return `${lead}\n${listed}${extra}`;
 }
-function inferBreaking(diff) {
-    return diff.hunks.some((hunk) => hunk.lines.some((line) => /^\+\s*BREAKING CHANGE:/i.test(line)));
+export function inferBreaking(diff) {
+    return Boolean(detectBreakingKind(diff, false));
+}
+/** Why breaking was set — heuristic signal first, then --breaking. */
+export function detectBreakingKind(diff, forced = false) {
+    if (detectBreakingFooter(diff))
+        return "footer";
+    if (detectRemovedExports(diff).length > 0)
+        return "export-removed";
+    if (detectMajorVersionBump(diff))
+        return "major-bump";
+    if (forced)
+        return "forced";
+    return undefined;
+}
+/** One-line bilingual cause for dry-run / --json.breakingReason. */
+export function formatBreakingReason(kind) {
+    switch (kind) {
+        case "export-removed":
+            return "export removed · 公开 export 删除";
+        case "major-bump":
+            return "major bump · package.json 主版本升级";
+        case "footer":
+            return "BREAKING CHANGE footer in diff";
+        case "forced":
+            return "forced via --breaking · --breaking 强制";
+    }
+}
+/** Detail text for the BREAKING CHANGE footer, or undefined when not inferred. */
+export function breakingFooterDetail(diff) {
+    const footer = detectBreakingFooter(diff);
+    if (footer)
+        return footer;
+    const removed = detectRemovedExports(diff);
+    if (removed.length > 0) {
+        const names = removed.slice(0, 3).join(", ");
+        return removed.length === 1
+            ? `remove public export ${names}`
+            : `remove public exports ${names}`;
+    }
+    const bump = detectMajorVersionBump(diff);
+    if (bump)
+        return `bump major version to ${bump.to}`;
+    return undefined;
+}
+/**
+ * Ensure body carries a conventional BREAKING CHANGE footer when breaking.
+ * Skips if the body already mentions one. Uses subject as a last-resort reason.
+ */
+export function ensureBreakingFooter(message, reason) {
+    if (!message.breaking)
+        return message;
+    const body = message.body?.trim() ?? "";
+    if (/BREAKING CHANGE:/i.test(body)) {
+        return body === (message.body ?? "") ? message : { ...message, body };
+    }
+    const detail = (reason ?? message.subject).replace(/\s+/g, " ").trim() ||
+        "incompatible API change";
+    const footer = `BREAKING CHANGE: ${detail}`;
+    return {
+        ...message,
+        body: body ? `${body}\n\n${footer}` : footer,
+    };
+}
+function detectBreakingFooter(diff) {
+    for (const hunk of diff.hunks) {
+        for (const line of hunk.lines) {
+            const match = line.match(/^\+\s*BREAKING CHANGE:\s*(.+)$/i);
+            if (match?.[1])
+                return match[1].trim();
+        }
+    }
+    // Presence of the token alone still counts as breaking.
+    if (diff.hunks.some((hunk) => hunk.lines.some((line) => /^\+\s*BREAKING CHANGE:/i.test(line)))) {
+        return "incompatible API change";
+    }
+    return undefined;
+}
+const DELETED_EXPORT_RE = /^-\s*export(?:\s+default\b|\s*\{|\s+)/;
+function detectRemovedExports(diff) {
+    const names = [];
+    const seen = new Set();
+    for (const hunk of diff.hunks) {
+        for (const line of hunk.lines) {
+            if (line.startsWith("---"))
+                continue;
+            if (!DELETED_EXPORT_RE.test(line))
+                continue;
+            const name = exportNameFromDeletedLine(line);
+            const key = name ?? line.slice(1).trim();
+            if (seen.has(key))
+                continue;
+            seen.add(key);
+            if (name)
+                names.push(name);
+            else
+                names.push("export");
+        }
+    }
+    return names;
+}
+function exportNameFromDeletedLine(line) {
+    const content = line.slice(1);
+    const named = content.match(/export\s+(?:default\s+)?(?:async\s+)?(?:function|const|let|class|type|interface|enum)\s+([A-Za-z_][\w]*)/);
+    if (named?.[1])
+        return named[1];
+    const braced = content.match(/export\s*\{\s*([^}]+)\s*\}/);
+    if (braced?.[1]) {
+        const first = braced[1].split(",")[0]?.trim().split(/\s+as\s+/i)[0]?.trim();
+        if (first && /^[A-Za-z_][\w]*$/.test(first))
+            return first;
+    }
+    const def = content.match(/export\s+default\s+([A-Za-z_][\w]*)/);
+    if (def?.[1])
+        return def[1];
+    return undefined;
+}
+function detectMajorVersionBump(diff) {
+    for (const hunk of diff.hunks) {
+        if (!/(^|\/)package\.json$/i.test(hunk.path))
+            continue;
+        const removed = [];
+        const added = [];
+        for (const line of hunk.lines) {
+            const rem = line.match(/^-\s*"version"\s*:\s*"([^"]+)"/);
+            const add = line.match(/^\+\s*"version"\s*:\s*"([^"]+)"/);
+            if (rem?.[1])
+                removed.push(rem[1]);
+            if (add?.[1])
+                added.push(add[1]);
+        }
+        for (const from of removed) {
+            for (const to of added) {
+                if (isMajorBump(from, to))
+                    return { from, to };
+            }
+        }
+    }
+    return undefined;
+}
+function isMajorBump(from, to) {
+    const a = parseSemverMajor(from);
+    const b = parseSemverMajor(to);
+    if (a === undefined || b === undefined)
+        return false;
+    return b > a;
+}
+function parseSemverMajor(version) {
+    const match = version.trim().match(/^v?(\d+)\./);
+    if (!match)
+        return undefined;
+    return Number(match[1]);
 }
 export function collectAddedIdentifiers(hunks) {
     const names = [];

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 export { proposeWithAi } from "./ai.ts";
 export { formatCommit, parseCommit, normalizeSubject } from "./format.ts";
 export { inspectStaged, commitWithMessage, GitError } from "./git.ts";
-export { proposeHeuristic, inferType, inferScope, inferSubject, classifyPath, } from "./heuristic.ts";
+export { proposeHeuristic, inferType, inferScope, inferSubject, inferBreaking, detectBreakingKind, formatBreakingReason, breakingFooterDetail, ensureBreakingFooter, classifyPath, } from "./heuristic.ts";
+export type { BreakingKind } from "./heuristic.ts";
 export { parseArgs, helpText, UsageError } from "./parse-args.ts";
 export { assembleDiff, parseUnifiedDiff } from "./parse-diff.ts";
 export { installHook, uninstallHook, runPrepareCommitMsg, shouldSkipPrepareCommitMsg, hasNonCommentContent, HOOK_BEGIN, HOOK_END, } from "./hook.ts";

package/dist/index.js

@@ -1,7 +1,7 @@
 export { proposeWithAi } from "./ai.js";
 export { formatCommit, parseCommit, normalizeSubject } from "./format.js";
 export { inspectStaged, commitWithMessage, GitError } from "./git.js";
-export { proposeHeuristic, inferType, inferScope, inferSubject, classifyPath, } from "./heuristic.js";
+export { proposeHeuristic, inferType, inferScope, inferSubject, inferBreaking, detectBreakingKind, formatBreakingReason, breakingFooterDetail, ensureBreakingFooter, classifyPath, } from "./heuristic.js";
 export { parseArgs, helpText, UsageError } from "./parse-args.js";
 export { assembleDiff, parseUnifiedDiff } from "./parse-diff.js";
 export { installHook, uninstallHook, runPrepareCommitMsg, shouldSkipPrepareCommitMsg, hasNonCommentContent, HOOK_BEGIN, HOOK_END, } from "./hook.js";

package/dist/propose.js

@@ -1,34 +1,35 @@
 import { proposeWithAi } from "./ai.js";
-import { proposeHeuristic } from "./heuristic.js";
+import { breakingFooterDetail, detectBreakingKind, ensureBreakingFooter, formatBreakingReason, proposeHeuristic, } from "./heuristic.js";
 export async function proposeMessage(diff, options, env = process.env) {
     const heuristic = proposeHeuristic({
         diff,
         type: options.type,
         scope: options.scope,
         vibe: options.vibe,
+        breaking: options.breaking,
     });
-    let message;
-    if (options.preferAi === false) {
-        message = heuristic;
-    }
-    else {
+    let message = heuristic;
+    if (options.preferAi !== false) {
         const hasKey = Boolean(env.OPENAI_API_KEY?.trim());
-        if (!hasKey) {
-            message = heuristic;
-        }
-        else {
+        if (hasKey) {
             const ai = await proposeWithAi({
                 diff,
                 vibe: options.vibe,
                 type: options.type,
                 scope: options.scope,
             }, env);
-            message = ai ?? heuristic;
+            if (ai)
+                message = ai;
         }
     }
-    if (options.breaking) {
-        return { ...message, breaking: true };
-    }
-    return message;
+    const forced = Boolean(options.breaking);
+    const breaking = forced || heuristic.breaking || message.breaking;
+    const kind = detectBreakingKind(diff, forced);
+    const breakingReason = kind
+        ? formatBreakingReason(kind)
+        : breaking
+            ? heuristic.breakingReason ?? message.breakingReason
+            : undefined;
+    return ensureBreakingFooter({ ...message, breaking, breakingReason }, breakingFooterDetail(diff));
 }
 //# sourceMappingURL=propose.js.map

package/dist/render.js

@@ -31,6 +31,10 @@ export function renderProposal(diff, message, hints = {}) {
         ...indent(formatted, pc),
         "",
     ];
+    if (message.breaking && message.breakingReason) {
+        lines.push(`  ${pc.yellow("breaking")}  ${pc.dim(message.breakingReason)}`);
+        lines.push("");
+    }
     if (hints.committed) {
         lines.push(`  ${pc.green("committed")}`);
         lines.push("");

package/dist/types.d.ts

@@ -27,6 +27,8 @@ export interface ProposedMessage {
     subject: string;
     body?: string;
     breaking: boolean;
+    /** Short cause when breaking (export removed / major bump / --breaking / footer). */
+    breakingReason?: string;
     engine: Engine;
 }
 export interface ProposeOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webywz/vibe-commit",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Stylish conventional commit messages with personality. Offline-first, AI-optional.",
   "keywords": [
     "git",