@senad-d/branchme 0.3.15 → 0.3.17

package/src/truncation.ts

@@ -0,0 +1,119 @@
+import type { TruncatedText, TruncationMetadata, TruncationStrategy } from "./types.ts";
+
+export interface TruncateTextOptions {
+  maxLines?: number;
+  maxBytes?: number;
+  strategy?: TruncationStrategy;
+  label?: string;
+}
+
+export function countLines(text: string): number {
+  if (text.length === 0) return 0;
+  return text.split(/\r?\n/).length;
+}
+
+export function byteLength(text: string): number {
+  return Buffer.byteLength(text, "utf8");
+}
+
+function sliceToBytesFromHead(text: string, maxBytes: number): string {
+  let bytes = 0;
+  let output = "";
+  for (const char of text) {
+    const nextBytes = byteLength(char);
+    if (bytes + nextBytes > maxBytes) break;
+    output += char;
+    bytes += nextBytes;
+  }
+  return output;
+}
+
+function sliceToBytesFromTail(text: string, maxBytes: number): string {
+  let bytes = 0;
+  const chars = Array.from(text);
+  const kept: string[] = [];
+  for (let index = chars.length - 1; index >= 0; index -= 1) {
+    const char = chars[index];
+    if (char === undefined) continue;
+    const nextBytes = byteLength(char);
+    if (bytes + nextBytes > maxBytes) break;
+    kept.push(char);
+    bytes += nextBytes;
+  }
+  kept.reverse();
+  return kept.join("");
+}
+
+function truncateLines(text: string, maxLines: number, strategy: TruncationStrategy): string {
+  if (maxLines <= 0) return "";
+  const lines = text.split(/\r?\n/);
+  if (lines.length <= maxLines) return text;
+  return strategy === "tail" ? lines.slice(-maxLines).join("\n") : lines.slice(0, maxLines).join("\n");
+}
+
+function truncateBytes(text: string, maxBytes: number, strategy: TruncationStrategy): string {
+  if (byteLength(text) <= maxBytes) return text;
+  return strategy === "tail" ? sliceToBytesFromTail(text, maxBytes) : sliceToBytesFromHead(text, maxBytes);
+}
+
+export function formatTruncationNotice(metadata: TruncationMetadata): string | undefined {
+  if (!metadata.truncated) return undefined;
+  const label = metadata.label ? `${metadata.label}: ` : "";
+  return `[Truncated ${label}showing ${metadata.outputLines} of ${metadata.originalLines} lines, ${metadata.outputBytes} of ${metadata.originalBytes} bytes.]`;
+}
+
+export function truncateText(text: string, options: TruncateTextOptions): TruncatedText {
+  const strategy = options.strategy ?? "head";
+  const originalBytes = byteLength(text);
+  const originalLines = countLines(text);
+
+  let output = text;
+  if (typeof options.maxLines === "number" && options.maxLines >= 0) {
+    output = truncateLines(output, options.maxLines, strategy);
+  }
+  if (typeof options.maxBytes === "number" && options.maxBytes >= 0) {
+    output = truncateBytes(output, options.maxBytes, strategy);
+  }
+
+  const metadata: TruncationMetadata = {
+    truncated: output !== text,
+    strategy,
+    originalBytes,
+    outputBytes: byteLength(output),
+    originalLines,
+    outputLines: countLines(output),
+    label: options.label,
+  };
+
+  return {
+    text: output,
+    metadata,
+    notice: formatTruncationNotice(metadata),
+  };
+}
+
+export function appendTruncationNotice(truncated: TruncatedText): string {
+  if (!truncated.notice) return truncated.text;
+  return `${truncated.text}\n\n${truncated.notice}`;
+}
+
+export function collectTruncationMetadata(items: Array<{ truncation?: TruncationMetadata }>): TruncationMetadata[] {
+  return items.flatMap((item) => (item.truncation ? [item.truncation] : []));
+}
+
+function escapedControlCharacter(character: string, codePoint: number): string {
+  if (character === "\r") return String.raw`\r`;
+  if (character === "\n") return String.raw`\n`;
+  if (character === "\t") return String.raw`\t`;
+  return String.raw`\x${codePoint.toString(16).padStart(2, "0")}`;
+}
+
+export function formatDisplayPath(path: string): string {
+  let output = "";
+  for (const character of path) {
+    const codePoint = character.codePointAt(0);
+    if (codePoint === undefined) continue;
+    output += codePoint <= 0x1f || codePoint === 0x7f ? escapedControlCharacter(character, codePoint) : character;
+  }
+  return output;
+}

