gut-cli 0.1.14 → 0.1.15

package/dist/lib/index.d.ts

@@ -0,0 +1,300 @@
+import { z } from 'zod';
+
+type Provider = 'gemini' | 'openai' | 'anthropic' | 'ollama';
+declare function saveApiKey(provider: Provider, apiKey: string): Promise<void>;
+declare function getApiKey(provider: Provider): Promise<string | null>;
+declare function deleteApiKey(provider: Provider): Promise<boolean>;
+declare function listProviders(): Promise<{
+    provider: Provider;
+    hasKey: boolean;
+}[]>;
+
+interface AIOptions {
+    provider: Provider;
+    model?: string;
+    ollamaBaseUrl?: string;
+    apiKey?: string;
+}
+/**
+ * Find a user's project template from .gut/ folder
+ * @param repoRoot - The root directory of the user's repository
+ * @param templateName - Name of the template file (without .md extension)
+ * @returns Template content if found, null otherwise
+ */
+declare function findTemplate(repoRoot: string, templateName: string): string | null;
+declare function generateCommitMessage(diff: string, options: AIOptions, template?: string): Promise<string>;
+declare function generatePRDescription(context: {
+    baseBranch: string;
+    currentBranch: string;
+    commits: string[];
+    diff: string;
+}, options: AIOptions, template?: string): Promise<{
+    title: string;
+    body: string;
+}>;
+declare const CodeReviewSchema: z.ZodObject<{
+    summary: z.ZodString;
+    issues: z.ZodArray<z.ZodObject<{
+        severity: z.ZodEnum<["critical", "warning", "suggestion"]>;
+        file: z.ZodString;
+        line: z.ZodOptional<z.ZodNumber>;
+        message: z.ZodString;
+        suggestion: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        severity: "critical" | "warning" | "suggestion";
+        file: string;
+        suggestion?: string | undefined;
+        line?: number | undefined;
+    }, {
+        message: string;
+        severity: "critical" | "warning" | "suggestion";
+        file: string;
+        suggestion?: string | undefined;
+        line?: number | undefined;
+    }>, "many">;
+    positives: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    summary: string;
+    issues: {
+        message: string;
+        severity: "critical" | "warning" | "suggestion";
+        file: string;
+        suggestion?: string | undefined;
+        line?: number | undefined;
+    }[];
+    positives: string[];
+}, {
+    summary: string;
+    issues: {
+        message: string;
+        severity: "critical" | "warning" | "suggestion";
+        file: string;
+        suggestion?: string | undefined;
+        line?: number | undefined;
+    }[];
+    positives: string[];
+}>;
+type CodeReview = z.infer<typeof CodeReviewSchema>;
+declare function generateCodeReview(diff: string, options: AIOptions, template?: string): Promise<CodeReview>;
+declare const ChangelogSchema: z.ZodObject<{
+    version: z.ZodOptional<z.ZodString>;
+    date: z.ZodString;
+    sections: z.ZodArray<z.ZodObject<{
+        type: z.ZodString;
+        items: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        items: string[];
+    }, {
+        type: string;
+        items: string[];
+    }>, "many">;
+    summary: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    date: string;
+    sections: {
+        type: string;
+        items: string[];
+    }[];
+    summary?: string | undefined;
+    version?: string | undefined;
+}, {
+    date: string;
+    sections: {
+        type: string;
+        items: string[];
+    }[];
+    summary?: string | undefined;
+    version?: string | undefined;
+}>;
+type Changelog = z.infer<typeof ChangelogSchema>;
+declare function generateChangelog(context: {
+    commits: Array<{
+        hash: string;
+        message: string;
+        author: string;
+        date: string;
+    }>;
+    diff: string;
+    fromRef: string;
+    toRef: string;
+}, options: AIOptions, template?: string): Promise<Changelog>;
+declare const ConflictResolutionSchema: z.ZodObject<{
+    resolvedContent: z.ZodString;
+    explanation: z.ZodString;
+    strategy: z.ZodEnum<["ours", "theirs", "combined", "rewritten"]>;
+}, "strip", z.ZodTypeAny, {
+    resolvedContent: string;
+    explanation: string;
+    strategy: "ours" | "theirs" | "combined" | "rewritten";
+}, {
+    resolvedContent: string;
+    explanation: string;
+    strategy: "ours" | "theirs" | "combined" | "rewritten";
+}>;
+type ConflictResolution = z.infer<typeof ConflictResolutionSchema>;
+declare const ExplanationSchema: z.ZodObject<{
+    summary: z.ZodString;
+    purpose: z.ZodString;
+    changes: z.ZodArray<z.ZodObject<{
+        file: z.ZodString;
+        description: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        file: string;
+        description: string;
+    }, {
+        file: string;
+        description: string;
+    }>, "many">;
+    impact: z.ZodString;
+    notes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    summary: string;
+    purpose: string;
+    changes: {
+        file: string;
+        description: string;
+    }[];
+    impact: string;
+    notes?: string[] | undefined;
+}, {
+    summary: string;
+    purpose: string;
+    changes: {
+        file: string;
+        description: string;
+    }[];
+    impact: string;
+    notes?: string[] | undefined;
+}>;
+type Explanation = z.infer<typeof ExplanationSchema>;
+declare function generateExplanation(context: {
+    type: 'commit' | 'pr' | 'file-history' | 'file-content' | 'uncommitted' | 'staged';
+    title: string;
+    diff?: string;
+    content?: string;
+    metadata: {
+        hash?: string;
+        author?: string;
+        date?: string;
+        prNumber?: string;
+        baseBranch?: string;
+        headBranch?: string;
+        commits?: string[];
+        filePath?: string;
+    };
+}, options: AIOptions, template?: string): Promise<Explanation>;
+interface CommitSearchResult {
+    matches: Array<{
+        hash: string;
+        message: string;
+        author: string;
+        email: string;
+        date: string;
+        reason: string;
+        relevance?: 'high' | 'medium' | 'low';
+    }>;
+    summary?: string;
+}
+declare function searchCommits(query: string, commits: Array<{
+    hash: string;
+    message: string;
+    author: string;
+    email: string;
+    date: string;
+}>, options: AIOptions, maxResults?: number, template?: string): Promise<CommitSearchResult>;
+declare function generateBranchName(description: string, options: AIOptions, context?: {
+    type?: string;
+    issue?: string;
+}, template?: string): Promise<string>;
+declare function generateBranchNameFromDiff(diff: string, options: AIOptions, template?: string | null): Promise<string>;
+declare function generateStashName(diff: string, options: AIOptions, template?: string): Promise<string>;
+declare const WorkSummarySchema: z.ZodObject<{
+    title: z.ZodString;
+    overview: z.ZodString;
+    highlights: z.ZodArray<z.ZodString, "many">;
+    details: z.ZodArray<z.ZodObject<{
+        category: z.ZodString;
+        items: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        items: string[];
+        category: string;
+    }, {
+        items: string[];
+        category: string;
+    }>, "many">;
+    stats: z.ZodOptional<z.ZodObject<{
+        commits: z.ZodNumber;
+        filesChanged: z.ZodOptional<z.ZodNumber>;
+        additions: z.ZodOptional<z.ZodNumber>;
+        deletions: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        commits: number;
+        filesChanged?: number | undefined;
+        additions?: number | undefined;
+        deletions?: number | undefined;
+    }, {
+        commits: number;
+        filesChanged?: number | undefined;
+        additions?: number | undefined;
+        deletions?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    overview: string;
+    highlights: string[];
+    details: {
+        items: string[];
+        category: string;
+    }[];
+    stats?: {
+        commits: number;
+        filesChanged?: number | undefined;
+        additions?: number | undefined;
+        deletions?: number | undefined;
+    } | undefined;
+}, {
+    title: string;
+    overview: string;
+    highlights: string[];
+    details: {
+        items: string[];
+        category: string;
+    }[];
+    stats?: {
+        commits: number;
+        filesChanged?: number | undefined;
+        additions?: number | undefined;
+        deletions?: number | undefined;
+    } | undefined;
+}>;
+type WorkSummary = z.infer<typeof WorkSummarySchema>;
+declare function generateWorkSummary(context: {
+    commits: Array<{
+        hash: string;
+        message: string;
+        date: string;
+    }>;
+    author: string;
+    since: string;
+    until?: string;
+    diff?: string;
+}, options: AIOptions, format?: 'daily' | 'weekly' | 'custom', template?: string): Promise<WorkSummary>;
+declare function resolveConflict(conflictedContent: string, context: {
+    filename: string;
+    oursRef: string;
+    theirsRef: string;
+}, options: AIOptions, template?: string): Promise<ConflictResolution>;
+declare function generateGitignore(context: {
+    files: string;
+    configFiles?: string;
+    existingGitignore?: string;
+}, options: AIOptions, template?: string): Promise<string>;
+
+type Language = 'en' | 'ja';
+declare function getLanguage(): Language;
+declare function setLanguage(lang: Language, local?: boolean): void;
+declare function getLanguageInstruction(lang: Language): string;
+
+export { type AIOptions, type Changelog, type CodeReview, type CommitSearchResult, type ConflictResolution, type Explanation, type Provider, type WorkSummary, deleteApiKey, findTemplate, generateBranchName, generateBranchNameFromDiff, generateChangelog, generateCodeReview, generateCommitMessage, generateExplanation, generateGitignore, generatePRDescription, generateStashName, generateWorkSummary, getApiKey, getLanguage, getLanguageInstruction, listProviders, resolveConflict, saveApiKey, searchCommits, setLanguage };