git-coco 0.15.1 → 0.16.0

package/dist/index.d.ts

@@ -140,6 +140,13 @@ type BaseConfig = {
      * @default 'main'
      */
     defaultBranch: string;
+    /**
+     * Whether to include the current branch name in the commit prompt for context.
+     * When enabled, the current git branch name will be included in the prompt.
+     *
+     * @default true
+     */
+    includeBranchName?: boolean;
 };
 type ConfigWithServiceObject = BaseConfig & Partial<BaseCommandOptions> & {
     service: LLMService;
@@ -177,6 +184,7 @@ interface CommitOptions extends BaseCommandOptions {
     ignoredExtensions: string[];
     withPreviousCommits: number;
     conventional: boolean;
+    includeBranchName: boolean;
 }
 type CommitArgv = Arguments<CommitOptions>;
 

package/dist/index.esm.mjs

@@ -47,7 +47,7 @@ import { lint, load } from '@commitlint/core';
 /**
  * Current build version from package.json
  */
-const BUILD_VERSION = "0.15.1";
+const BUILD_VERSION = "0.16.0";
 
 const isInteractive = (config) => {
     return config?.mode === 'interactive' || !!config?.interactive;
@@ -610,6 +610,11 @@ const schema$1 = {
                     "type": "string",
                     "description": "Default git branch for the repository.",
                     "default": "main"
+                },
+                "includeBranchName": {
+                    "type": "boolean",
+                    "description": "Whether to include the current branch name in the commit prompt for context. When enabled, the current git branch name will be included in the prompt.",
+                    "default": true
                 }
             },
             "required": [
@@ -6534,6 +6539,7 @@ const getRepo = () => {
  * - format_instructions: Instructions for the output format (JSON with title and body)
  * - additional_context: Optional user-provided context to guide the commit message generation
  * - commit_history: Optional history of previous commits for context
+ * - branch_name_context: String containing formatted branch name (or empty if disabled)
  */
 const template$4 = `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 around 300 characters, the shorter and more concise the better.
@@ -6550,6 +6556,8 @@ Please follow the guidelines below when writing your commit message:
 {{summary}}
 """"""
 
+{{branch_name_context}}
+
 {{format_instructions}}
 
 {{commit_history}}
@@ -6557,7 +6565,7 @@ Please follow the guidelines below when writing your commit message:
 {{additional_context}}
 `;
 // Define the variables that will be passed to the prompt template
-const inputVariables$3 = ['summary', 'format_instructions', 'additional_context', 'commit_history'];
+const inputVariables$3 = ['summary', 'format_instructions', 'additional_context', 'commit_history', 'branch_name_context'];
 const COMMIT_PROMPT = new PromptTemplate({
     template: template$4,
     inputVariables: inputVariables$3,
@@ -6597,6 +6605,8 @@ Based on the following diff summary, generate a conventional commit message that
 {{summary}}
 """"""
 
+{{branch_name_context}}
+
 {{format_instructions}}
 
 {{commit_history}}
@@ -6613,6 +6623,7 @@ const conventionalInputVariables = [
     'additional_context',
     'commit_history',
     'format_instructions',
+    'branch_name_context',
 ];
 const CONVENTIONAL_COMMIT_PROMPT = new PromptTemplate({
     template: CONVENTIONAL_TEMPLATE,
@@ -7029,6 +7040,11 @@ const options$3 = {
         default: false,
         alias: 'c',
     },
+    includeBranchName: {
+        description: 'Include the current branch name in the commit prompt for context',
+        type: 'boolean',
+        default: true,
+    },
 };
 const builder$3 = (yargs) => {
     return yargs.options(options$3).usage(getCommandUsageHeader(command$3));
@@ -10951,22 +10967,32 @@ const handler$3 = async (argv, logger) => {
                     commit_history = `## Commit History\n${commitHistoryData}`;
                 }
             }
+            // Get current branch name - we need this for ticket extraction regardless of prompt inclusion
+            const branchName = await getCurrentBranchName({ git });
+            // Check if branch name should be included in the prompt context
+            const includeBranchName = argv.includeBranchName !== undefined
+                ? argv.includeBranchName
+                : config.includeBranchName !== false; // Default to true if not explicitly set to false
+            // Create branch name context string based on the configuration
+            const branchNameContext = includeBranchName ? `Current git branch name: ${branchName}` : '';
+            // Get variables for the prompt
+            const variables = {
+                summary: context,
+                format_instructions: formatInstructions,
+                additional_context: additional_context,
+                commit_history: commit_history,
+                branch_name_context: branchNameContext,
+            };
             console.log('context', context);
             console.log('prompt', prompt);
             const commitMsg = await executeChain({
                 llm,
                 prompt,
-                variables: {
-                    summary: context,
-                    format_instructions: formatInstructions,
-                    additional_context: additional_context,
-                    commit_history: commit_history,
-                },
+                variables,
                 parser,
             });
             // Construct the full commit message
             const appendedText = argv.append ? `\n\n${argv.append}` : '';
-            const branchName = await getCurrentBranchName({ git });
             const ticketId = extractTicketIdFromBranchName(branchName);
             const ticketFooter = argv.appendTicket && ticketId ? `\n\nPart of **${ticketId}**` : '';
             const fullMessage = `${commitMsg.title}\n\n${commitMsg.body}${appendedText}${ticketFooter}`;

package/dist/index.js

@@ -69,7 +69,7 @@ var readline__namespace = /*#__PURE__*/_interopNamespaceDefault(readline$1);
 /**
  * Current build version from package.json
  */
-const BUILD_VERSION = "0.15.1";
+const BUILD_VERSION = "0.16.0";
 
 const isInteractive = (config) => {
     return config?.mode === 'interactive' || !!config?.interactive;
@@ -632,6 +632,11 @@ const schema$1 = {
                     "type": "string",
                     "description": "Default git branch for the repository.",
                     "default": "main"
+                },
+                "includeBranchName": {
+                    "type": "boolean",
+                    "description": "Whether to include the current branch name in the commit prompt for context. When enabled, the current git branch name will be included in the prompt.",
+                    "default": true
                 }
             },
             "required": [
@@ -6556,6 +6561,7 @@ const getRepo = () => {
  * - format_instructions: Instructions for the output format (JSON with title and body)
  * - additional_context: Optional user-provided context to guide the commit message generation
  * - commit_history: Optional history of previous commits for context
+ * - branch_name_context: String containing formatted branch name (or empty if disabled)
  */
 const template$4 = `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 around 300 characters, the shorter and more concise the better.
@@ -6572,6 +6578,8 @@ Please follow the guidelines below when writing your commit message:
 {{summary}}
 """"""
 
+{{branch_name_context}}
+
 {{format_instructions}}
 
 {{commit_history}}
@@ -6579,7 +6587,7 @@ Please follow the guidelines below when writing your commit message:
 {{additional_context}}
 `;
 // Define the variables that will be passed to the prompt template
-const inputVariables$3 = ['summary', 'format_instructions', 'additional_context', 'commit_history'];
+const inputVariables$3 = ['summary', 'format_instructions', 'additional_context', 'commit_history', 'branch_name_context'];
 const COMMIT_PROMPT = new prompts$1.PromptTemplate({
     template: template$4,
     inputVariables: inputVariables$3,
@@ -6619,6 +6627,8 @@ Based on the following diff summary, generate a conventional commit message that
 {{summary}}
 """"""
 
+{{branch_name_context}}
+
 {{format_instructions}}
 
 {{commit_history}}
@@ -6635,6 +6645,7 @@ const conventionalInputVariables = [
     'additional_context',
     'commit_history',
     'format_instructions',
+    'branch_name_context',
 ];
 const CONVENTIONAL_COMMIT_PROMPT = new prompts$1.PromptTemplate({
     template: CONVENTIONAL_TEMPLATE,
@@ -7051,6 +7062,11 @@ const options$3 = {
         default: false,
         alias: 'c',
     },
+    includeBranchName: {
+        description: 'Include the current branch name in the commit prompt for context',
+        type: 'boolean',
+        default: true,
+    },
 };
 const builder$3 = (yargs) => {
     return yargs.options(options$3).usage(getCommandUsageHeader(command$3));
@@ -10973,22 +10989,32 @@ const handler$3 = async (argv, logger) => {
                     commit_history = `## Commit History\n${commitHistoryData}`;
                 }
             }
+            // Get current branch name - we need this for ticket extraction regardless of prompt inclusion
+            const branchName = await getCurrentBranchName({ git });
+            // Check if branch name should be included in the prompt context
+            const includeBranchName = argv.includeBranchName !== undefined
+                ? argv.includeBranchName
+                : config.includeBranchName !== false; // Default to true if not explicitly set to false
+            // Create branch name context string based on the configuration
+            const branchNameContext = includeBranchName ? `Current git branch name: ${branchName}` : '';
+            // Get variables for the prompt
+            const variables = {
+                summary: context,
+                format_instructions: formatInstructions,
+                additional_context: additional_context,
+                commit_history: commit_history,
+                branch_name_context: branchNameContext,
+            };
             console.log('context', context);
             console.log('prompt', prompt);
             const commitMsg = await executeChain({
                 llm,
                 prompt,
-                variables: {
-                    summary: context,
-                    format_instructions: formatInstructions,
-                    additional_context: additional_context,
-                    commit_history: commit_history,
-                },
+                variables,
                 parser,
             });
             // Construct the full commit message
             const appendedText = argv.append ? `\n\n${argv.append}` : '';
-            const branchName = await getCurrentBranchName({ git });
             const ticketId = extractTicketIdFromBranchName(branchName);
             const ticketFooter = argv.appendTicket && ticketId ? `\n\nPart of **${ticketId}**` : '';
             const fullMessage = `${commitMsg.title}\n\n${commitMsg.body}${appendedText}${ticketFooter}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-coco",
-  "version": "0.15.1",
+  "version": "0.16.0",
   "description": "zero-effort git commits with coco.",
   "author": "gfargo <ghfargo@gmail.com>",
   "license": "MIT",
@@ -93,7 +93,7 @@
     "@langchain/community": "^0.3.32",
     "@langchain/core": "^0.3.40",
     "@langchain/ollama": "^0.2.0",
-    "@langchain/openai": "^0.4.4",
+    "@langchain/openai": "^0.5.0",
     "ajv": "^8.16.0",
     "ajv-formats": "^3.0.1",
     "chalk": "4.1.2",