git-coco 0.3.4 → 0.4.1

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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,10 @@
+/// <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

@@ -0,0 +1,16 @@
+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/index.esm.mjs

@@ -330,25 +330,25 @@ function validatePromptTemplate(text, inputVariables) {
     return true;
 }
 
-const template$1 = `GOAL: Use functional abstractions to summarize the following text
+const template$2 = `GOAL: Use functional abstractions to summarize the following text
 
 RULES: Avoid phrases like  "this change", "this code", or "this function" etc. Instead refer to the function, variable, or class by name.
 
 TEXT:"""{text}"""
 `;
-const inputVariables$1 = ['text'];
+const inputVariables$2 = ['text'];
 const SUMMARIZE_PROMPT = new PromptTemplate({
-    template: template$1,
-    inputVariables: inputVariables$1,
+    template: template$2,
+    inputVariables: inputVariables$2,
 });
 
-const parseDefaultFileDiff = async (nodeFile, commit = '--staged', git) => {
+async function parseDefaultFileDiff(nodeFile, commit = '--staged', git) {
     if (commit !== '--staged') {
         return await git.diff([`${commit}~1..${commit}`, '--', nodeFile.filePath]);
     }
     return await git.diff([commit, nodeFile.filePath]);
-};
-const parseRenamedFileDiff = async (nodeFile, commit, git, logger) => {
+}
+async function parseRenamedFileDiff(nodeFile, commit, git, logger) {
     let result = '';
     const oldFilePath = nodeFile?.oldFilePath || nodeFile.filePath;
     let previousCommitHash = 'HEAD';
@@ -385,8 +385,8 @@ const parseRenamedFileDiff = async (nodeFile, commit, git, logger) => {
         result = 'Error comparing file contents.';
     }
     return result;
-};
-const getDiff = async (nodeFile, commit, { git, logger, }) => {
+}
+async function getDiff(nodeFile, commit, { git, logger, }) {
     if (nodeFile.status === 'deleted') {
         return 'This file has been deleted.';
     }
@@ -397,7 +397,7 @@ const getDiff = async (nodeFile, commit, { git, logger, }) => {
     // If not deleted or renamed, get the diff from the index
     const defaultDiff = await parseDefaultFileDiff(nodeFile, commit, git);
     return defaultDiff;
-};
+}
 
 const MAX_TOKENS_PER_SUMMARY = 2048;
 async function fileChangeParser({ changes, commit, options: { tokenizer, git, model, logger }, }) {
@@ -500,7 +500,7 @@ class Logger {
     }
 }
 
-const template = `Write informative git commit message, in the imperative, based on the diffs & file changes provided in the "Diff Summary" section.  
+const template$1 = `Write informative git commit message, in the imperative, based on the diffs & file changes provided in the "Diff Summary" section.  
 Commit Messages must have a short description that is less than 50 characters followed by a newline character and then a more verbose detailed description.
 
 - Typically a hyphen or asterisk is used for the bullet
@@ -513,13 +513,13 @@ Commit Messages must have a short description that is less than 50 characters fo
 """{summary}"""
 
 Commit:`;
-const inputVariables = ['summary'];
+const inputVariables$1 = ['summary'];
 const COMMIT_PROMPT = new PromptTemplate({
-    template,
-    inputVariables,
+    template: template$1,
+    inputVariables: inputVariables$1,
 });
 
