git-coco 0.6.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 };

package/dist/index.esm.mjs

@@ -1720,6 +1720,10 @@ var init = {
     options,
 };
 
+var types = /*#__PURE__*/Object.freeze({
+  __proto__: null
+});
+
 yargs
     .scriptName('coco')
     .usage('$0 <cmd> [args]')
@@ -1740,4 +1744,5 @@ changelog.builder, changelog.handler)
 init.builder, init.handler)
     .demandCommand()
     .help().argv;
-//# sourceMappingURL=index.esm.mjs.map
+
+export { changelog, commit, init, types };

package/dist/index.js

@@ -1741,6 +1741,10 @@ var init = {
     options,
 };
 
+var types = /*#__PURE__*/Object.freeze({
+  __proto__: null
+});
+
 yargs
     .scriptName('coco')
     .usage('$0 <cmd> [args]')
@@ -1761,3 +1765,8 @@ changelog.builder, changelog.handler)
 init.builder, init.handler)
     .demandCommand()
     .help().argv;
+
+exports.changelog = changelog;
+exports.commit = commit;
+exports.init = init;
+exports.types = types;

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "git-coco",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "zero-effort git commits with coco.",
   "author": "gfargo <ghfargo@gmail.com>",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.esm.mjs",
   "files": [
-    "dist"
+    "dist",
+    "!dist/dts"
   ],
+  "types": "dist/index.d.ts",
   "homepage": "https://github.com/gfargo/coco#readme",
   "bugs": {
     "url": "https://github.com/gfargo/coco/issues"
@@ -21,15 +23,19 @@
     "url": "git+https://github.com/gfargo/coco.git"
   },
   "scripts": {
-    "test": "jest",
     "start": "npm run dev",
     "dev": "tsx watch src/index.ts",
     "build": "rollup -c",
     "build:watch": "rollup -c -w",
+    "clean": "rimraf dist && rimraf coverage",
     "lint": "eslint src",
     "lint:fix": "eslint --fix src",
+    "format": "prettier --write src",
+    "test": "npm run test:jest && npm run test:publish",
+    "test:publish": "npm run lint && npm publish --dry-run",
+    "test:jest": "jest",
     "release": "release-it",
-    "prepublishOnly": "rimraf dist && npm run build",
+    "prepublishOnly": "npm run clean && npm run build",
     "coco": "npm run coco:ts",
     "coco:ts": "tsx src/index.ts",
     "coco:cjs": "node dist/index.js",
@@ -60,6 +66,7 @@
     "rollup": "^3.26.1",
     "rollup-plugin-banner2": "^1.2.2",
     "rollup-plugin-bin": "^1.0.0",
+    "rollup-plugin-dts": "^6.1.0",
     "rollup-plugin-executable": "^1.6.3",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-preserve-shebangs": "^0.2.0",

package/dist/commands/changelog/handler.d.ts

@@ -1,3 +0,0 @@
-import { Argv } from 'yargs';
-import { ChangelogOptions } from './options';
-export declare function handler(argv: Argv<ChangelogOptions>['argv']): Promise<void>;

package/dist/commands/changelog/index.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="yargs" />
-import { handler } from './handler';
-declare const _default: {
-    command: string;
-    desc: string;
-    builder: (yargs: import("yargs").Argv<{}>) => import("yargs").Argv<import("yargs").Omit<{}, string> & import("yargs").InferredOptionTypes<Record<string, import("yargs").Options>>>;
-    handler: typeof handler;
-    options: Record<string, import("yargs").Options>;
-};
-export default _default;

package/dist/commands/changelog/options.d.ts

@@ -1,16 +0,0 @@
-import { Options, Argv } from 'yargs';
-import { BaseCommandOptions } from '../types';
-export interface ChangelogOptions extends BaseCommandOptions {
-    range: string;
-    prompt: string;
-    commit: boolean;
-    summarizePrompt: string;
-    openInEditor: boolean;
-    ignoredFiles: string[];
-    ignoredExtensions: string[];
-}
-/**
- * Command line options via yargs
- */
-export declare const options: Record<string, Options>;
-export declare const builder: (yargs: Argv) => Argv<import("yargs").Omit<{}, string> & import("yargs").InferredOptionTypes<Record<string, Options>>>;

package/dist/commands/commit/handler.d.ts

@@ -1,3 +0,0 @@
-import { CommitOptions } from './options';
-import { Argv } from 'yargs';
-export declare function handler(argv: Argv<CommitOptions>['argv']): Promise<void>;

package/dist/commands/commit/index.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="yargs" />
-import { handler } from './handler';
-declare const _default: {
-    command: string;
-    desc: string;
-    builder: (yargs: import("yargs").Argv<{}>) => import("yargs").Argv<import("yargs").Omit<{}, string> & import("yargs").InferredOptionTypes<Record<string, import("yargs").Options>>>;
-    handler: typeof handler;
-    options: Record<string, import("yargs").Options>;
-};
-export default _default;

package/dist/commands/commit/options.d.ts

@@ -1,15 +0,0 @@
-import { Options, Argv } from 'yargs';
-import { BaseCommandOptions } from '../types';
-export interface CommitOptions extends BaseCommandOptions {
-    prompt: string;
-    commit: boolean;
-    summarizePrompt: string;
-    openInEditor: boolean;
-    ignoredFiles: string[];
-    ignoredExtensions: string[];
-}
-/**
- * Command line options via yargs
- */
-export declare const options: Record<string, Options>;
-export declare const builder: (yargs: Argv) => Argv<import("yargs").Omit<{}, string> & import("yargs").InferredOptionTypes<Record<string, Options>>>;

package/dist/commands/init/handler.d.ts

@@ -1,3 +0,0 @@
-import { CommitOptions } from './options';
-import { Argv } from 'yargs';
-export declare function handler(argv: Argv<CommitOptions>['argv']): Promise<void>;

package/dist/commands/init/index.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="yargs" />
-import { handler } from './handler';
-declare const _default: {
-    command: string;
-    desc: string;
-    builder: (yargs: import("yargs").Argv<{}>) => import("yargs").Argv<import("yargs").Omit<{}, string> & import("yargs").InferredOptionTypes<Record<string, import("yargs").Options>>>;
-    handler: typeof handler;
-    options: Record<string, import("yargs").Options>;
-};
-export default _default;

package/dist/commands/init/options.d.ts

@@ -1,15 +0,0 @@
-import { Options, Argv } from 'yargs';
-import { BaseCommandOptions } from '../types';
-export interface CommitOptions extends BaseCommandOptions {
-    prompt: string;
-    commit: boolean;
-    summarizePrompt: string;
-    openInEditor: boolean;
-    ignoredFiles: string[];
-    ignoredExtensions: string[];
-}
-/**
- * Command line options via yargs
- */
-export declare const options: Record<string, Options>;
-export declare const builder: (yargs: Argv) => Argv<import("yargs").Omit<{}, string> & import("yargs").InferredOptionTypes<Record<string, Options>>>;

package/dist/commands/types.d.ts

@@ -1,14 +0,0 @@
-import { Config } from '../lib/config/types';
-interface BaseArgvOptions {
-    interactive: boolean;
-    help: boolean;
-    verbose: boolean;
-}
-export interface BaseCommandOptions extends BaseArgvOptions {
-    [x: string]: unknown;
-    model: string;
-    openAIApiKey: string;
-    huggingFaceHubApiKey: string;
-    tokenLimit: number;
-}
-export { Config };