@mcarvin/smart-diff 2.3.2 → 3.0.0

package/README.md

@@ -7,7 +7,7 @@
 [![codecov](https://codecov.io/gh/mcarvin8/smart-diff/graph/badge.svg?token=H3ZWAGG7S9)](https://codecov.io/gh/mcarvin8/smart-diff)
 [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fmcarvin8%2Fsmart-diff%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/mcarvin8/smart-diff/main)
 
-TypeScript library that turns a **git revision range** into a **Markdown summary** using any LLM provider supported by the [Vercel AI SDK](https://sdk.vercel.ai) — OpenAI, Anthropic, Google Gemini, Amazon Bedrock, Mistral, Cohere, Groq, xAI, DeepSeek, or any OpenAI-compatible gateway. It uses [`simple-git`](https://github.com/steveukx/git-js) to read the repo, respects **path includes/excludes** and **commit message include/exclude regexes**, and sends commits, paths, structured diff stats, and unified diff text to the model.
+TypeScript library that turns a **git revision range** into a **Markdown summary** using any LLM provider supported by the [Vercel AI SDK](https://sdk.vercel.ai) — OpenAI, Anthropic, Google Gemini, Amazon Bedrock, Mistral, Cohere, Groq, xAI, DeepSeek, or any OpenAI-compatible gateway. It shells out to `git` to read the repo, respects **path includes/excludes** and **commit message include/exclude regexes**, and sends commits, paths, structured diff stats, and unified diff text to the model.
 
 ## Requirements
 
@@ -21,7 +21,28 @@ TypeScript library that turns a **git revision range** into a **Markdown summary
 npm install @mcarvin/smart-diff
 ```
 
-`@ai-sdk/openai` and `@ai-sdk/openai-compatible` ship as direct dependencies. Every other provider (`@ai-sdk/anthropic`, `@ai-sdk/google`, `@ai-sdk/amazon-bedrock`, `@ai-sdk/mistral`, `@ai-sdk/cohere`, `@ai-sdk/groq`, `@ai-sdk/xai`, `@ai-sdk/deepseek`) is declared as an **optional peer** and only needs to be installed when you actually use that provider. If the package is missing, smart-diff throws a clear error telling you which one to install.
+All provider packages are **optional** — only install the one(s) you need:
+
+```bash
+# OpenAI
+npm install @ai-sdk/openai
+
+# Anthropic
+npm install @ai-sdk/anthropic
+
+# Google Gemini
+npm install @ai-sdk/google
+
+# Amazon Bedrock
+npm install @ai-sdk/amazon-bedrock
+
+# OpenAI-compatible gateway (Azure, Ollama, Together, etc.)
+npm install @ai-sdk/openai-compatible
+
+# Others: @ai-sdk/mistral  @ai-sdk/cohere  @ai-sdk/groq  @ai-sdk/xai  @ai-sdk/deepseek
+```
+
+If the package for the selected provider is missing at runtime, smart-diff throws a clear error telling you which one to install.
 
 ## Provider configuration
 
@@ -29,15 +50,15 @@ smart-diff is "configured" when [`isLlmProviderConfigured()`](#lower-level-api)
 
 ### Selecting a provider
 
-`LLM_PROVIDER` explicitly selects a provider. When unset, the resolver auto-detects in this order: `LLM_BASE_URL`/`OPENAI_BASE_URL` → `openai-compatible`, `OPENAI_API_KEY`/`LLM_API_KEY` → `openai`, then `ANTHROPIC_API_KEY`, `GOOGLE_GENERATIVE_AI_API_KEY` (or `GOOGLE_API_KEY`), `MISTRAL_API_KEY`, `COHERE_API_KEY`, `GROQ_API_KEY`, `XAI_API_KEY`, `DEEPSEEK_API_KEY`, and finally `OPENAI_DEFAULT_HEADERS`/`LLM_DEFAULT_HEADERS` → `openai`.
+`LLM_PROVIDER` explicitly selects a provider. When unset, the resolver auto-detects in this order: `LLM_BASE_URL`/`OPENAI_BASE_URL` → `openai-compatible`, `OPENAI_API_KEY`/`LLM_API_KEY` → `openai`, then `ANTHROPIC_API_KEY`, `GOOGLE_GENERATIVE_AI_API_KEY` (or `GOOGLE_API_KEY`), `MISTRAL_API_KEY`, `COHERE_API_KEY`, `GROQ_API_KEY`, `XAI_API_KEY`, `DEEPSEEK_API_KEY`, `AWS_ACCESS_KEY_ID`/`AWS_PROFILE` → `bedrock`, and finally `OPENAI_DEFAULT_HEADERS`/`LLM_DEFAULT_HEADERS` → `openai`.
 
 | Provider (`LLM_PROVIDER`) | Package | Credential env vars | Default model |
 |---|---|---|---|
 | `openai` | `@ai-sdk/openai` | `OPENAI_API_KEY` or `LLM_API_KEY` | `gpt-4o-mini` |
 | `openai-compatible` | `@ai-sdk/openai-compatible` | `LLM_BASE_URL` or `OPENAI_BASE_URL` (required); `OPENAI_API_KEY`/`LLM_API_KEY` or custom headers | `gpt-4o-mini` |
-| `anthropic` | `@ai-sdk/anthropic` | `ANTHROPIC_API_KEY` | `claude-3-5-haiku-latest` |
+| `anthropic` | `@ai-sdk/anthropic` | `ANTHROPIC_API_KEY` | `claude-haiku-4-5-20251001` |
 | `google` | `@ai-sdk/google` | `GOOGLE_GENERATIVE_AI_API_KEY` or `GOOGLE_API_KEY` | `gemini-2.0-flash` |
-| `bedrock` | `@ai-sdk/amazon-bedrock` | Standard AWS credential chain (env / profile / role) | `anthropic.claude-3-5-haiku-20241022-v1:0` |
+| `bedrock` | `@ai-sdk/amazon-bedrock` | `AWS_ACCESS_KEY_ID` / `AWS_PROFILE` (auto-detects); full AWS credential chain supported | `anthropic.claude-3-5-haiku-20241022-v1:0` |
 | `mistral` | `@ai-sdk/mistral` | `MISTRAL_API_KEY` | `mistral-small-latest` |
 | `cohere` | `@ai-sdk/cohere` | `COHERE_API_KEY` | `command-r-08-2024` |
 | `groq` | `@ai-sdk/groq` | `GROQ_API_KEY` | `llama-3.1-8b-instant` |
@@ -57,6 +78,7 @@ smart-diff is "configured" when [`isLlmProviderConfigured()`](#lower-level-api)
 | `LLM_PROVIDER_NAME` | Display name used when `openai-compatible` is active (defaults to `openai-compatible`). |
 | `OPENAI_MAX_DIFF_CHARS` / `LLM_MAX_DIFF_CHARS` | Max size of unified diff text sent to the model (default ~120k characters). |
 | `OPENAI_MAX_TOKENS` / `LLM_MAX_TOKENS` | Max completion tokens (default 4000). |
+| `LLM_TEMPERATURE` | Sampling temperature, clamped to 0–2 (default 0.2). Lower = more deterministic; higher = more varied prose. |
 
 ### Example: native OpenAI
 
@@ -113,7 +135,7 @@ const markdown = await summarizeGitDiff({
 | Option | Description |
 |--------|-------------|
 | `from` / `to` | Git refs for the range; `to` defaults to `HEAD`. |
-| `cwd` / `git` | Working tree for `simple-git`, or inject your own `SimpleGit` instance. |
+| `cwd` / `git` | Working directory path, or inject your own `GitClient` instance. |
 | `includeFolders` | Limit diff to these paths relative to repo root (omit for full repo minus excludes). |
 | `excludeFolders` | Excluded paths (git `:(exclude)` pathspecs), e.g. `node_modules`. |
 | `commitMessageIncludeRegexes` | If any pattern is non-empty, only commits whose **full message** matches at least one pattern are kept (after excludes). Case-insensitive. |
@@ -173,10 +195,22 @@ const md = await summarizeGitDiff({
 
 The package also exports helpers for building a custom pipeline on top of the same git and LLM behavior:
 
-- **Git**: `createGitClient`, `getRepoRoot`, `getCommits`, `getDiff`, `getDiffSummary`, `getChangedFiles`, `filterCommitsByMessageRegexes`, `buildDiffPathspecs`, `buildDiffShapingGitArgs`, `shapeUnifiedDiff`, `DEFAULT_NOISE_EXCLUDES`
+- **Git**: `createGitClient(cwd?, timeout?)`, `getRepoRoot`, `getCommits`, `getDiff`, `getDiffSummary`, `getChangedFiles`, `filterCommitsByMessageRegexes`, `buildDiffPathspecs`, `buildDiffShapingGitArgs`, `shapeUnifiedDiff`, `DEFAULT_NOISE_EXCLUDES` — `timeout` is in milliseconds, forwarded to `execFile`; omit for no timeout
 - **AI**: `generateSummary`, `resolveLlmMaxDiffChars`, `truncateUnifiedDiffForLlm`
 - **Provider resolution**: `resolveLanguageModel`, `detectLlmProvider`, `isLlmProviderConfigured`, `defaultModelForProvider`, `resolveLlmBaseUrl`, `parseLlmDefaultHeadersFromEnv`
-- **Constants / types**: `DEFAULT_GIT_DIFF_SYSTEM_PROMPT`, `LLM_GATEWAY_REQUIRED_MESSAGE`, `LlmProviderId`, `LlmModelProvider`, `ResolveLanguageModelOptions`, `GenerateSummaryInput`, `SummarizeFlags`
+- **Constants / types**: `DEFAULT_GIT_DIFF_SYSTEM_PROMPT`, `LLM_GATEWAY_REQUIRED_MESSAGE`, `LlmProviderId`, `LlmModelProvider`, `ResolveLanguageModelOptions`, `GenerateSummaryInput`, `SummarizeFlags`, `DiffFileSummary`, `DiffSummary`, `CommitInfo`, `GitClient`, `GitDiffRangeQuery`, `DiffPathFilter`, `DiffShapingOptions` — `DiffFileSummary.binary?: boolean` is set to `true` when git reports `-` for additions/deletions (binary file); absent for text files
+
+## Migrating from 2.x → 3.x
+
+`@ai-sdk/openai` and `@ai-sdk/openai-compatible` are no longer bundled as direct dependencies. If you use either, add them explicitly:
+
+```bash
+npm install @ai-sdk/openai
+# or
+npm install @ai-sdk/openai-compatible
+```
+
+Everything else — env vars, auto-detection, the public API — is unchanged.
 
 ## Migrating from 1.x → 2.x
 

package/dist/index.cjs

@@ -2,7 +2,8 @@
 
 var ai = require('ai');
 var node_path = require('node:path');
-var simpleGit = require('simple-git');
+var node_child_process = require('node:child_process');
+var node_util = require('node:util');
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -53,7 +54,7 @@ const LLM_GATEWAY_REQUIRED_MESSAGE = "No LLM provider configured. Set LLM_PROVID
 const DEFAULT_MODEL_BY_PROVIDER = {
     openai: "gpt-4o-mini",
     "openai-compatible": "gpt-4o-mini",
-    anthropic: "claude-3-5-haiku-latest",
+    anthropic: "claude-haiku-4-5-20251001",
     google: "gemini-2.0-flash",
     bedrock: "anthropic.claude-3-5-haiku-20241022-v1:0",
     mistral: "mistral-small-latest",
@@ -120,7 +121,7 @@ function resolveOpenAiApiKey() {
     return (_a = readEnv("LLM_API_KEY")) !== null && _a !== void 0 ? _a : readEnv("OPENAI_API_KEY");
 }
 function detectLlmProvider() {
-    var _a, _b;
+    var _a, _b, _c;
     const explicit = (_a = readEnv("LLM_PROVIDER")) === null || _a === void 0 ? void 0 : _a.toLowerCase();
     if (explicit && isValidProviderId(explicit)) {
         return explicit;
@@ -145,6 +146,8 @@ function detectLlmProvider() {
         return "xai";
     if (readEnv("DEEPSEEK_API_KEY"))
         return "deepseek";
+    if ((_c = readEnv("AWS_ACCESS_KEY_ID")) !== null && _c !== void 0 ? _c : readEnv("AWS_PROFILE"))
+        return "bedrock";
     if (parseLlmDefaultHeadersFromEnv())
         return "openai";
     return undefined;
@@ -157,17 +160,17 @@ function defaultModelForProvider(provider) {
 }
 function createOpenAiModel(modelId) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { createOpenAI } = yield import('@ai-sdk/openai');
+        const mod = yield importOptional("openai", "@ai-sdk/openai", () => import('@ai-sdk/openai'));
         const apiKey = resolveOpenAiApiKey();
         const headers = parseLlmDefaultHeadersFromEnv();
-        const provider = createOpenAI(Object.assign(Object.assign({}, (apiKey ? { apiKey } : {})), (headers ? { headers } : {})));
+        const provider = mod.createOpenAI(Object.assign(Object.assign({}, (apiKey ? { apiKey } : {})), (headers ? { headers } : {})));
         return provider(modelId);
     });
 }
 function createOpenAiCompatibleModel(modelId) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a;
-        const { createOpenAICompatible } = yield import('@ai-sdk/openai-compatible');
+        const { createOpenAICompatible } = yield importOptional("openai-compatible", "@ai-sdk/openai-compatible", () => import('@ai-sdk/openai-compatible'));
         const baseURL = resolveLlmBaseUrl();
         if (!baseURL) {
             throw new Error("openai-compatible provider requires LLM_BASE_URL or OPENAI_BASE_URL to be set.");
@@ -330,6 +333,17 @@ function resolveMaxOutputTokens() {
     const parsed = raw !== undefined ? Number.parseInt(raw, 10) : 4000;
     return Number.isFinite(parsed) && parsed > 0 ? parsed : 4000;
 }
+function resolveLlmTemperature() {
+    var _a;
+    const raw = (_a = process.env.LLM_TEMPERATURE) === null || _a === void 0 ? void 0 : _a.trim();
+    if (raw) {
+        const parsed = Number.parseFloat(raw);
+        if (Number.isFinite(parsed)) {
+            return Math.min(2, Math.max(0, parsed));
+        }
+    }
+    return 0.2;
+}
 function generateSummary(input) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a;
@@ -409,7 +423,7 @@ function callLlm(userContent, systemPrompt, maxOutputTokens, llmModelProvider, f
             model,
             system: systemPrompt,
             prompt: userContent,
-            temperature: 0.2,
+            temperature: resolveLlmTemperature(),
             maxOutputTokens,
         });
         const text = result.text.trim();
@@ -424,10 +438,9 @@ function normalizeRepoRelativePath(p) {
     return noTrailingSlash.length > 0 ? noTrailingSlash : ".";
 }
 function assertPathUnderRepo(repoRoot, userPath) {
+    const absRoot = node_path.resolve(repoRoot);
     const abs = node_path.resolve(repoRoot, userPath);
-    const rel = node_path.relative(repoRoot, abs);
-    const segments = rel.split(/[/\\]/);
-    if (segments.includes("..")) {
+    if (abs !== absRoot && !abs.startsWith(absRoot + node_path.sep)) {
         throw new Error(`Path escapes repository root: ${JSON.stringify(userPath)}`);
     }
 }
@@ -705,10 +718,11 @@ function parseNumStatLine(line) {
     const addStr = parts[0];
     const delStr = parts[1];
     const pathField = parts.slice(2).join("\t");
+    const binary = addStr === "-" || delStr === "-" ? true : undefined;
     const additions = addStr !== "-" ? Number.parseInt(addStr, 10) || 0 : 0;
     const deletions = delStr !== "-" ? Number.parseInt(delStr, 10) || 0 : 0;
     const key = numStatPathToLookupKey(pathField);
-    return { key, additions, deletions };
+    return Object.assign({ key, additions, deletions }, (binary ? { binary } : {}));
 }
 function accumulateNumStat(numStatOutput, into) {
     var _a;
@@ -720,10 +734,8 @@ function accumulateNumStat(numStatOutput, into) {
         if (!parsed)
             continue;
         const prev = (_a = into.get(parsed.key)) !== null && _a !== void 0 ? _a : { additions: 0, deletions: 0 };
-        into.set(parsed.key, {
-            additions: prev.additions + parsed.additions,
-            deletions: prev.deletions + parsed.deletions,
-        });
+        const binary = parsed.binary || prev.binary || undefined;
+        into.set(parsed.key, Object.assign({ additions: prev.additions + parsed.additions, deletions: prev.deletions + parsed.deletions }, (binary ? { binary } : {})));
     }
 }
 
@@ -813,7 +825,7 @@ function buildSyntheticDiffLine(meta, counts) {
     return `${prefix}\t${counts.additions}\t${counts.deletions}\t${meta.path}`;
 }
 function buildDiffSummaryFromGitOutputs(nameStatusOutput, numStatOutput) {
-    var _a;
+    var _a, _b;
     const numMap = new Map();
     accumulateNumStat(numStatOutput, numMap);
     const mergedName = mergeNameEntriesByPath(parseNameStatusLines(nameStatusOutput));
@@ -822,21 +834,39 @@ function buildDiffSummaryFromGitOutputs(nameStatusOutput, numStatOutput) {
         const counts = (_a = numMap.get(path)) !== null && _a !== void 0 ? _a : { additions: 0, deletions: 0 };
         syntheticLines.push(buildSyntheticDiffLine(meta, counts));
     }
-    return parseDiffSummary(syntheticLines.join("\n"));
+    const summary = parseDiffSummary(syntheticLines.join("\n"));
+    for (const file of summary.files) {
+        if ((_b = numMap.get(file.path)) === null || _b === void 0 ? void 0 : _b.binary) {
+            file.binary = true;
+        }
+    }
+    return summary;
 }
 
-function createGitClient(cwd = process.cwd()) {
-    return simpleGit.simpleGit(cwd);
+const execFileAsync = node_util.promisify(node_child_process.execFile);
+function createGitClient(cwd = process.cwd(), timeout) {
+    return {
+        run: (args) => execFileAsync("git", args, Object.assign({ cwd, maxBuffer: 100 * 1024 * 1024 }, (timeout !== undefined ? { timeout } : {}))).then(({ stdout }) => stdout),
+    };
 }
 function getCommits(git, from, to) {
     return __awaiter(this, void 0, void 0, function* () {
-        const logResult = yield git.log({ from, to });
-        return logResult.all;
+        const output = yield git.run(["log", "--format=%H%x1f%s", `${from}..${to}`]);
+        return output
+            .split("\n")
+            .filter(Boolean)
+            .map((line) => {
+            const sep = line.indexOf("\x1f");
+            return {
+                hash: sep >= 0 ? line.slice(0, sep) : line,
+                message: sep >= 0 ? line.slice(sep + 1) : "",
+            };
+        });
     });
 }
 function getRepoRoot(git) {
     return __awaiter(this, void 0, void 0, function* () {
-        const root = yield git.revparse(["--show-toplevel"]);
+        const root = yield git.run(["rev-parse", "--show-toplevel"]);
         return root.trim();
     });
 }
@@ -853,7 +883,8 @@ function getDiff(git, query) {
         const { specs } = yield getDiffPathContext(git, pathFilter, repoRootOverride);
         const shapingArgs = buildDiffShapingGitArgs(shaping);
         if (!filterByCommits) {
-            const raw = yield git.diff([
+            const raw = yield git.run([
+                "diff",
                 ...shapingArgs,
                 `${from}..${to}`,
                 "--",
@@ -861,7 +892,7 @@ function getDiff(git, query) {
             ]);
             return shapeUnifiedDiff(raw, shaping);
         }
-        const patches = yield Promise.all(commits.map((c) => git.diff([...shapingArgs, `${c.hash}^!`, "--", ...specs])));
+        const patches = yield Promise.all(commits.map((c) => git.run(["diff", ...shapingArgs, `${c.hash}^!`, "--", ...specs])));
         return patches
             .map((p) => shapeUnifiedDiff(p, shaping))
             .filter(Boolean)
@@ -875,14 +906,16 @@ function getDiffSummary(git, query) {
         const whitespaceArgs = (shaping === null || shaping === void 0 ? void 0 : shaping.ignoreWhitespace) ? ["-w"] : [];
         if (!filterByCommits) {
             const [numOutput, nameOutput] = yield Promise.all([
-                git.diff([
+                git.run([
+                    "diff",
                     ...whitespaceArgs,
                     "--numstat",
                     `${from}..${to}`,
                     "--",
                     ...specs,
                 ]),
-                git.diff([
+                git.run([
+                    "diff",
                     ...whitespaceArgs,
                     "--name-status",
                     `${from}..${to}`,
@@ -895,8 +928,22 @@ function getDiffSummary(git, query) {
         const pairs = yield Promise.all(commits.map((c) => __awaiter(this, void 0, void 0, function* () {
             const range = `${c.hash}^!`;
             const [numOutput, nameOutput] = yield Promise.all([
-                git.diff([...whitespaceArgs, "--numstat", range, "--", ...specs]),
-                git.diff([...whitespaceArgs, "--name-status", range, "--", ...specs]),
+                git.run([
+                    "diff",
+                    ...whitespaceArgs,
+                    "--numstat",
+                    range,
+                    "--",
+                    ...specs,
+                ]),
+                git.run([
+                    "diff",
+                    ...whitespaceArgs,
+                    "--name-status",
+                    range,
+                    "--",
+                    ...specs,
+                ]),
             ]);
             return { numOutput, nameOutput };
         })));
@@ -916,7 +963,8 @@ function getChangedFiles(git, query) {
         const { from, to, commits, filterByCommits, pathFilter, repoRootOverride } = query;
         const { specs } = yield getDiffPathContext(git, pathFilter, repoRootOverride);
         if (!filterByCommits) {
-            const output = yield git.diff([
+            const output = yield git.run([
+                "diff",
                 "--name-only",
                 `${from}..${to}`,
                 "--",
@@ -925,24 +973,24 @@ function getChangedFiles(git, query) {
             return output
                 .split(/\r?\n/)
                 .map((f) => f.trim())
-                .filter(Boolean);
+                .filter(Boolean)
+                .sort();
         }
-        const fileSet = new Set();
-        yield Promise.all(commits.map((c) => __awaiter(this, void 0, void 0, function* () {
-            const output = yield git.show([
+        const results = yield Promise.all(commits.map((c) => __awaiter(this, void 0, void 0, function* () {
+            const output = yield git.run([
+                "show",
                 "--name-only",
                 "--pretty=format:",
                 c.hash,
                 "--",
                 ...specs,
             ]);
-            output
+            return output
                 .split(/\r?\n/)
                 .map((f) => f.trim())
-                .filter(Boolean)
-                .forEach((f) => fileSet.add(f));
+                .filter(Boolean);
         })));
-        return Array.from(fileSet);
+        return [...new Set(results.flat())].sort();
     });
 }