git-coco 0.13.0 → 0.13.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 gfargo
+Copyright (c) 2024 gfargo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -14,6 +14,8 @@
 
 - **`changelog`**: create changelogs for the current branch or a range of commits.
 
+- **`recap`**: summarize changes from working-tree, or yesterday, or in the last month, or since the last tag!
+
 - **`init`**: step by step wizard to set up `coco` globally or for a project.
 
 ## Getting Started
@@ -42,6 +44,24 @@ coco
 coco commit
 ```
 
+#### Useful options
+
+ 
+```bash
+# --append
+# Add content to the end of the generated commit
+coco --append "Resolves #128"
+
+# --append-ticket
+# Automatically append Jira/Linear ticket ID from the branch name to the commit message 
+coco --append-ticket
+
+# --additional
+# Add extra context before generating the commit
+coco --additional "Resolves UX bug with sign up button"
+```
+
+
 ### **`coco changelog`**
 
 Creates changelogs.
@@ -52,8 +72,22 @@ coco changelog
 
 # For a specific range
 coco changelog -r HEAD~5:HEAD
+
+# For a target branch
+coco changelog -b other-branch
 ```
 
+### **`coco recap`**
+
+Summarize the working-tree, or other configured ranges
+
+```bash
+# Summarize all working directory changes
+coco recap
+
+# Or these available ranges
+coco recap --yesterday | --last-week | --last-month | --last-tag
+```
 
 ### Stdout vs. Interactive Mode
 
