git-coco 0.10.1 → 0.11.1

package/dist/index.esm.mjs

@@ -6,32 +6,32 @@ import * as fs from 'fs';
 import fs__default from 'fs';
 import { confirm, editor, select, password, input } from '@inquirer/prompts';
 import chalk from 'chalk';
+import * as ini from 'ini';
 import * as os from 'os';
 import os__default from 'os';
 import * as path from 'path';
 import path__default from 'path';
-import * as ini from 'ini';
 import Ajv from 'ajv';
 import ora from 'ora';
 import now from 'performance-now';
 import prettyMilliseconds from 'pretty-ms';
+import { BaseOutputParser, JsonOutputParser } from '@langchain/core/output_parsers';
+import { ChatOllama } from '@langchain/ollama';
+import { ChatOpenAI } from '@langchain/openai';
 import pQueue from 'p-queue';
 import { Document, BaseDocumentTransformer } from '@langchain/core/documents';
 import { RUN_KEY } from '@langchain/core/outputs';
 import { CallbackManager, parseCallbackConfigArg } from '@langchain/core/callbacks/manager';
 import { ensureConfig, Runnable } from '@langchain/core/runnables';
 import { BaseLangChain, BaseLanguageModel } from '@langchain/core/language_models/base';
-import { BaseOutputParser } from '@langchain/core/output_parsers';
 import '@langchain/core/messages';
 import '@langchain/core/memory';
 import '@langchain/core/chat_history';
 import '@langchain/core/utils/tiktoken';
-import { ChatOpenAI } from '@langchain/openai';
 import '@langchain/core/utils/async_caller';
 import '@langchain/core/utils/env';
 import '@langchain/core/utils/json_patch';
 import { createTwoFilesPatch } from 'diff';
-import { ChatOllama } from '@langchain/ollama';
 import { minimatch } from 'minimatch';
 import { simpleGit } from 'simple-git';
 import { encoding_for_model } from 'tiktoken';
