@webywz/vibe-commit 0.1.2 → 0.1.4

package/README.md

@@ -41,6 +41,7 @@ Requires **Node.js 18.18+** and `git`. Package: [`@webywz/vibe-commit`](https://
 git add -p
 vibe-commit                         # propose from staged diff
 vibe-commit --vibe playful --commit # write the commit
+vibe-commit --breaking --dry-run    # force ! + BREAKING CHANGE footer
 vibe-commit --dry-run               # print only (default; wins over --commit)
 git commit -m "$(vibe-commit --dry-run)"
 vibe-commit install                 # optional prepare-commit-msg hook
@@ -54,6 +55,12 @@ vibe-commit install                 # optional prepare-commit-msg hook
 | `--scope <scope>` | Override inferred scope · 覆盖推断出的 scope |
 | `--vibe <style>` | `playful` \| `pro` \| `terse` (default: `pro`) |
 | `--no-ai` | Skip the API even if `OPENAI_API_KEY` is set · 即使有 Key 也不走 AI |
+| `--breaking` | Force breaking change (`!` + `BREAKING CHANGE:` footer) · 强制破坏性变更（`!` + footer） |
+
+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).
+
+离线启发式在删掉公开 `export`、或 `package.json` 主版本升级时也会标 breaking；只要 `breaking` 为真就会补上 `BREAKING CHANGE:` footer（`--json` 的 body 与格式化输出一致）。
+
 | `--json` | Machine-readable proposal · 机器可读提案 |
 | `install [--path]` | Install the prepare-commit-msg hook · 安装钩子 |
 | `uninstall [--path]` | Remove the managed hook · 卸载钩子 |

package/dist/cli.js

@@ -46,6 +46,7 @@ export async function main(argv = process.argv.slice(2)) {
             scope: options.scope,
             vibe: options.vibe,
             preferAi: !options.noAi,
+            breaking: options.breaking,
         });
         const formatted = formatCommit(message);
         const shouldCommit = options.commit && !options.dryRun;

package/dist/format.js

@@ -1,12 +1,18 @@
 import { COMMIT_TYPES, } from "./types.js";
 const TYPE_PATTERN = COMMIT_TYPES.join("|");
 const HEADER_RE = new RegExp(`^(${TYPE_PATTERN})(?:\\(([a-zA-Z0-9][\\w./-]{0,62})\\))?(!)?:\\s*(.+)$`);
+const BREAKING_FOOTER_RE = /^BREAKING[ -]CHANGE:/im;
 export function formatCommit(message) {
     const bang = message.breaking ? "!" : "";
+    const subject = normalizeSubject(message.subject);
     const head = message.scope
-        ? `${message.type}(${message.scope})${bang}: ${normalizeSubject(message.subject)}`
-        : `${message.type}${bang}: ${normalizeSubject(message.subject)}`;
-    const body = message.body?.trim();
+        ? `${message.type}(${message.scope})${bang}: ${subject}`
+        : `${message.type}${bang}: ${subject}`;
+    let body = message.body?.trim() || "";
+    if (message.breaking && !BREAKING_FOOTER_RE.test(body)) {
+        const footer = `BREAKING CHANGE: ${subject}`;
+        body = body ? `${body}\n\n${footer}` : footer;
+    }
     return body ? `${head}\n\n${body}` : head;
 }
 export function normalizeSubject(subject) {

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,13 @@ 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 declare function inferBreaking(diff: StagedDiff): boolean;
+/** Short reason for a BREAKING CHANGE footer, or undefined when not breaking. */
+export declare function breakingReason(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,10 @@ 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 breaking = Boolean(input.breaking) || inferBreaking(diff);
     const styled = applyVibe({ type, scope, subject, body, breaking }, vibe);
-    return { ...styled, engine: "heuristic" };
+    const message = { ...styled, engine: "heuristic" };
+    return ensureBreakingFooter(message, breakingReason(diff));
 }
 export function inferType(diff) {
     const files = diff.files;
@@ -216,8 +217,133 @@ 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(breakingReason(diff));
+}
+/** Short reason for a BREAKING CHANGE footer, or undefined when not breaking. */
+export function breakingReason(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,7 @@
 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, ensureBreakingFooter, classifyPath, } 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, 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/parse-args.js

@@ -17,6 +17,7 @@ Options
   --scope <scope>     Override inferred scope
   --vibe <style>      playful | pro | terse          (default: pro)
   --no-ai             Skip AI even if OPENAI_API_KEY is set
+  --breaking          Force breaking change (! + BREAKING CHANGE footer)
   --json              Print a machine-readable proposal
   --path <repo>       Repo root for install/uninstall (default: cwd)
   -h, --help          Show help
@@ -38,6 +39,7 @@ Examples
   git add -p
   vibe-commit
   vibe-commit --vibe playful --commit
+  vibe-commit --breaking --dry-run
   git commit -m "$(vibe-commit --dry-run)"
   vibe-commit install
   vibe-commit uninstall --path ~/projects/app
@@ -56,6 +58,7 @@ export function parseArgs(argv, env = process.env) {
         json: false,
         help: false,
         version: false,
+        breaking: false,
     };
     let i = 0;
     if (argv[0] && !argv[0].startsWith("-")) {
@@ -93,6 +96,10 @@ export function parseArgs(argv, env = process.env) {
             options.json = true;
             continue;
         }
+        if (arg === "--breaking") {
+            options.breaking = true;
+            continue;
+        }
         if (arg === "--type" || arg.startsWith("--type=")) {
             const value = arg.includes("=") ? arg.slice("--type=".length) : argv[++i];
             options.type = parseType(value);

package/dist/propose.js

@@ -1,23 +1,28 @@
 import { proposeWithAi } from "./ai.js";
-import { proposeHeuristic } from "./heuristic.js";
+import { breakingReason, ensureBreakingFooter, 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,
     });
-    if (options.preferAi === false)
-        return heuristic;
-    const hasKey = Boolean(env.OPENAI_API_KEY?.trim());
-    if (!hasKey)
-        return heuristic;
-    const ai = await proposeWithAi({
-        diff,
-        vibe: options.vibe,
-        type: options.type,
-        scope: options.scope,
-    }, env);
-    return ai ?? heuristic;
+    let message = heuristic;
+    if (options.preferAi !== false) {
+        const hasKey = Boolean(env.OPENAI_API_KEY?.trim());
+        if (hasKey) {
+            const ai = await proposeWithAi({
+                diff,
+                vibe: options.vibe,
+                type: options.type,
+                scope: options.scope,
+            }, env);
+            if (ai)
+                message = ai;
+        }
+    }
+    const breaking = Boolean(options.breaking) || heuristic.breaking || message.breaking;
+    return ensureBreakingFooter({ ...message, breaking }, breakingReason(diff));
 }
 //# sourceMappingURL=propose.js.map

package/dist/types.d.ts

@@ -34,6 +34,8 @@ export interface ProposeOptions {
     scope?: string;
     vibe: Vibe;
     preferAi?: boolean;
+    /** Force a breaking change (! + BREAKING CHANGE footer). */
+    breaking?: boolean;
 }
 export type CliCommand = "propose" | "install" | "uninstall" | "prepare-commit-msg";
 export interface CliOptions {
@@ -47,6 +49,8 @@ export interface CliOptions {
     json: boolean;
     help: boolean;
     version: boolean;
+    /** Force breaking change marker and footer. */
+    breaking: boolean;
     /** Target repo for install/uninstall (default: cwd). */
     path?: string;
     /** Message file path for prepare-commit-msg. */

package/package.json

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