@@ -87,3 +121,11 @@ You can specify files to be ignored when generating commit messages by adding th
 ## Contribution
 
 We welcome contributions! Check out our [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
+
+## Project Stats
+
+![Alt](https://repobeats.axiom.co/api/embed/ea76b881139f16595a343046d4f2bc9125a47e26.svg "Repobeats analytics image")
+
+## License
+
+MIT © [gfargo](https://github.com/gfargo/)

package/dist/index.d.ts

@@ -195,9 +195,9 @@ declare const _default$1: {
 
 interface RecapOptions extends BaseCommandOptions {
     yesterday?: boolean;
-    "last-week"?: boolean;
-    "last-month"?: boolean;
-    "last-tag"?: boolean;
+    'last-week'?: boolean;
+    'last-month'?: boolean;
+    'last-tag'?: boolean;
 }
 type RecapArgv = Arguments<RecapOptions>;
 

package/dist/index.esm.mjs

@@ -4,7 +4,7 @@ import { ConditionalPromptSelector, isChatModel } from '@langchain/core/example_
 import yargs from 'yargs';
 import chalk from 'chalk';
 import * as fs from 'fs';
-import fs__default from 'fs';
+import fs__default, { promises } from 'fs';
 import { confirm, editor, select, password, input } from '@inquirer/prompts';
 import * as ini from 'ini';
 import * as os from 'os';
@@ -55,7 +55,7 @@ const getCommandUsageHeader = (command) => {
     return chalk.green(`${USAGE_BANNER}\n${chalk.white('Command:')}\n\xa0\xa0\xa0\xa0\xa0 $0 ${chalk.greenBright(command)} [options]`);
 };
 const CONFIG_ALREADY_EXISTS = (path) => {
-    return `coco config found in '${path}', do you want to override it?`;
+    return `existing config found in '${path}', do you want to override it?`;
 };
 
 /**
@@ -376,11 +376,11 @@ function loadGitConfig(config) {
     if (fs.existsSync(gitConfigPath)) {
         const gitConfigRaw = fs.readFileSync(gitConfigPath, 'utf-8');
         const gitConfigParsed = ini.parse(gitConfigRaw);
-        const gitServiceAlias = gitConfigParsed.coco?.service;
+        const gitConfigServiceObject = gitConfigParsed.coco?.service;
         let service = config.service;
-        if (gitServiceAlias) {
-            const gitServiceConfig = getDefaultServiceConfigFromAlias(gitServiceAlias);
-            service = parseServiceConfig$1(gitServiceConfig || config.service);
+        if (gitConfigServiceObject) {
+            const gitServiceConfig = JSON.parse(gitConfigServiceObject);
+            service = gitServiceConfig || config?.service;
         }
         config = {
             ...config,
@@ -391,32 +391,11 @@ function loadGitConfig(config) {
             ignoredFiles: gitConfigParsed.coco?.ignoredFiles || config.ignoredFiles,
             ignoredExtensions: gitConfigParsed.coco?.ignoredExtensions || config.ignoredExtensions,
             defaultBranch: gitConfigParsed.coco?.defaultBranch || config.defaultBranch,
+            verbose: gitConfigParsed.coco?.verbose || config.verbose,
         };
     }
     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.
  *
@@ -431,15 +410,18 @@ const appendToGitConfig = async (filePath, config) => {
     const getNewContent = async () => {
         const contentLines = [header];
         for (const key in config) {
-            // check if string has new lines, if so, wrap in quotes
-            if (typeof config[key] === 'string') {
-                const value = config[key];
-                if (value.includes('\n')) {
-                    contentLines.push(`\t${key} = ${JSON.stringify(value)}`);
-                    continue;
-                }
+            const value = config[key];
+            if (typeof value === 'object') {
+                // Serialize object to JSON string
+                contentLines.push(`\t${key} = ${JSON.stringify(value)}`);
+            }
+            else if (typeof value === 'string' && value.includes('\n')) {
+                // Wrap strings with new lines in quotes
+                contentLines.push(`\t${key} = ${JSON.stringify(value)}`);
+            }
+            else {
+                contentLines.push(`\t${key} = ${value}`);
             }
-            contentLines.push(`\t${key} = ${config[key]}`);
         }
         return contentLines.join('\n');
     };
@@ -2475,8 +2457,8 @@ const options$3 = {
         description: 'Toggle interactive mode',
     },
 };
-const builder$3 = (yargsInstance) => {
-    return yargsInstance.options(options$3).usage(getCommandUsageHeader(changelog.command));
+const builder$3 = (yargs) => {
+    return yargs.options(options$3).usage(getCommandUsageHeader(changelog.command));
 };
 
 var changelog = {
@@ -5966,8 +5948,14 @@ async function parseDefaultFileDiff(nodeFile, commit = '--staged', git) {
         return await git.diff([nodeFile.filePath]);
     }
     else if (commit === '--untracked') {
-        // For untracked files, return the entire file content
-        return await git.show([`:${nodeFile.filePath}`]);
+        // For untracked files, read the file content directly from the filesystem
+        try {
+            const fileContent = await promises.readFile(nodeFile.filePath, 'utf-8');
+            return fileContent;
+        }
+        catch (error) {
+            throw new Error(`Error reading untracked file: ${error?.message || 'Unknown error'}`);
+        }
     }
     return await git.diff([commit, nodeFile.filePath]);
 }
@@ -6380,8 +6368,8 @@ const options$2 = {
         type: 'string',
     },
 };
-const builder$2 = (yargsInstance) => {
-    return yargsInstance.options(options$2).usage(getCommandUsageHeader(commit.command));
+const builder$2 = (yargs) => {
+    return yargs.options(options$2).usage(getCommandUsageHeader(commit.command));
 };
 
 var commit = {
@@ -6480,9 +6468,16 @@ async function checkAndHandlePackageInstallation({ global = false, logger, }) {
     try {
         // Global installation
         if (global) {
-            logger.startSpinner(`Installing '${packageName}' globally...`, { color: 'blue' });
-            await installNpmPackage({ name: packageName, flags: ['-g'] });
-            logger.stopSpinner(`Installed '${packageName}' globally`);
+            const shouldInstall = await confirm({
+                message: `Would you like to install/update '${packageName}' globally at this time?`,
+                default: true,
+            });
+            if (!shouldInstall) {
+                return;
+            }
+            logger.startSpinner(`Updating '${packageName}'...`, { color: 'blue' });
+            // await installNpmPackage({ name: packageName, flags: ['-g'] })
+            logger.stopSpinner(`Updated '${packageName}'`);
             return;
         }
         // Project level installation
@@ -6995,17 +6990,17 @@ const options = {
         type: 'boolean',
         description: 'Recap for yesterday',
     },
-    "last-week": {
+    'last-week': {
         alias: 'week',
         type: 'boolean',
         description: 'Recap for last week',
     },
-    "last-month": {
+    'last-month': {
         alias: 'month',
         type: 'boolean',
         description: 'Recap for last month',
     },
-    "last-tag": {
+    'last-tag': {
         alias: 'tag',
         type: 'boolean',
         description: 'Recap for last tag',
@@ -7016,8 +7011,8 @@ const options = {
         description: 'Toggle interactive mode',
     },
 };
-const builder = (yargsInstance) => {
-    return yargsInstance.options(options).usage(getCommandUsageHeader(recap.command));
+const builder = (yargs) => {
+    return yargs.options(options).usage(getCommandUsageHeader(recap.command));
 };
 
 var recap = {

package/dist/index.js

@@ -76,7 +76,7 @@ const getCommandUsageHeader = (command) => {
     return chalk.green(`${USAGE_BANNER}\n${chalk.white('Command:')}\n\xa0\xa0\xa0\xa0\xa0 $0 ${chalk.greenBright(command)} [options]`);
 };
 const CONFIG_ALREADY_EXISTS = (path) => {
-    return `coco config found in '${path}', do you want to override it?`;
+    return `existing config found in '${path}', do you want to override it?`;
 };
 
 /**
@@ -397,11 +397,11 @@ function loadGitConfig(config) {
     if (fs__namespace.existsSync(gitConfigPath)) {
         const gitConfigRaw = fs__namespace.readFileSync(gitConfigPath, 'utf-8');
         const gitConfigParsed = ini__namespace.parse(gitConfigRaw);
-        const gitServiceAlias = gitConfigParsed.coco?.service;
+        const gitConfigServiceObject = gitConfigParsed.coco?.service;
         let service = config.service;
-        if (gitServiceAlias) {
-            const gitServiceConfig = getDefaultServiceConfigFromAlias(gitServiceAlias);
-            service = parseServiceConfig$1(gitServiceConfig || config.service);
+        if (gitConfigServiceObject) {
+            const gitServiceConfig = JSON.parse(gitConfigServiceObject);
+            service = gitServiceConfig || config?.service;
         }
         config = {
             ...config,
@@ -412,32 +412,11 @@ function loadGitConfig(config) {
             ignoredFiles: gitConfigParsed.coco?.ignoredFiles || config.ignoredFiles,
             ignoredExtensions: gitConfigParsed.coco?.ignoredExtensions || config.ignoredExtensions,
             defaultBranch: gitConfigParsed.coco?.defaultBranch || config.defaultBranch,
+            verbose: gitConfigParsed.coco?.verbose || config.verbose,
         };
     }
     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.
  *
@@ -452,15 +431,18 @@ const appendToGitConfig = async (filePath, config) => {
     const getNewContent = async () => {
         const contentLines = [header];
         for (const key in config) {
-            // check if string has new lines, if so, wrap in quotes
-            if (typeof config[key] === 'string') {
-                const value = config[key];
-                if (value.includes('\n')) {
-                    contentLines.push(`\t${key} = ${JSON.stringify(value)}`);
-                    continue;
-                }
+            const value = config[key];
+            if (typeof value === 'object') {
+                // Serialize object to JSON string
+                contentLines.push(`\t${key} = ${JSON.stringify(value)}`);
+            }
+            else if (typeof value === 'string' && value.includes('\n')) {
+                // Wrap strings with new lines in quotes
+                contentLines.push(`\t${key} = ${JSON.stringify(value)}`);
+            }
+            else {
+                contentLines.push(`\t${key} = ${value}`);
             }
-            contentLines.push(`\t${key} = ${config[key]}`);
         }
         return contentLines.join('\n');
     };
@@ -2496,8 +2478,8 @@ const options$3 = {
         description: 'Toggle interactive mode',
     },
 };
-const builder$3 = (yargsInstance) => {
-    return yargsInstance.options(options$3).usage(getCommandUsageHeader(changelog.command));
+const builder$3 = (yargs) => {
+    return yargs.options(options$3).usage(getCommandUsageHeader(changelog.command));
 };
 
 var changelog = {
@@ -5987,8 +5969,14 @@ async function parseDefaultFileDiff(nodeFile, commit = '--staged', git) {
         return await git.diff([nodeFile.filePath]);
     }
     else if (commit === '--untracked') {
-        // For untracked files, return the entire file content
-        return await git.show([`:${nodeFile.filePath}`]);
+        // For untracked files, read the file content directly from the filesystem
+        try {
+            const fileContent = await fs.promises.readFile(nodeFile.filePath, 'utf-8');
+            return fileContent;
+        }
+        catch (error) {
+            throw new Error(`Error reading untracked file: ${error?.message || 'Unknown error'}`);
+        }
     }
     return await git.diff([commit, nodeFile.filePath]);
 }
@@ -6401,8 +6389,8 @@ const options$2 = {
         type: 'string',
     },
 };
-const builder$2 = (yargsInstance) => {
-    return yargsInstance.options(options$2).usage(getCommandUsageHeader(commit.command));
+const builder$2 = (yargs) => {
+    return yargs.options(options$2).usage(getCommandUsageHeader(commit.command));
 };
 
 var commit = {
@@ -6501,9 +6489,16 @@ async function checkAndHandlePackageInstallation({ global = false, logger, }) {
     try {
         // Global installation
         if (global) {
-            logger.startSpinner(`Installing '${packageName}' globally...`, { color: 'blue' });
-            await installNpmPackage({ name: packageName, flags: ['-g'] });
-            logger.stopSpinner(`Installed '${packageName}' globally`);
+            const shouldInstall = await prompts.confirm({
+                message: `Would you like to install/update '${packageName}' globally at this time?`,
+                default: true,
+            });
+            if (!shouldInstall) {
+                return;
+            }
+            logger.startSpinner(`Updating '${packageName}'...`, { color: 'blue' });
+            // await installNpmPackage({ name: packageName, flags: ['-g'] })
+            logger.stopSpinner(`Updated '${packageName}'`);
             return;
         }
         // Project level installation
@@ -7016,17 +7011,17 @@ const options = {
         type: 'boolean',
         description: 'Recap for yesterday',
     },
-    "last-week": {
+    'last-week': {
         alias: 'week',
         type: 'boolean',
         description: 'Recap for last week',
     },
-    "last-month": {
+    'last-month': {
         alias: 'month',
         type: 'boolean',
         description: 'Recap for last month',
     },
-    "last-tag": {
+    'last-tag': {
         alias: 'tag',
         type: 'boolean',
         description: 'Recap for last tag',
@@ -7037,8 +7032,8 @@ const options = {
         description: 'Toggle interactive mode',
     },
 };
-const builder = (yargsInstance) => {
-    return yargsInstance.options(options).usage(getCommandUsageHeader(recap.command));
+const builder = (yargs) => {
+    return yargs.options(options).usage(getCommandUsageHeader(recap.command));
 };
 
 var recap = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-coco",
-  "version": "0.13.0",
+  "version": "0.13.2",
   "description": "zero-effort git commits with coco.",
   "author": "gfargo <ghfargo@gmail.com>",
   "license": "MIT",