@mcarvin/smart-diff 1.0.0 → 1.0.2

package/README.md

@@ -1,8 +1,8 @@
 # smart-diff
 
-[![NPM](https://img.shields.io/npm/v/smart-diff.svg?label=smart-diff)](https://www.npmjs.com/package/smart-diff)
+[![NPM](https://img.shields.io/npm/v/@mcarvin/smart-diff.svg?label=smart-diff)](https://www.npmjs.com/package/@mcarvin/smart-diff)
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/mcarvin8/smart-diff/main/LICENSE.md)
-[![Downloads/week](https://img.shields.io/npm/dw/smart-diff.svg)](https://npmjs.org/package/smart-diff)
+[![Downloads/week](https://img.shields.io/npm/dw/@mcarvin/smart-diff.svg)](https://npmjs.org/package/@mcarvin/smart-diff)
 
 TypeScript library that turns a **git revision range** into a **Markdown summary** using an OpenAI-compatible Chat Completions API. 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.
 
@@ -11,11 +11,12 @@ There is **no local fallback**: you must either configure an LLM gateway via env
 ## Requirements
 
 - **Node.js** 20+
+- Git Bash
 
 ## Installation
 
 ```bash
-npm install smart-diff
+npm install @mcarvin/smart-diff
 ```
 
 Build the package from source with `npm run build` (Rollup outputs CommonJS and ESM under `dist/`).
@@ -39,7 +40,7 @@ The client is created with the official [`openai`](https://www.npmjs.com/package
 ### `summarizeGitDiff`
 
 ```ts
-import { summarizeGitDiff } from 'smart-diff';
+import { summarizeGitDiff } from '@mcarvin/smart-diff';
 
 const markdown = await summarizeGitDiff({
   from: 'origin/main',

package/dist/index.cjs

@@ -154,12 +154,12 @@ function truncateUnifiedDiffForLlm(diffText, maxChars) {
     const marker = `\n\n--- TRUNCATED: unified diff was ${diffText.length} characters; only the first ${maxChars} were sent. Narrow the ref range, adjust commit/path filters, or raise maxDiffChars / LLM_MAX_DIFF_CHARS only if your model context allows. ---\n`;
     return diffText.slice(0, maxChars) + marker;
 }
-const DEFAULT_GIT_DIFF_SYSTEM_PROMPT = `You are a senior software engineer helping developers understand code and configuration changes from the git context they supplied.
-You receive: commit subject lines (when available), changed file paths, and unified git patch(es)—either one range diff or concatenated per-commit patches, depending on how the diff was produced. Patches may be truncated mid-section with an explicit marker—do not infer changes beyond visible lines.
-Explain what changed in terms of behavior, APIs, data, configuration, security, and operational risk. Tie claims to the patch when possible.
-Produce a concise, developer-focused summary in Markdown.
-Use sections that fit the change (for example: Highlights, Breaking or risky changes, API / contract changes, Data & schema, Configuration & infra, Security & auth, Tests & quality). Omit empty sections.
-Group related changes; do not list every individual file. When multiple commits appear in the context, briefly separate notable themes by commit when helpful.
+const DEFAULT_GIT_DIFF_SYSTEM_PROMPT = `You are a senior software engineer helping developers understand code and configuration changes from the git context they supplied.
+You receive: commit subject lines (when available), changed file paths, and unified git patch(es)—either one range diff or concatenated per-commit patches, depending on how the diff was produced. Patches may be truncated mid-section with an explicit marker—do not infer changes beyond visible lines.
+Explain what changed in terms of behavior, APIs, data, configuration, security, and operational risk. Tie claims to the patch when possible.
+Produce a concise, developer-focused summary in Markdown.
+Use sections that fit the change (for example: Highlights, Breaking or risky changes, API / contract changes, Data & schema, Configuration & infra, Security & auth, Tests & quality). Omit empty sections.
+Group related changes; do not list every individual file. When multiple commits appear in the context, briefly separate notable themes by commit when helpful.
 If the user message includes a Team line, use that exact team name in the summary title (for example: "## <Team> – Change summary" or similar).`;
 const LLM_GATEWAY_REQUIRED_MESSAGE = 'No LLM gateway configured. Set OPENAI_API_KEY or LLM_API_KEY, and/or LLM_BASE_URL or OPENAI_BASE_URL, ' +
     'and/or JSON in OPENAI_DEFAULT_HEADERS or LLM_DEFAULT_HEADERS. ' +

package/dist/index.mjs

@@ -152,12 +152,12 @@ function truncateUnifiedDiffForLlm(diffText, maxChars) {
     const marker = `\n\n--- TRUNCATED: unified diff was ${diffText.length} characters; only the first ${maxChars} were sent. Narrow the ref range, adjust commit/path filters, or raise maxDiffChars / LLM_MAX_DIFF_CHARS only if your model context allows. ---\n`;
     return diffText.slice(0, maxChars) + marker;
 }
-const DEFAULT_GIT_DIFF_SYSTEM_PROMPT = `You are a senior software engineer helping developers understand code and configuration changes from the git context they supplied.
-You receive: commit subject lines (when available), changed file paths, and unified git patch(es)—either one range diff or concatenated per-commit patches, depending on how the diff was produced. Patches may be truncated mid-section with an explicit marker—do not infer changes beyond visible lines.
-Explain what changed in terms of behavior, APIs, data, configuration, security, and operational risk. Tie claims to the patch when possible.
-Produce a concise, developer-focused summary in Markdown.
-Use sections that fit the change (for example: Highlights, Breaking or risky changes, API / contract changes, Data & schema, Configuration & infra, Security & auth, Tests & quality). Omit empty sections.
-Group related changes; do not list every individual file. When multiple commits appear in the context, briefly separate notable themes by commit when helpful.
+const DEFAULT_GIT_DIFF_SYSTEM_PROMPT = `You are a senior software engineer helping developers understand code and configuration changes from the git context they supplied.
+You receive: commit subject lines (when available), changed file paths, and unified git patch(es)—either one range diff or concatenated per-commit patches, depending on how the diff was produced. Patches may be truncated mid-section with an explicit marker—do not infer changes beyond visible lines.
+Explain what changed in terms of behavior, APIs, data, configuration, security, and operational risk. Tie claims to the patch when possible.
+Produce a concise, developer-focused summary in Markdown.
+Use sections that fit the change (for example: Highlights, Breaking or risky changes, API / contract changes, Data & schema, Configuration & infra, Security & auth, Tests & quality). Omit empty sections.
+Group related changes; do not list every individual file. When multiple commits appear in the context, briefly separate notable themes by commit when helpful.
 If the user message includes a Team line, use that exact team name in the summary title (for example: "## <Team> – Change summary" or similar).`;
 const LLM_GATEWAY_REQUIRED_MESSAGE = 'No LLM gateway configured. Set OPENAI_API_KEY or LLM_API_KEY, and/or LLM_BASE_URL or OPENAI_BASE_URL, ' +
     'and/or JSON in OPENAI_DEFAULT_HEADERS or LLM_DEFAULT_HEADERS. ' +

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mcarvin/smart-diff",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Summarizes a git diff using OpenAI models.",
   "author": "Matt Carvin",
   "license": "MIT",
@@ -59,10 +59,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mcarvin8/git-diff-ai.git"
+    "url": "git+https://github.com/mcarvin8/smart-diff.git"
   },
   "bugs": {
-    "url": "https://github.com/mcarvin8/git-diff-ai/issues"
+    "url": "https://github.com/mcarvin8/smart-diff/issues"
   },
   "keywords": [
     "openai",

package/dist/typings/ai/aiSummary.d.ts

@@ -1,18 +0,0 @@
-import type { CommitInfo, DiffSummary } from '../git/gitDiff.js';
-import { type OpenAiLikeClient } from './openAIConfig.js';
-export declare function resolveLlmMaxDiffChars(cliOverride?: number): number;
-export declare function truncateUnifiedDiffForLlm(diffText: string, maxChars: number): string;
-export declare const DEFAULT_GIT_DIFF_SYSTEM_PROMPT = "You are a senior software engineer helping developers understand code and configuration changes from the git context they supplied.\nYou receive: commit subject lines (when available), changed file paths, and unified git patch(es)\u2014either one range diff or concatenated per-commit patches, depending on how the diff was produced. Patches may be truncated mid-section with an explicit marker\u2014do not infer changes beyond visible lines.\nExplain what changed in terms of behavior, APIs, data, configuration, security, and operational risk. Tie claims to the patch when possible.\nProduce a concise, developer-focused summary in Markdown.\nUse sections that fit the change (for example: Highlights, Breaking or risky changes, API / contract changes, Data & schema, Configuration & infra, Security & auth, Tests & quality). Omit empty sections.\nGroup related changes; do not list every individual file. When multiple commits appear in the context, briefly separate notable themes by commit when helpful.\nIf the user message includes a Team line, use that exact team name in the summary title (for example: \"## <Team> \u2013 Change summary\" or similar).";
-export type SummarizeFlags = {
-    from: string;
-    to?: string;
-    model?: string;
-    team?: string;
-    maxDiffChars?: number;
-    systemPrompt?: string;
-    commitMessageIncludeRegexes?: string[];
-    commitMessageExcludeRegexes?: string[];
-};
-type OpenAiClientProvider = () => Promise<OpenAiLikeClient>;
-export declare function generateSummary(diffText: string, fileNames: string[], commits: CommitInfo[], flags: SummarizeFlags, openAiClientProvider?: OpenAiClientProvider, diffSummary?: DiffSummary): Promise<string>;
-export {};

package/dist/typings/ai/openAIConfig.d.ts

@@ -1,21 +0,0 @@
-export declare function resolveLlmBaseUrl(): string | undefined;
-export declare function parseLlmDefaultHeadersFromEnv(): Record<string, string> | undefined;
-export declare function splitPromotableAuthorizationFromHeaders(headers: Record<string, string>): {
-    defaultHeaders: Record<string, string>;
-    apiKeyFromAuthHeader?: string;
-};
-export declare function shouldUseLlmGateway(): boolean;
-export type OpenAiLikeClient = {
-    chat: {
-        completions: {
-            create(...options: unknown[]): Promise<unknown>;
-        };
-    };
-};
-export type OpenAiLikeClientInit = {
-    apiKey: string;
-    baseURL?: string;
-    defaultHeaders?: Record<string, string>;
-};
-export declare function resolveOpenAiLikeClientInit(): OpenAiLikeClientInit;
-export declare function createOpenAiLikeClient(): Promise<OpenAiLikeClient>;

package/dist/typings/git/gitDiff.d.ts

@@ -1,33 +0,0 @@
-import type { SimpleGit } from 'simple-git';
-export type CommitInfo = {
-    hash: string;
-    message: string;
-};
-export type DiffStatus = 'added' | 'deleted' | 'modified' | 'renamed' | 'copied' | 'type-changed' | 'unknown';
-export type DiffFileSummary = {
-    path: string;
-    status: DiffStatus;
-    additions: number;
-    deletions: number;
-    oldPath?: string;
-    newPath?: string;
-};
-export type DiffSummary = {
-    files: DiffFileSummary[];
-    totalFiles: number;
-    totalAdditions: number;
-    totalDeletions: number;
-};
-export type DiffPathFilter = {
-    includeFolders?: string[];
-    excludeFolders?: string[];
-};
-export declare function createGitClient(cwd?: string): SimpleGit;
-export declare function getCommits(git: SimpleGit, from: string, to: string): Promise<CommitInfo[]>;
-export declare function filterCommitsByMessageRegexes(commits: CommitInfo[], includePatterns?: string[], excludePatterns?: string[]): CommitInfo[];
-export declare function getRepoRoot(git: SimpleGit): Promise<string>;
-export declare function buildDiffPathspecs(repoRoot: string, pathFilter?: DiffPathFilter): string[];
-export declare function getDiff(git: SimpleGit, from: string, to: string, commits: CommitInfo[], filterByCommits: boolean, pathFilter?: DiffPathFilter, repoRootOverride?: string): Promise<string>;
-export declare function getDiffSummary(git: SimpleGit, from: string, to: string, commits: CommitInfo[], filterByCommits: boolean, pathFilter?: DiffPathFilter, repoRootOverride?: string): Promise<DiffSummary>;
-export declare function getChangedFiles(git: SimpleGit, from: string, to: string, commits: CommitInfo[], filterByCommits: boolean, pathFilter?: DiffPathFilter, repoRootOverride?: string): Promise<string[]>;
-export declare function parseDiffSummary(diffOutput: string): DiffSummary;

package/dist/typings/index.d.ts

@@ -1,24 +0,0 @@
-import type { SimpleGit } from 'simple-git';
-import type { OpenAiLikeClient } from './ai/openAIConfig.js';
-export type GitDiffAiSummaryOptions = {
-    from: string;
-    to?: string;
-    cwd?: string;
-    git?: SimpleGit;
-    includeFolders?: string[];
-    excludeFolders?: string[];
-    commitMessageIncludeRegexes?: string[];
-    commitMessageExcludeRegexes?: string[];
-    systemPrompt?: string;
-    teamName?: string;
-    model?: string;
-    maxDiffChars?: number;
-    openAiClientProvider?: () => Promise<OpenAiLikeClient>;
-};
-export declare function summarizeGitDiff(options: GitDiffAiSummaryOptions): Promise<string>;
-export type { CommitInfo, DiffFileSummary, DiffPathFilter, DiffSummary } from './git/gitDiff.js';
-export { buildDiffPathspecs, createGitClient, filterCommitsByMessageRegexes, getChangedFiles, getCommits, getDiff, getDiffSummary, getRepoRoot, } from './git/gitDiff.js';
-export type { SummarizeFlags } from './ai/aiSummary.js';
-export { DEFAULT_GIT_DIFF_SYSTEM_PROMPT, generateSummary, resolveLlmMaxDiffChars, truncateUnifiedDiffForLlm } from './ai/aiSummary.js';
-export type { OpenAiLikeClient, OpenAiLikeClientInit } from './ai/openAIConfig.js';
-export { createOpenAiLikeClient, parseLlmDefaultHeadersFromEnv, resolveLlmBaseUrl, resolveOpenAiLikeClientInit, shouldUseLlmGateway, splitPromotableAuthorizationFromHeaders, } from './ai/openAIConfig.js';