package/src/types.ts

@@ -1,3 +1,5 @@
+import type { CONVENTIONAL_COMMIT_TYPES } from "./constants.ts";
+
 export interface GitHubRepository {
   owner: string;
   repo: string;
@@ -35,6 +37,80 @@ export interface ListBranchesToolInput {
   patterns?: string[];
 }
 
+export interface GitStatusToolInput {
+  paths?: string[];
+  worktreePath?: string;
+  after?: string;
+}
+
+export interface GitStatusEntry {
+  kind: "tracked" | "untracked" | "conflict";
+  /** Display only unless reusablePath is true. */
+  path: string;
+  originalPath?: string;
+  reusablePath: boolean;
+  indexStatus: string;
+  worktreeStatus: string;
+  submodule: string;
+  /** Present only for explicitly filtered, reusable paths. No file content is returned. */
+  worktreeExpectation?: { fingerprint: string | null; reason?: string };
+}
+
+export interface GitStatusDetails {
+  action: "git_status";
+  repoRoot: string;
+  head: string | null;
+  branch: string | null;
+  detached: boolean;
+  index: string;
+  snapshot: string;
+  operations: string[];
+  filtered: boolean;
+  pathFilters: string[];
+  hasChanges: boolean;
+  total: number;
+  entries: GitStatusEntry[];
+  offset: number;
+  complete: boolean;
+  next: string | null;
+}
+
+export type GitDiffMode = "unstaged" | "staged" | "range";
+export type GitDiffOutput = "patch" | "stat" | "name-status";
+
+export interface GitDiffToolInput {
+  mode?: GitDiffMode;
+  baseRef?: string;
+  targetRef?: string;
+  mergeBase?: boolean;
+  output?: GitDiffOutput;
+  paths?: string[];
+  contextLines?: number;
+  worktreePath?: string;
+}
+
+export interface GitDiffDetails {
+  action: "git_diff";
+  repoRoot: string;
+  mode: GitDiffMode;
+  output: GitDiffOutput;
+  /** Redacted/abbreviated literal filter previews, not reusable path identities. */
+  pathFilters: string[];
+  comparison?: {
+    baseHead: string;
+    targetHead: string;
+    /** The captured base commit, or the unique merge base when requested. */
+    diffBaseHead: string;
+  };
+  hasDifferences: boolean;
+  /** Redacted, control-escaped, bounded display text, not an apply-ready patch. */
+  diff: string;
+  truncated: boolean;
+  /** Counts after redaction/control escaping, before truncation. */
+  totalBytes: number;
+  totalLines: number;
+}
+
 export interface FetchRemoteToolInput {
   remote?: string;
   prune?: boolean;
@@ -726,3 +802,200 @@ export interface GitExecResult {
   code: number;
   killed: boolean;
 }
+
+export type ConventionalCommitType = (typeof CONVENTIONAL_COMMIT_TYPES)[number];
+export type GitChangeScope = "staged" | "unstaged";
+export type TruncationStrategy = "head" | "tail";
+export type ProjectContextEntryKind = "metadata" | "changed-file-snippet";
+export type SkippedContextReason =
+  | "sensitive"
+  | "generated"
+  | "binary"
+  | "symlink"
+  | "missing"
+  | "too-large"
+  | "unreadable"
+  | "outside-repository";
+
+export interface CommitGitOptions {
+  cwd: string;
+  timeout?: number;
+  signal?: AbortSignal;
+}
+
+export interface TruncationMetadata {
+  truncated: boolean;
+  strategy: TruncationStrategy;
+  originalBytes: number;
+  outputBytes: number;
+  originalLines: number;
+  outputLines: number;
+  label?: string;
+}
+
+export interface TruncatedText {
+  text: string;
+  metadata: TruncationMetadata;
+  notice?: string;
+}
+
+export interface PromptSectionBudget {
+  maxBytes: number;
+  maxLines: number;
+}
+
+export interface CommitPromptBudget {
+  profile: "compact" | "default" | "large";
+  maxBytes: number;
+  maxLines: number;
+  sections: Record<
+    | "steeringPrompt"
+    | "repositorySummary"
+    | "changedFiles"
+    | "diffStats"
+    | "changedFileSnippets"
+    | "diffExcerpts"
+    | "omittedContext"
+    | "projectMetadata",
+    PromptSectionBudget
+  >;
+}
+
+export interface CommitPromptDiagnostics {
+  budgetProfile: CommitPromptBudget["profile"];
+  maxBytes: number;
+  maxLines: number;
+  systemPromptBytes: number;
+  userPromptBytes: number;
+  textBytes: number;
+  truncationCount: number;
+}
+
+export interface CommitPromptPayload {
+  systemPrompt: string;
+  userPrompt: string;
+  summaryPrompt: string;
+  text: string;
+  truncation: TruncationMetadata[];
+  diagnostics: CommitPromptDiagnostics;
+}
+
+export interface DraftUsageDiagnostics {
+  input?: number;
+  output?: number;
+  cacheRead?: number;
+  cacheWrite?: number;
+  totalTokens?: number;
+}
+
+export interface DraftResponseDiagnostics {
+  stopReason?: string;
+  contentTypeCounts: Record<string, number>;
+  contentTypes: string[];
+  textCharacterCount: number;
+  usableTextCharacterCount: number;
+  empty: boolean;
+  thinkingOnly: boolean;
+  lengthStopped: boolean;
+  usage?: DraftUsageDiagnostics;
+}
+
+export interface DraftAttemptDiagnostics {
+  attempt: number;
+  purpose: "draft" | "retry" | "repair";
+  maxTokens: number;
+  response?: DraftResponseDiagnostics;
+  validationError?: string;
+}
+
+export interface ChangedFile {
+  path: string;
+  status: string;
+  scope: GitChangeScope;
+  sensitive: boolean;
+  generated: boolean;
+  binary: boolean;
+  relatedPaths?: string[];
+  secretContent?: boolean;
+  unreadable?: boolean;
+}
+
+export interface GitDiffSummary {
+  scope: GitChangeScope;
+  stat: string;
+  excerpt: string;
+  truncation: TruncationMetadata;
+}
+
+export interface ProjectContextEntry {
+  path: string;
+  kind: ProjectContextEntryKind;
+  content: string;
+  truncation: TruncationMetadata;
+}
+
+export interface SkippedProjectContextEntry {
+  path: string;
+  reason: SkippedContextReason;
+}
+
+export interface ProjectContext {
+  root: string;
+  metadata: ProjectContextEntry[];
+  changedFileSnippets: ProjectContextEntry[];
+  skipped: SkippedProjectContextEntry[];
+}
+
+export interface GitContext {
+  repositoryRoot: string;
+  branch: string;
+  isDetachedHead: boolean;
+  statusPorcelain: string;
+  staged: GitDiffSummary;
+  unstaged: GitDiffSummary;
+  changedFiles: ChangedFile[];
+  project: ProjectContext;
+  hasChanges: boolean;
+  warnings: string[];
+}
+
+export interface CommitMessageValidationOk {
+  ok: true;
+  subject: string;
+  body: string;
+  message: string;
+}
+
+export type CommitMessageValidationResult =
+  | CommitMessageValidationOk
+  | { ok: false; error: string };
+
+export interface CommitResult {
+  commitHash: string;
+  subject: string;
+  body: string;
+  stdout: string;
+  stderr: string;
+}
+
+export interface UnsafeCommitFileApprovalRequest {
+  files: ChangedFile[];
+  context: GitContext;
+}
+
+export type UnsafeCommitFileApproval = (request: UnsafeCommitFileApprovalRequest) => Promise<boolean>;
+
+export interface CommitChangesDetails {
+  action: "gather" | "commit" | "help";
+  steeringPrompt?: string;
+  repositoryRoot?: string;
+  branch?: string;
+  statusPorcelain?: string;
+  hasChanges?: boolean;
+  changedFiles?: ChangedFile[];
+  truncation?: TruncationMetadata[];
+  prompt?: CommitPromptDiagnostics;
+  draft?: DraftAttemptDiagnostics[];
+  warnings?: string[];
+  committed?: CommitResult;
+}