@@ -107,9 +107,9 @@ function getDefaultServiceApiKey(config) {
 }
 const DEFAULT_OPENAI_LLM_SERVICE = {
     provider: 'openai',
-    model: 'gpt-4-turbo',
+    model: 'gpt-4',
     tokenLimit: 2024,
-    temperature: 0.4,
+    temperature: 0.32,
     authentication: {
         type: 'APIKey',
         credentials: {
@@ -259,12 +259,35 @@ function loadEnvConfig(config) {
         if (envValue === undefined) {
             return;
         }
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        envConfig[key] = envValue;
+        if (key === 'COCO_SERVICE_PROVIDER' || key === 'COCO_SERVICE_MODEL' || key === 'OPEN_AI_KEY') {
+            // NOTE: We want to ensure that the service object is always defined
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            envConfig.service = envConfig.service || {};
+            handleServiceEnvVar(envConfig.service, key, envValue);
+        }
+        else {
+            envConfig[key] = envValue;
+        }
     });
     return { ...config, ...removeUndefined(envConfig) };
 }
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function handleServiceEnvVar(service, key, value) {
+    switch (key) {
+        case 'COCO_SERVICE_PROVIDER':
+            service.provider = value;
+            break;
+        case 'COCO_SERVICE_MODEL':
+            service.model = value;
+            break;
+        case 'OPEN_AI_KEY':
+            if (service.provider === 'openai') {
+                service.fields = { apiKey: value };
+            }
+            break;
+    }
+}
 function parseEnvValue(key, value) {
     switch (true) {
         // Handle undefined values
@@ -343,7 +366,12 @@ function loadGitConfig(config) {
     if (fs.existsSync(gitConfigPath)) {
         const gitConfigRaw = fs.readFileSync(gitConfigPath, 'utf-8');
         const gitConfigParsed = ini.parse(gitConfigRaw);
-        const service = gitConfigParsed.coco?.service || config.service;
+        const gitServiceAlias = gitConfigParsed.coco?.service;
+        let service = config.service;
+        if (gitServiceAlias) {
+            const gitServiceConfig = getDefaultServiceConfigFromAlias(gitServiceAlias);
+            service = parseServiceConfig$1(gitServiceConfig || config.service);
+        }
         config = {
             ...config,
             service: service,
@@ -358,6 +386,28 @@ function loadGitConfig(config) {
     }
     return removeUndefined(config);
 }
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function parseServiceConfig$1(service) {
+    if (!service)
+        return undefined;
+    switch (service.provider) {
+        case 'openai':
+            return {
+                provider: 'openai',
+                model: service.model,
+                fields: { apiKey: service.apiKey },
+            };
+        case 'ollama':
+            return {
+                provider: 'ollama',
+                model: service.model,
+                endpoint: service.endpoint,
+                fields: service.fields,
+            };
+        default:
+            return undefined;
+    }
+}
 /**
  * Appends the provided configuration to a git config file.
  *
@@ -1732,10 +1782,42 @@ function loadXDGConfig(config) {
     const xdgConfigPath = path.join(xdgConfigHome, 'coco', 'config.json');
     if (fs.existsSync(xdgConfigPath)) {
         const xdgConfig = JSON.parse(fs.readFileSync(xdgConfigPath, 'utf-8'));
-        config = { ...config, ...xdgConfig };
+        const service = parseServiceConfig(xdgConfig.service || config.service);
+        config = {
+            ...config,
+            ...xdgConfig,
+            service: service
+        };
     }
     return config;
 }
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function parseServiceConfig(service) {
+    if (!service)
+        return undefined;
+    switch (service.provider) {
+        case 'openai':
+            return {
+                provider: 'openai',
+                model: service.model,
+                authentication: {
+                    type: 'APIKey',
+                    credentials: {
+                        apiKey: service.apiKey
+                    }
+                }
+            };
+        case 'ollama':
+            return {
+                provider: 'ollama',
+                model: service.model,
+                endpoint: service.endpoint,
+                fields: service.fields
+            };
+        default:
+            return undefined;
+    }
+}
 
 /**
  * Load application config
@@ -1833,6 +1915,66 @@ function commandExecutor(handler) {
     };
 }
 
+const executeChain = async ({ llm, prompt, variables, parser, }) => {
+    if (!llm || !prompt || !variables) {
+        throw new Error('The input parameters "llm", "prompt", and "variables" are all required.');
+    }
+    const chain = prompt.pipe(llm).pipe(parser);
+    let res;
+    try {
+        res = await chain.invoke(variables);
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            throw new Error(`LLMChain call error: ${error.message}`);
+        }
+    }
+    if (!res) {
+        throw new Error('Empty response from LLMChain call');
+    }
+    return res;
+};
+
+/**
+ * Get LLM Model Based on Configuration
+ *
+ * @param fields
+ * @param configuration
+ * @returns LLM Model
+ */
+function getLlm(provider, model, config) {
+    if (!model) {
+        throw new Error(`Invalid LLM Service: ${provider}/${model}`);
+    }
+    switch (provider) {
+        case 'ollama':
+            return new ChatOllama({
+                baseUrl: DEFAULT_OLLAMA_LLM_SERVICE.endpoint,
+                maxConcurrency: config.service.maxConcurrent,
+                model,
+            });
+        case 'openai':
+        default:
+            const openAiModel = new ChatOpenAI({
+                openAIApiKey: getApiKeyForModel(config),
+                model,
+                temperature: config.service.temperature || 0.2,
+            });
+            return openAiModel;
+    }
+}
+
+function getPrompt({ template, variables, fallback }) {
+    if (!template && !fallback)
+        throw new Error('Must provide either a template or a fallback');
+    return (template
+        ? new PromptTemplate({
+            template,
+            inputVariables: variables,
+        })
+        : fallback);
+}
+
 /**
  * Extract the path from a file path string.
  * @param {string} filePath - The full file path.
@@ -5416,64 +5558,15 @@ async function fileChangeParser({ changes, commit, options: { tokenizer, git, ll
     return summary;
 }
 
-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 and a longer detailed summary no more than 300 characters, the shorter and more concise the better.  The detailed summary should be separated from the short description by a blank line.  Please follow the guidelines below when writing your commit message:
-
-- Write concisely using an informal tone
-- DO NOT use phrases like "this commit", "this change", "this function", etc. Instead refer to the function, variable, or class by name
-- DO NOT use specific names or files from the code
-- DO NOT include any diffs or file changes in the commit message
-- Wrap variable, class, function, components, and dependency names in back ticks e.g. \`variable\`
-- ONLY respond with the resulting commit message.
-
---------
-{summary}
---------
-
-COMMIT MESSAGE:`;
-const inputVariables$1 = ['summary'];
-const COMMIT_PROMPT = new PromptTemplate({
-    template: template$1,
-    inputVariables: inputVariables$1,
-});
-
 /**
- * Get LLM Model Based on Configuration
+ * Creates a commit with the specified commit message.
  *
- * @param fields
- * @param configuration
- * @returns LLM Model
+ * @param message The commit message.
+ * @param git The SimpleGit instance.
+ * @returns A Promise that resolves to the CommitResult.
  */
-function getLlm(provider, model, config) {
-    if (!model) {
-        throw new Error(`Invalid LLM Service: ${provider}/${model}`);
-    }
-    switch (provider) {
-        case 'ollama':
-            return new ChatOllama({
-                baseUrl: DEFAULT_OLLAMA_LLM_SERVICE.endpoint,
-                maxConcurrency: config.service.maxConcurrent,
-                model,
-            });
-        case 'openai':
-        default:
-            const openAiModel = new ChatOpenAI({
-                openAIApiKey: getApiKeyForModel(config),
-                model,
-            });
-            return openAiModel;
-    }
-}
-
-function getPrompt({ template, variables, fallback }) {
-    if (!template && !fallback)
-        throw new Error('Must provide either a template or a fallback');
-    return (template
-        ? new PromptTemplate({
-            template,
-            inputVariables: variables,
-        })
-        : fallback);
+async function createCommit(message, git) {
+    return await git.commit(message);
 }
 
 /**
@@ -5605,37 +5698,66 @@ async function getChanges({ git, options }) {
     };
 }
 
-async function noResult({ git, logger }) {
-    const { staged, unstaged, untracked } = await getChanges({ git });
-    const hasStaged = staged && staged.length > 0;
-    const hasUnstaged = unstaged && unstaged.length > 0;
-    const hasUntracked = untracked && untracked.length > 0;
-    if (hasStaged) {
-        logger.log(`Staged files detected, but no summary generated...`, { color: 'red' });
-        logger.log(`Files are likely either:\n  • changed files are ignored\n  • file diff is too large.`, { color: 'yellow' });
+/**
+ * Retrieves the SimpleGit instance for the repository.
+ * @returns {SimpleGit} The SimpleGit instance.
+ */
+const getRepo = () => {
+    let git;
+    try {
+        git = simpleGit();
     }
-    else if (hasUnstaged || hasUntracked) {
-        logger.log('Forget something? No staged changes found... 👻', { color: 'red' });
-        if (hasUnstaged) {
-            logger.log('\nChanges not staged for commit:', { color: 'yellow' });
-            logger.verbose(`\t${unstaged.map(({ summary }) => summary).join('\n\t')}`, {
-                color: 'red',
-            });
-        }
-        if (hasUntracked) {
-            logger.log('\nUntracked changes:', { color: 'yellow' });
-            logger.verbose(`\t${untracked.map(({ summary }) => summary).join('\n\t')}`, {
-                color: 'red',
-            });
-        }
+    catch (e) {
+        console.log('Error initializing git repo', e);
+        process.exit(1);
     }
-    else {
-        logger.log('No repo changes detected. 👀', { color: 'blue' });
+    return git;
+};
+
+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 and a longer detailed summary no more than 300 characters, the shorter and more concise the better.  Please follow the guidelines below when writing your commit message:
+
+- Write concisely using an informal tone
+- DO NOT use phrases like "this commit", "this change", "this function", etc. Instead refer to the function, variable, or class by name
+- DO NOT use specific names or files from the code
+- DO NOT include any diffs or file changes in the commit message
+- Wrap variable, class, function, components, and dependency names in back ticks e.g. \`variable\`
+
+{format_instructions}
+
+"""{summary}"""`;
+const inputVariables$1 = ['summary', 'format_instructions'];
+const COMMIT_PROMPT = new PromptTemplate({
+    template: template$1,
+    inputVariables: inputVariables$1,
+});
+
+/**
+ * Verify template string contains all required input variables
+ *
+ * @param text template string
+ * @param inputVariables template variables
+ * @returns boolean or error message
+ */
+function validatePromptTemplate(text, inputVariables) {
+    if (!text) {
+        return 'Prompt template cannot be empty';
     }
+    if (!inputVariables.some((entry) => text.includes(entry))) {
+        return ('Prompt template must include at least one of the following input variables: ' +
+            inputVariables.map((value) => `{${value}}`).join(', '));
+    }
+    return true;
 }
 
-function logResult(label, result) {
-    console.log(`\n${chalk.bgBlue(chalk.bold(`Proposed ${label}:`))}\n${SEPERATOR}\n${result}\n${SEPERATOR}\n`);
+async function editPrompt(options) {
+    return await editor({
+        message: 'Edit the prompt',
+        default: options.prompt?.length ? options.prompt : COMMIT_PROMPT.template,
+        waitForUseInput: false,
+        postfix: 'Press ENTER to continue',
+        validate: (text) => validatePromptTemplate(text, COMMIT_PROMPT.inputVariables),
+    });
 }
 
 async function editResult(result, options) {
@@ -5697,32 +5819,8 @@ async function getUserReviewDecision({ label, descriptions, enableRetry = true,
     }));
 }
 
-/**
- * Verify template string contains all required input variables
- *
- * @param text template string
- * @param inputVariables template variables
- * @returns boolean or error message
- */
-function validatePromptTemplate(text, inputVariables) {
-    if (!text) {
-        return 'Prompt template cannot be empty';
-    }
-    if (!inputVariables.some((entry) => text.includes(entry))) {
-        return ('Prompt template must include at least one of the following input variables: ' +
-            inputVariables.map((value) => `{${value}}`).join(', '));
-    }
-    return true;
-}
-
-async function editPrompt(options) {
-    return await editor({
-        message: 'Edit the prompt',
-        default: options.prompt?.length ? options.prompt : COMMIT_PROMPT.template,
-        waitForUseInput: false,
-        postfix: 'Press ENTER to continue',
-        validate: (text) => validatePromptTemplate(text, COMMIT_PROMPT.inputVariables),
-    });
+function logResult(label, result) {
+    console.log(`\n${chalk.bgBlue(chalk.bold(`Proposed ${label}:`))}\n${SEPERATOR}\n${result}\n${SEPERATOR}\n`);
 }
 
 async function generateAndReviewLoop({ label, factory, parser, noResult, agent, options, }) {
@@ -5733,7 +5831,7 @@ async function generateAndReviewLoop({ label, factory, parser, noResult, agent,
     let result = '';
     const changes = await factory();
     // if we don't have any changes, bail.
-    if (!changes || !changes.length) {
+    if (!changes || !Object.keys(changes).length) {
         await noResult(options);
     }
     while (continueLoop) {
@@ -5768,7 +5866,7 @@ async function generateAndReviewLoop({ label, factory, parser, noResult, agent,
             logResult(label, result);
             const reviewAnswer = await getUserReviewDecision({
                 label,
-                ...options?.review || {},
+                ...(options?.review || {}),
             });
             if (reviewAnswer === 'cancel') {
                 process.exit(0);
@@ -5800,26 +5898,6 @@ async function generateAndReviewLoop({ label, factory, parser, noResult, agent,
     return result;
 }
 
-const executeChain = async ({ llm, prompt, variables }) => {
-    if (!llm || !prompt || !variables) {
-        throw new Error('The input parameters "llm", "prompt", and "variables" are all required.');
-    }
-    const chain = prompt.pipe(llm);
-    let res;
-    try {
-        res = await chain.invoke(variables);
-    }
-    catch (error) {
-        if (error instanceof Error) {
-            throw new Error(`LLMChain call error: ${error.message}`);
-        }
-    }
-    if (!res) {
-        throw new Error('Empty response from LLMChain call');
-    }
-    return res.content;
-};
-
 const logSuccess = () => {
     console.log(chalk.green(chalk.bold('\nAll set! 🦾🤖')));
 };
@@ -5843,22 +5921,6 @@ async function handleResult({ result, mode, interactiveHandler }) {
     process.exit(0);
 }
 
-/**
- * Retrieves the SimpleGit instance for the repository.
- * @returns {SimpleGit} The SimpleGit instance.
- */
-const getRepo = () => {
-    let git;
-    try {
-        git = simpleGit();
-    }
-    catch (e) {
-        console.log('Error initializing git repo', e);
-        process.exit(1);
-    }
-    return git;
-};
-
 /**
  * Retrieves a TikToken for the specified model.
  *
@@ -5881,15 +5943,33 @@ const getTokenCounter = async (modelName) => {
     });
 };
 
-/**
- * Creates a commit with the specified commit message.
- *
- * @param message The commit message.
- * @param git The SimpleGit instance.
- * @returns A Promise that resolves to the CommitResult.
- */
-async function createCommit(message, git) {
-    return await git.commit(message);
+async function noResult({ git, logger }) {
+    const { staged, unstaged, untracked } = await getChanges({ git });
+    const hasStaged = staged && staged.length > 0;
+    const hasUnstaged = unstaged && unstaged.length > 0;
+    const hasUntracked = untracked && untracked.length > 0;
+    if (hasStaged) {
+        logger.log(`Staged files detected, but no summary generated...`, { color: 'red' });
+        logger.log(`Files are likely either:\n  • changed files are ignored\n  • file diff is too large.`, { color: 'yellow' });
+    }
+    else if (hasUnstaged || hasUntracked) {
+        logger.log('Forget something? No staged changes found... 👻', { color: 'red' });
+        if (hasUnstaged) {
+            logger.log('\nChanges not staged for commit:', { color: 'yellow' });
+            logger.verbose(`\t${unstaged.map(({ summary }) => summary).join('\n\t')}`, {
+                color: 'red',
+            });
+        }
+        if (hasUntracked) {
+            logger.log('\nUntracked changes:', { color: 'yellow' });
+            logger.verbose(`\t${untracked.map(({ summary }) => summary).join('\n\t')}`, {
+                color: 'red',
+            });
+        }
+    }
+    else {
+        logger.log('No repo changes detected. 👀', { color: 'blue' });
+    }
 }
 
 const handler$2 = async (argv, logger) => {
@@ -5938,16 +6018,20 @@ const handler$2 = async (argv, logger) => {
         factory,
         parser,
         agent: async (context, options) => {
+            const parser = new JsonOutputParser();
             const prompt = getPrompt({
                 template: options.prompt,
                 variables: COMMIT_PROMPT.inputVariables,
                 fallback: COMMIT_PROMPT,
             });
-            return await executeChain({
+            const formatInstructions = "Respond with a valid JSON object, containing two fields: 'title' and 'body'.";
+            const commitMsg = await executeChain({
                 llm,
                 prompt,
-                variables: { summary: context },
+                variables: { summary: context, format_instructions: formatInstructions },
+                parser,
             });
+            return `${commitMsg.title}\n\n${commitMsg.body}`;
         },
         noResult: async () => {
             await noResult({ git, logger });
@@ -6020,20 +6104,6 @@ var commit = {
     options: options$2,
 };
 
-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,
-});
-
 /**
  * Retrieves the commit log range between two specified commits.
  *
@@ -6047,7 +6117,7 @@ async function getCommitLogRange(from, to, { noMerges, git }) {
     try {
         const logOptions = { from: `${from}^1`, to, '--no-merges': noMerges };
         const commitLog = await git.log(logOptions);
-        return commitLog.all.map(({ message, date, body, author_name }) => `[${date}] ${message}\n${body}\n - ${author_name}`);
+        return commitLog.all.map(({ message, date, body, author_name, hash, author_email }) => `[${date}] ${message}\n${body}\n(${hash}) - ${author_name}<${author_email}>`);
     }
     catch (error) {
         // If there's an error, handle it appropriately
@@ -6118,6 +6188,20 @@ async function getCommitLogCurrentBranch({ git, logger, comparisonBranch = 'main
     return [];
 }
 
+const template = `Write informative git changelog, in the imperative, based on a series of individual messages.
+
+- Include the git commit hash as reference for each change, including just the first 7 characters
+- Logically group changes, and if necessary, summarize dependency updates
+
+{format_instructions}
+
+"""{summary}"""`;
+const inputVariables = ['format_instructions', 'summary'];
+const CHANGELOG_PROMPT = new PromptTemplate({
+    template,
+    inputVariables,
+});
+
 const handler$1 = async (argv, logger) => {
     const config = loadConfig(argv);
     const git = getRepo();
@@ -6133,19 +6217,27 @@ const handler$1 = async (argv, logger) => {
         logger.log(LOGO);
     }
     async function factory() {
+        const branchName = await getCurrentBranchName({ git });
         if (config.range && config.range.includes(':')) {
             const [from, to] = config.range.split(':');
             if (!from || !to) {
                 logger.log(`Invalid range provided. Expected format is <from>:<to>`, { color: 'red' });
                 process.exit(1);
             }
-            return await getCommitLogRange(from, to, { git, noMerges: true });
+            return {
+                branch: branchName,
+                commits: await getCommitLogRange(from, to, { git, noMerges: true }),
+            };
         }
         logger.verbose(`No range provided. Defaulting to current branch`, { color: 'yellow' });
-        return await getCommitLogCurrentBranch({ git, logger });
+        return {
+            branch: branchName,
+            commits: await getCommitLogCurrentBranch({ git, logger }),
+        };
     }
-    async function parser(messages) {
-        const result = messages.join('\n');
+    async function parser({ branch, commits }) {
+        const result = `## ${branch}\n\n${commits.map((commit) => `${commit}`).join('\n\n\n')}`;
+        console.log({ result });
         return result;
     }
     const changelogMsg = await generateAndReviewLoop({
@@ -6153,16 +6245,23 @@ const handler$1 = async (argv, logger) => {
         factory,
         parser,
         agent: async (context, options) => {
+            const parser = new JsonOutputParser();
             const prompt = getPrompt({
                 template: options.prompt,
                 variables: CHANGELOG_PROMPT.inputVariables,
                 fallback: CHANGELOG_PROMPT,
             });
-            return await executeChain({
+            const formatInstructions = "Respond with a valid JSON object, containing two fields: 'header' and 'content', both strings.";
+            const changelog = await executeChain({
                 llm,
                 prompt,
-                variables: { summary: context },
+                variables: {
+                    summary: context,
+                    format_instructions: formatInstructions,
+                },
+                parser,
             });
+            return `${changelog.header}\n\n${changelog.content}`;
         },
         noResult: async () => {
             if (config.range) {
@@ -6201,17 +6300,6 @@ const options$1 = {
         alias: 'r',
         description: 'Commit range e.g `HEAD~2:HEAD`',
     },
-    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',
@@ -6232,14 +6320,6 @@ const options$1 = {
         type: 'string',
         description: 'Prompt for summarizing large files',
     },
-    ignoredFiles: {
-        type: 'array',
-        description: 'Ignored files',
-    },
-    ignoredExtensions: {
-        type: 'array',
-        description: 'Ignored extensions',
-    },
 };
 const builder$1 = (yargs) => {
     return yargs.options(options$1);