git-coco 0.8.0 → 0.8.1

package/README.md

@@ -6,7 +6,7 @@
 [![NPM Version](https://img.shields.io/npm/v/git-coco.svg)](https://www.npmjs.com/package/git-coco)
 [![NPM Downloads](https://img.shields.io/npm/dt/git-coco.svg)](https://www.npmjs.com/package/git-coco)
 
-`coco`, the Commit Copilot, is not just your scribe for git commit messages. With the power of [LangChain🦜🔗](https://js.langchain.com/) and LLMs, it now brings you a suite of tools to streamline your git workflow!
+`coco`, the Commit Copilot, transcends being merely a robotic scribe for crafting git commit messages. Leveraging the capabilities of [LangChain🦜🔗](https://js.langchain.com/) and LLMs, `coco` is committed to providing a suite of insightful tools aimed at enhancing and streamlining your git workflow!
 
 ## Commands
 

package/dist/index.d.ts

@@ -292,6 +292,12 @@ declare class Logger {
 }
 
 type TokenCounter = Awaited<ReturnType<typeof getTokenCounter>>;
+/**
+ * Retrieves the token counter for a given model name.
+ *
+ * @param {TikTokenModel} modelName - The name of the Tiktoken model.
+ * @returns A promise that resolves to a function that calculates the number of tokens in a given text.
+ */
 declare const getTokenCounter: (modelName: TiktokenModel) => Promise<(text: string) => number>;
 
 type FileChangeStatus = 'modified' | 'renamed' | 'added' | 'deleted' | 'untracked' | 'unknown';

package/dist/index.esm.mjs

@@ -682,6 +682,7 @@ function getSummarizationChain(model, options = { type: 'map_reduce' }) {
 
 /**
  * Get Recursive Character Text Splitter
+ *
  * @param options
  * @returns
  */
@@ -689,12 +690,29 @@ function getTextSplitter(options = {}) {
     return new RecursiveCharacterTextSplitter(options);
 }
 
+/**
+ * Parses the default file diff for a given nodeFile.
+ *
+ * @param nodeFile - The file change object.
+ * @param commit - The commit to diff against. Defaults to '--staged'.
+ * @param git - The SimpleGit instance.
+ * @returns A Promise that resolves to the file diff as a string.
+ */
 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]);
 }
+/**
+ * Parses the diff for a renamed file.
+ *
+ * @param nodeFile - The file change object.
+ * @param commit - The commit hash or '--staged'.
+ * @param git - The SimpleGit instance.
+ * @param logger - The logger instance.
+ * @returns A Promise that resolves to the diff string.
+ */
 async function parseRenamedFileDiff(nodeFile, commit, git, logger) {
     let result = '';
     const oldFilePath = nodeFile?.oldFilePath || nodeFile.filePath;
@@ -733,6 +751,18 @@ async function parseRenamedFileDiff(nodeFile, commit, git, logger) {
     }
     return result;
 }
+/**
+ * Retrieves the diff for a given file change in a specific commit.
+ * If the file is deleted, it returns a message indicating that the file has been deleted.
+ * If the file is renamed, it parses the renamed file diff and returns it.
+ * Otherwise, it retrieves the default diff from the index and returns it.
+ *
+ * @param nodeFile - The file change object.
+ * @param commit - The commit hash.
+ * @param git - The SimpleGit instance.
+ * @param logger - The logger instance.
+ * @returns A promise that resolves to the diff as a string.
+ */
 async function getDiff(nodeFile, commit, { git, logger, }) {
     if (nodeFile.status === 'deleted') {
         return 'This file has been deleted.';
@@ -930,6 +960,14 @@ function getPrompt({ template, variables, fallback }) {
         : fallback);
 }
 
+/**
+ * Determines the status of a file based on its changes in the Git repository.
+ *
+ * @param file - The file to check the status of.
+ * @param location - The location to check the status in ('index' or 'working_dir'). Defaults to 'index'.
+ * @returns The status of the file ('added', 'deleted', 'modified', 'renamed', 'untracked', or 'unknown').
+ * @throws Error if the file type is invalid.
+ */
 function getStatus(file, location = 'index') {
     if ('index' in file && 'working_dir' in file) {
         const statusCode = file[location];
@@ -966,6 +1004,14 @@ function getStatus(file, location = 'index') {
     }
 }
 
+/**
+ * Returns the summary text for a file change.
+ *
+ * @param file - The file status or diff result.
+ * @param change - The partial file change object.
+ * @returns The summary text for the file change.
+ * @throws Error if the file type is invalid.
+ */
 function getSummaryText(file, change) {
     const status = change.status || getStatus(file);
     let filePath;
@@ -984,6 +1030,12 @@ function getSummaryText(file, change) {
     return `${status}: ${filePath}`;
 }
 
+/**
+ * Retrieves the changes in the Git repository.
+ *
+ * @param {GetChangesInput} options - The options for retrieving the changes.
+ * @returns {Promise<GetChangesResult>} A promise that resolves to the changes in the Git repository.
+ */
 async function getChanges({ git, options }) {
     const { ignoredFiles = DEFAULT_IGNORED_FILES, ignoredExtensions = DEFAULT_IGNORED_EXTENSIONS } = options || {};
     const staged = [];
@@ -1130,7 +1182,8 @@ async function getUserReviewDecision({ label, descriptions, enableRetry = true,
 }
 
 /**
- * Verify  template string contains all required input variables
+ * Verify template string contains all required input variables
+ *
  * @param text template string
  * @param inputVariables template variables
  * @returns boolean or error message
@@ -1276,6 +1329,10 @@ 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 {
@@ -1288,20 +1345,37 @@ const getRepo = () => {
     return git;
 };
 
+/**
+ * Retrieves a TikToken for the specified model.
+ *
+ * @param {TiktokenModel} modelName - The name of the TiktokenModel.
+ * @returns A Promise that resolves to the TikToken.
+ */
 const getTikToken = async (modelName) => {
     return await encoding_for_model(modelName);
 };
+/**
+ * Retrieves the token counter for a given model name.
+ *
+ * @param {TikTokenModel} modelName - The name of the Tiktoken model.
+ * @returns A promise that resolves to a function that calculates the number of tokens in a given text.
+ */
 const getTokenCounter = async (modelName) => {
     return getTikToken(modelName).then((tokenizer) => (text) => {
-        // console.log('Running GetTokenCount', { tokenizer, length: text.length })
         const tokens = tokenizer.encode(text);
-        // console.log('Tokens', { tokenCount: tokens.length })
         return tokens.length;
     });
 };
 
-async function createCommit(commitMsg, git) {
-    return await git.commit(commitMsg);
+/**
+ * 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);
 }
 
 const handler$2 = async (argv, logger) => {
@@ -1445,6 +1519,15 @@ const CHANGELOG_PROMPT = new PromptTemplate({
     inputVariables,
 });
 
+/**
+ * Retrieves the commit log range between two specified commits.
+ *
+ * @param from - The starting commit.
+ * @param to - The ending commit.
+ * @param options - Additional options for retrieving the commit log range.
+ * @returns A promise that resolves to an array of commit log messages.
+ * @throws If there is an error retrieving the commit log range.
+ */
 async function getCommitLogRange(from, to, { noMerges, git }) {
     try {
         const logOptions = { from: `${from}^1`, to, '--no-merges': noMerges };
@@ -1458,10 +1541,26 @@ async function getCommitLogRange(from, to, { noMerges, git }) {
     }
 }
 
+/**
+ * Retrieves the name of the current branch.
+ *
+ * @param {GetCurrentBranchName} options - The options for retrieving the branch name.
+ * @returns {Promise<string>} - A promise that resolves to the name of the current branch.
+ */
 async function getCurrentBranchName({ git }) {
     return await git.revparse(['--abbrev-ref', 'HEAD']);
 }
 
+/**
+ * Retrieves the commit log for the current branch.
+ *
+ * @param {Object} options - The options for retrieving the commit log.
+ * @param {SimpleGit} options.git - The SimpleGit instance.
+ * @param {Logger} options.logger - The logger for logging messages.
+ * @param {string} [options.comparisonBranch='main'] - The branch to compare against.
+ * @param {string} [options.comparisonRemote='origin'] - The remote to compare against.
+ * @returns {Promise<string[]>} The array of commit messages in the commit log.
+ */
 async function getCommitLogCurrentBranch({ git, logger, comparisonBranch = 'main', comparisonRemote = 'origin', }) {
     try {
         // Get the current branch name
@@ -1702,14 +1801,10 @@ async function installNpmPackage({ name, flags = [], cwd = process.cwd(), }) {
  */
 function isPackageInstalled(packageName, projectPath) {
     try {
-        // Construct the path to the package.json file
         const packageJsonPath = path__default.join(projectPath, 'package.json');
-        // Read the package.json file
         const packageJson = JSON.parse(fs__default.readFileSync(packageJsonPath, 'utf8'));
-        // Check both dependencies and devDependencies
         const dependencies = packageJson.dependencies || {};
         const devDependencies = packageJson.devDependencies || {};
-        // Return true if the package is found in either
         return dependencies.hasOwnProperty(packageName) || devDependencies.hasOwnProperty(packageName);
     }
     catch (error) {

package/dist/index.js

@@ -703,6 +703,7 @@ function getSummarizationChain(model, options = { type: 'map_reduce' }) {
 
 /**
  * Get Recursive Character Text Splitter
+ *
  * @param options
  * @returns
  */
@@ -710,12 +711,29 @@ function getTextSplitter(options = {}) {
     return new text_splitter.RecursiveCharacterTextSplitter(options);
 }
 
+/**
+ * Parses the default file diff for a given nodeFile.
+ *
+ * @param nodeFile - The file change object.
+ * @param commit - The commit to diff against. Defaults to '--staged'.
+ * @param git - The SimpleGit instance.
+ * @returns A Promise that resolves to the file diff as a string.
+ */
 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]);
 }
+/**
+ * Parses the diff for a renamed file.
+ *
+ * @param nodeFile - The file change object.
+ * @param commit - The commit hash or '--staged'.
+ * @param git - The SimpleGit instance.
+ * @param logger - The logger instance.
+ * @returns A Promise that resolves to the diff string.
+ */
 async function parseRenamedFileDiff(nodeFile, commit, git, logger) {
     let result = '';
     const oldFilePath = nodeFile?.oldFilePath || nodeFile.filePath;
@@ -754,6 +772,18 @@ async function parseRenamedFileDiff(nodeFile, commit, git, logger) {
     }
     return result;
 }
+/**
+ * Retrieves the diff for a given file change in a specific commit.
+ * If the file is deleted, it returns a message indicating that the file has been deleted.
+ * If the file is renamed, it parses the renamed file diff and returns it.
+ * Otherwise, it retrieves the default diff from the index and returns it.
+ *
+ * @param nodeFile - The file change object.
+ * @param commit - The commit hash.
+ * @param git - The SimpleGit instance.
+ * @param logger - The logger instance.
+ * @returns A promise that resolves to the diff as a string.
+ */
 async function getDiff(nodeFile, commit, { git, logger, }) {
     if (nodeFile.status === 'deleted') {
         return 'This file has been deleted.';
@@ -951,6 +981,14 @@ function getPrompt({ template, variables, fallback }) {
         : fallback);
 }
 
+/**
+ * Determines the status of a file based on its changes in the Git repository.
+ *
+ * @param file - The file to check the status of.
+ * @param location - The location to check the status in ('index' or 'working_dir'). Defaults to 'index'.
+ * @returns The status of the file ('added', 'deleted', 'modified', 'renamed', 'untracked', or 'unknown').
+ * @throws Error if the file type is invalid.
+ */
 function getStatus(file, location = 'index') {
     if ('index' in file && 'working_dir' in file) {
         const statusCode = file[location];
@@ -987,6 +1025,14 @@ function getStatus(file, location = 'index') {
     }
 }
 
+/**
+ * Returns the summary text for a file change.
+ *
+ * @param file - The file status or diff result.
+ * @param change - The partial file change object.
+ * @returns The summary text for the file change.
+ * @throws Error if the file type is invalid.
+ */
 function getSummaryText(file, change) {
     const status = change.status || getStatus(file);
     let filePath;
@@ -1005,6 +1051,12 @@ function getSummaryText(file, change) {
     return `${status}: ${filePath}`;
 }
 
+/**
+ * Retrieves the changes in the Git repository.
+ *
+ * @param {GetChangesInput} options - The options for retrieving the changes.
+ * @returns {Promise<GetChangesResult>} A promise that resolves to the changes in the Git repository.
+ */
 async function getChanges({ git, options }) {
     const { ignoredFiles = DEFAULT_IGNORED_FILES, ignoredExtensions = DEFAULT_IGNORED_EXTENSIONS } = options || {};
     const staged = [];
@@ -1151,7 +1203,8 @@ async function getUserReviewDecision({ label, descriptions, enableRetry = true,
 }
 
 /**
- * Verify  template string contains all required input variables
+ * Verify template string contains all required input variables
+ *
  * @param text template string
  * @param inputVariables template variables
  * @returns boolean or error message
@@ -1297,6 +1350,10 @@ 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 {
@@ -1309,20 +1366,37 @@ const getRepo = () => {
     return git;
 };
 
+/**
+ * Retrieves a TikToken for the specified model.
+ *
+ * @param {TiktokenModel} modelName - The name of the TiktokenModel.
+ * @returns A Promise that resolves to the TikToken.
+ */
 const getTikToken = async (modelName) => {
     return await tiktoken.encoding_for_model(modelName);
 };
+/**
+ * Retrieves the token counter for a given model name.
+ *
+ * @param {TikTokenModel} modelName - The name of the Tiktoken model.
+ * @returns A promise that resolves to a function that calculates the number of tokens in a given text.
+ */
 const getTokenCounter = async (modelName) => {
     return getTikToken(modelName).then((tokenizer) => (text) => {
-        // console.log('Running GetTokenCount', { tokenizer, length: text.length })
         const tokens = tokenizer.encode(text);
-        // console.log('Tokens', { tokenCount: tokens.length })
         return tokens.length;
     });
 };
 
-async function createCommit(commitMsg, git) {
-    return await git.commit(commitMsg);
+/**
+ * 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);
 }
 
 const handler$2 = async (argv, logger) => {
@@ -1466,6 +1540,15 @@ const CHANGELOG_PROMPT = new prompts.PromptTemplate({
     inputVariables,
 });
 
+/**
+ * Retrieves the commit log range between two specified commits.
+ *
+ * @param from - The starting commit.
+ * @param to - The ending commit.
+ * @param options - Additional options for retrieving the commit log range.
+ * @returns A promise that resolves to an array of commit log messages.
+ * @throws If there is an error retrieving the commit log range.
+ */
 async function getCommitLogRange(from, to, { noMerges, git }) {
     try {
         const logOptions = { from: `${from}^1`, to, '--no-merges': noMerges };
@@ -1479,10 +1562,26 @@ async function getCommitLogRange(from, to, { noMerges, git }) {
     }
 }
 
+/**
+ * Retrieves the name of the current branch.
+ *
+ * @param {GetCurrentBranchName} options - The options for retrieving the branch name.
+ * @returns {Promise<string>} - A promise that resolves to the name of the current branch.
+ */
 async function getCurrentBranchName({ git }) {
     return await git.revparse(['--abbrev-ref', 'HEAD']);
 }
 
+/**
+ * Retrieves the commit log for the current branch.
+ *
+ * @param {Object} options - The options for retrieving the commit log.
+ * @param {SimpleGit} options.git - The SimpleGit instance.
+ * @param {Logger} options.logger - The logger for logging messages.
+ * @param {string} [options.comparisonBranch='main'] - The branch to compare against.
+ * @param {string} [options.comparisonRemote='origin'] - The remote to compare against.
+ * @returns {Promise<string[]>} The array of commit messages in the commit log.
+ */
 async function getCommitLogCurrentBranch({ git, logger, comparisonBranch = 'main', comparisonRemote = 'origin', }) {
     try {
         // Get the current branch name
@@ -1723,14 +1822,10 @@ async function installNpmPackage({ name, flags = [], cwd = process.cwd(), }) {
  */
 function isPackageInstalled(packageName, projectPath) {
     try {
-        // Construct the path to the package.json file
         const packageJsonPath = path.join(projectPath, 'package.json');
-        // Read the package.json file
         const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
-        // Check both dependencies and devDependencies
         const dependencies = packageJson.dependencies || {};
         const devDependencies = packageJson.devDependencies || {};
-        // Return true if the package is found in either
         return dependencies.hasOwnProperty(packageName) || devDependencies.hasOwnProperty(packageName);
     }
     catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-coco",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "zero-effort git commits with coco.",
   "author": "gfargo <ghfargo@gmail.com>",
   "license": "MIT",
@@ -81,7 +81,7 @@
   "dependencies": {
     "@inquirer/prompts": "3.3.0",
     "chalk": "4.1.2",
-    "diff": "5.1.0",
+    "diff": "5.2.0",
     "ini": "4.1.1",
     "langchain": "0.0.196",
     "minimatch": "9.0.3",
@@ -89,7 +89,7 @@
     "p-queue": "5.0.0",
     "performance-now": "2.1.0",
     "pretty-ms": "7.0.1",
-    "simple-git": "3.21.0",
+    "simple-git": "3.23.0",
     "tiktoken": "1.0.11",
     "yargs": "17.7.2"
   }