git-coco 0.5.0 → 0.6.1

package/dist/index.d.ts

@@ -1,2 +1,263 @@
-#!/usr/bin/env node
-export {};
+/// <reference types="yargs" />
+import * as yargs from 'yargs';
+import { Argv } from 'yargs';
+import { HuggingFaceInference } from 'langchain/llms/hf';
+import { BaseLLMParams } from 'langchain/llms/base';
+import { OpenAIInput, AzureOpenAIInput, OpenAI } from 'langchain/llms/openai';
+import { SimpleGit } from 'simple-git';
+import { Color } from 'chalk';
+import GPT3NodeTokenizer from 'gpt3-tokenizer';
+
+interface Config$1 {
+    /**
+     * The LLM model to use for generating results.
+     *
+     * @default 'openai/gpt-4'
+     *
+     * @example 'openai/gpt-4'
+     * @example 'openai/gpt-3.5-turbo'
+     * @example 'huggingface/bigscience/bloom'
+     **/
+    model: string;
+    /**
+     * The OpenAI API key.
+     */
+    openAIApiKey?: string;
+    /**
+     * The HuggingFace Hub API key.
+     */
+    huggingFaceHubApiKey?: string;
+    /**
+     * The maximum number of tokens per request.
+     *
+     * @default 1024
+     */
+    tokenLimit?: number;
+    /**
+     * The prompt text used for generating results.
+     */
+    prompt?: string;
+    /**
+     * The temperature value controls the randomness of the generated output.
+     * Higher values (e.g., 0.8) make the output more random, while lower values (e.g., 0.2) make it more deterministic.
+     *
+     * @default 0.4
+     */
+    temperature?: number;
+    /**
+     * The output destination for the generated result.
+     * - 'stdout': Prints the result to the standard output.  This is the default behavior.
+     * - 'interactive': Provides an interactive prompt for editing the result & committing the changes.
+     *
+     * @default 'stdout'
+     */
+    mode?: 'stdout' | 'interactive';
+    /**
+     * Enable verbose logging.
+     *
+     * @default false
+     */
+    verbose?: boolean;
+    /**
+     * Open the commit message in an editor for editing before proceeding.
+     *
+     * @default false
+     */
+    openInEditor?: boolean;
+    /**
+     * The prompt text used specifically for generating summaries of large files.
+     */
+    summarizePrompt?: string;
+    /**
+     * An array of file paths or patterns to be ignored during processing.
+     *
+     * Note: This is a list of patterns interpreted by the `minimatch` library.
+     * @see https://github.com/isaacs/minimatch
+     *
+     * @example ['package-lock.json', 'node_modules']
+     * @default ['package-lock.json', contents of .gitignore, contents of .ignore]
+     */
+    ignoredFiles?: string[];
+    /**
+     * An array of file extensions to be ignored during processing.
+     *
+     * @default ['.map', '.lock']
+     */
+    ignoredExtensions?: string[];
+    /**
+     * Default git branch for the repository.
+     *
+     * @default 'main'
+     */
+    defaultBranch?: string;
+}
+
+interface BaseArgvOptions {
+    interactive: boolean;
+    help: boolean;
+    verbose: boolean;
+}
+interface BaseCommandOptions extends BaseArgvOptions {
+    [x: string]: unknown;
+    model: string;
+    openAIApiKey: string;
+    huggingFaceHubApiKey: string;
+    tokenLimit: number;
+}
+
+interface CommitOptions$1 extends BaseCommandOptions {
+    prompt: string;
+    commit: boolean;
+    summarizePrompt: string;
+    openInEditor: boolean;
+    ignoredFiles: string[];
+    ignoredExtensions: string[];
+}
+
+declare function handler$2(argv: Argv<CommitOptions$1>['argv']): Promise<void>;
+
+declare const _default$2: {
+    command: string;
+    desc: string;
+    builder: (yargs: yargs.Argv<{}>) => yargs.Argv<yargs.Omit<{}, string> & yargs.InferredOptionTypes<Record<string, yargs.Options>>>;
+    handler: typeof handler$2;
+    options: Record<string, yargs.Options>;
+};
+
+interface ChangelogOptions extends BaseCommandOptions {
+    range: string;
+    prompt: string;
+    commit: boolean;
+    summarizePrompt: string;
+    openInEditor: boolean;
+    ignoredFiles: string[];
+    ignoredExtensions: string[];
+}
+
+declare function handler$1(argv: Argv<ChangelogOptions>['argv']): Promise<void>;
+
+declare const _default$1: {
+    command: string;
+    desc: string;
+    builder: (yargs: yargs.Argv<{}>) => yargs.Argv<yargs.Omit<{}, string> & yargs.InferredOptionTypes<Record<string, yargs.Options>>>;
+    handler: typeof handler$1;
+    options: Record<string, yargs.Options>;
+};
+
+interface CommitOptions extends BaseCommandOptions {
+    prompt: string;
+    commit: boolean;
+    summarizePrompt: string;
+    openInEditor: boolean;
+    ignoredFiles: string[];
+    ignoredExtensions: string[];
+}
+
+declare function handler(argv: Argv<CommitOptions>['argv']): Promise<void>;
+
+declare const _default: {
+    command: string;
+    desc: string;
+    builder: (yargs: yargs.Argv<{}>) => yargs.Argv<yargs.Omit<{}, string> & yargs.InferredOptionTypes<Record<string, yargs.Options>>>;
+    handler: typeof handler;
+    options: Record<string, yargs.Options>;
+};
+
+/**
+ * Get LLM Model Based on Configuration
+ * @param fields
+ * @param configuration
+ * @returns LLM Model
+ */
+declare function getModel(name: string, key: string, fields?: (Partial<OpenAIInput> & Partial<AzureOpenAIInput> & BaseLLMParams) | undefined): OpenAI | HuggingFaceInference;
+
+interface LoggerOptions {
+    color?: typeof Color;
+}
+interface SpinnerOptions {
+    mode?: undefined | 'stop' | 'succeed' | 'warn' | 'fail';
+    color?: typeof Color;
+}
+interface Config {
+    verbose?: boolean;
+}
+declare class Logger {
+    private config;
+    private timerStart;
+    private spinner;
+    constructor(config: Config);
+    log(message: string, options?: LoggerOptions): Logger;
+    verbose(message: string, options?: LoggerOptions): Logger;
+    startTimer(): Logger;
+    stopTimer(message?: string, options?: LoggerOptions): Logger;
+    startSpinner(message: string, options?: Omit<SpinnerOptions, 'mode'>): Logger;
+    stopSpinner(message?: string | undefined, options?: SpinnerOptions): Logger;
+}
+
+/**
+ * Wrapper around GPT3NodeTokenizer to handle default export.
+ *
+ * @see https://github.com/botisan-ai/gpt3-tokenizer/issues/18
+ *
+ * @returns {GPT3NodeTokenizer} The GPT3NodeTokenizer instance.
+ */
+declare const getTokenizer: () => GPT3NodeTokenizer;
+
+type FileChangeStatus = 'modified' | 'renamed' | 'added' | 'deleted' | 'untracked' | 'unknown';
+interface FileChange {
+    summary: string;
+    filePath: string;
+    oldFilePath?: string;
+    status: FileChangeStatus;
+}
+interface FileDiff {
+    file: string;
+    diff: string;
+    summary: string;
+    tokenCount: number;
+}
+interface DiffNode {
+    path: string;
+    diffs: FileDiff[];
+    children: DiffNode[];
+}
+interface DirectoryDiff {
+    path: string;
+    diffs: FileDiff[];
+    summary?: string;
+    tokenCount: number;
+}
+interface BaseParserOptions {
+    tokenizer: ReturnType<typeof getTokenizer>;
+    model: ReturnType<typeof getModel>;
+    git: SimpleGit;
+    logger: Logger;
+}
+interface BaseParserInput {
+    options: BaseParserOptions;
+}
+interface FileChangeParserInput extends BaseParserInput {
+    changes: FileChange[];
+    commit: '--staged' | string;
+}
+interface CommitLogParserInput extends BaseParserInput {
+    range: {
+        from: string;
+        to: string;
+    };
+}
+
+type types_d_BaseParserInput = BaseParserInput;
+type types_d_BaseParserOptions = BaseParserOptions;
+type types_d_CommitLogParserInput = CommitLogParserInput;
+type types_d_DiffNode = DiffNode;
+type types_d_DirectoryDiff = DirectoryDiff;
+type types_d_FileChange = FileChange;
+type types_d_FileChangeParserInput = FileChangeParserInput;
+type types_d_FileChangeStatus = FileChangeStatus;
+type types_d_FileDiff = FileDiff;
+declare namespace types_d {
+  export type { types_d_BaseParserInput as BaseParserInput, types_d_BaseParserOptions as BaseParserOptions, types_d_CommitLogParserInput as CommitLogParserInput, types_d_DiffNode as DiffNode, types_d_DirectoryDiff as DirectoryDiff, types_d_FileChange as FileChange, types_d_FileChangeParserInput as FileChangeParserInput, types_d_FileChangeStatus as FileChangeStatus, types_d_FileDiff as FileDiff };
+}
+
+export { type Config$1 as Config, _default$1 as changelog, _default$2 as commit, _default as init, types_d as types };