-const getStatus = (file, location = 'index') => {
+function getStatus(file, location = 'index') {
     if ('index' in file && 'working_dir' in file) {
         const statusCode = file[location];
         switch (statusCode) {
@@ -551,11 +551,11 @@ const getStatus = (file, location = 'index') => {
         return 'unknown';
     }
     else {
-        throw new Error("Invalid file type");
+        throw new Error('Invalid file type');
     }
-};
+}
 
-const getSummaryText = (file, change) => {
+function getSummaryText(file, change) {
     const status = change.status || getStatus(file);
     let filePath;
     if ('path' in file) {
@@ -565,13 +565,13 @@ const getSummaryText = (file, change) => {
         filePath = change?.filePath || file.file;
     }
     else {
-        throw new Error("Invalid file type");
+        throw new Error('Invalid file type');
     }
     if (change.oldFilePath) {
         return `${status}: ${change.oldFilePath} -> ${filePath}`;
     }
     return `${status}: ${filePath}`;
-};
+}
 
 /**
  * Returns a new object with all undefined keys removed
@@ -711,7 +711,6 @@ const DEFAULT_CONFIG = {
     model: 'openai/gpt-4',
     verbose: false,
     tokenLimit: 1024,
-    prompt: COMMIT_PROMPT.template,
     summarizePrompt: SUMMARIZE_PROMPT.template,
     temperature: 0.4,
     mode: 'stdout',
@@ -899,7 +898,7 @@ async function editPrompt(options) {
     });
 }
 
-async function generateAndReviewLoop({ factory, parser, noResult, agent, options, }) {
+async function generateAndReviewLoop({ label, factory, parser, noResult, agent, options, }) {
     const { logger } = options;
     let continueLoop = true;
     let modifyPrompt = false;
@@ -921,19 +920,19 @@ async function generateAndReviewLoop({ factory, parser, noResult, agent, options
         if (modifyPrompt) {
             options.prompt = await editPrompt(options);
         }
-        logger.startTimer().startSpinner(`Generating Message\n`, {
+        logger.startTimer().startSpinner(`Generating ${label}\n`, {
             color: 'blue',
         });
         result = await agent(context, options);
         if (!result) {
-            logger.stopSpinner('💀 Agent failed to generate message.', {
+            logger.stopSpinner('💀 Agent failed to return content.', {
                 mode: 'fail',
                 color: 'red',
             });
             process.exit(0);
         }
         logger
-            .stopSpinner('Generated Commit Message', {
+            .stopSpinner(`Generated ${label}`, {
             color: 'green',
             mode: 'succeed',
         })
@@ -1018,8 +1017,8 @@ const handleResult = async (result, { mode, git }) => {
 };
 
 const tokenizer = getTokenizer();
-const git = simpleGit();
-async function handler(argv) {
+const git$1 = simpleGit();
+async function handler$1(argv) {
     const options = loadConfig(argv);
     const logger = new Logger(options);
     const key = getApiKeyForModel(options.model, options);
@@ -1033,17 +1032,18 @@ async function handler(argv) {
     });
     const INTERACTIVE = isInteractive(options);
     async function factory() {
-        const changes = await getChanges({ git });
+        const changes = await getChanges({ git: git$1 });
         return changes.staged;
     }
     async function parser(changes) {
         return await fileChangeParser({
             changes,
             commit: '--staged',
-            options: { tokenizer, git, model, logger },
+            options: { tokenizer, git: git$1, model, logger },
         });
     }
     const commitMsg = await generateAndReviewLoop({
+        label: 'Commit Message',
         factory,
         parser,
         agent: async (context, options) => {
@@ -1058,11 +1058,12 @@ async function handler(argv) {
             });
         },
         noResult: async () => {
-            await noResult({ git, logger });
+            await noResult({ git: git$1, logger });
             process.exit(0);
         },
         options: {
             ...options,
+            prompt: options.prompt || COMMIT_PROMPT.template,
             logger,
             interactive: INTERACTIVE,
         },
@@ -1070,14 +1071,14 @@ async function handler(argv) {
     const MODE = (INTERACTIVE && 'interactive') || (options.commit && 'interactive') || options?.mode || 'stdout';
     handleResult(commitMsg, {
         mode: MODE,
-        git,
+        git: git$1,
     });
 }
 
 /**
  * Command line options via yargs
  */
-const options = {
+const options$1 = {
     model: { type: 'string', description: 'LLM/Model-Name' },
     openAIApiKey: {
         type: 'string',
@@ -1123,21 +1124,187 @@ const options = {
         description: 'Ignored extensions',
     },
 };
-const builder = (yargs) => {
-    return yargs.options(options);
+const builder$1 = (yargs) => {
+    return yargs.options(options$1);
 };
 
 var commit = {
     command: 'commit',
     desc: 'Generate commit message',
+    builder: builder$1,
+    handler: handler$1,
+    options: options$1,
+};
+
+const template = `Write informative git changelog, in the imperative, based on a series of individual messages.
+
+- Typically a hyphen or asterisk is used for the bullet
+- Summarize dependency updates
+
+"""{summary}"""
+
+Changelog:`;
+const inputVariables = ['summary'];
+const CHANGELOG_PROMPT = new PromptTemplate({
+    template,
+    inputVariables,
+});
+
+async function getCommitLogRange(from, to, { noMerges, git }) {
+    try {
+        const output = await git.raw([
+            'log',
+            `${from}..${to}`,
+            '--pretty=format:%s',
+            // Include '--no-merges' here if you want to exclude merge commits.
+            noMerges ? '--no-merges' : null,
+        ].filter(Boolean)); // filter(Boolean) removes any null values from the array
+        const messages = output.split('\n').filter(Boolean);
+        return messages;
+    }
+    catch (error) {
+        // If there's an error, handle it appropriately
+        console.error('Error getting commit messages:', error);
+        throw error;
+    }
+}
+
+const git = simpleGit();
+async function handler(argv) {
+    const options = loadConfig(argv);
+    const logger = new Logger(options);
+    const key = getApiKeyForModel(options.model, options);
+    if (!key) {
+        logger.log(`No API Key found. 🗝️🚪`, { color: 'red' });
+        process.exit(1);
+    }
+    const model = getModel(options.model, key, {
+        temperature: 0.4,
+        maxConcurrency: 10,
+    });
+    const INTERACTIVE = isInteractive(options);
+    const [from, to] = options.range?.split(':');
+    if (!from || !to) {
+        logger.log(`Invalid range provided. Expected format is <from>:<to>`, { color: 'red' });
+        process.exit(1);
+    }
+    async function factory() {
+        const messages = await getCommitLogRange(from, to, { git, noMerges: true });
+        return messages;
+    }
+    async function parser(messages) {
+        const result = messages.join('\n');
+        return result;
+    }
+    const changelogMsg = await generateAndReviewLoop({
+        label: 'Changelog',
+        factory,
+        parser,
+        agent: async (context, options) => {
+            const prompt = getPrompt({
+                template: options.prompt,
+                variables: CHANGELOG_PROMPT.inputVariables,
+                fallback: CHANGELOG_PROMPT,
+            });
+            return await executeChain({
+                llm: model,
+                prompt,
+                variables: { summary: context },
+            });
+        },
+        noResult: async () => {
+            await noResult({ git, logger });
+            process.exit(0);
+        },
+        options: {
+            ...options,
+            prompt: options.prompt || CHANGELOG_PROMPT.template,
+            logger,
+            interactive: INTERACTIVE,
+        },
+    });
+    const MODE = (INTERACTIVE && 'interactive') || (options.commit && 'interactive') || options?.mode || 'stdout';
+    handleResult(changelogMsg, {
+        mode: MODE,
+        git,
+    });
+}
+
+/**
+ * Command line options via yargs
+ */
+const options = {
+    range: {
+        type: 'string',
+        alias: 'r',
+        description: 'Commit range e.g `HEAD~2:HEAD`',
+        demandOption: true,
+    },
+    model: { type: 'string', description: 'LLM/Model-Name' },
+    openAIApiKey: {
+        type: 'string',
+        description: 'OpenAI API Key',
+        conflicts: 'huggingFaceHubApiKey',
+    },
+    huggingFaceHubApiKey: {
+        type: 'string',
+        description: 'HuggingFace Hub API Key',
+        conflicts: 'openAIApiKey',
+    },
+    tokenLimit: { type: 'number', description: 'Token limit' },
+    prompt: {
+        type: 'string',
+        alias: 'p',
+        description: 'Prompt for llm',
+    },
+    i: {
+        type: 'boolean',
+        alias: 'interactive',
+        description: 'Toggle interactive mode',
+    },
+    e: {
+        type: 'boolean',
+        alias: 'edit',
+        description: 'Open generated changelog message in editor before proceeding',
+    },
+    summarizePrompt: {
+        type: 'string',
+        description: 'Prompt for summarizing large files',
+    },
+    ignoredFiles: {
+        type: 'array',
+        description: 'Ignored files',
+    },
+    ignoredExtensions: {
+        type: 'array',
+        description: 'Ignored extensions',
+    },
+};
+const builder = (yargs) => {
+    return yargs.options(options);
+};
+
+var changelog = {
+    command: 'changelog',
+    desc: 'Generate a changelog from a commit range',
     builder,
     handler,
     options,
 };
 
-yargs.scriptName('coco').usage('$0 <cmd> [args]').command([commit.command, '$0'], commit.desc, 
+yargs
+    .scriptName('coco')
+    .usage('$0 <cmd> [args]')
+    .command([commit.command, '$0'], commit.desc, 
+// TODO: fix type on builder
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+commit.builder, commit.handler)
+    .command(changelog.command, changelog.desc, 
 // TODO: fix type on builder
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
-commit.builder, commit.handler).argv;
+changelog.builder, changelog.handler)
+    .demandCommand()
+    .help().argv;
 //# sourceMappingURL=index.esm.mjs.map