git-coco 0.13.1 → 0.14.0

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

@@ -5,13 +5,15 @@ import { BaseLLMParams } from '@langchain/core/language_models/llms';
 import * as _langchain_openai from '@langchain/openai';
 import { TiktokenModel, OpenAIInput, ChatOpenAI } from '@langchain/openai';
 import { SimpleGit } from 'simple-git';
+import { ChatAnthropic } from '@langchain/anthropic';
 import { ChatOllama } from '@langchain/ollama';
 import { Color } from 'chalk';
 import { TiktokenModel as TiktokenModel$1 } from 'tiktoken';
 
-type LLMProvider = 'openai' | 'ollama';
+type LLMProvider = 'openai' | 'ollama' | 'anthropic';
+type AnthropicModel = 'claude-3-5-sonnet-20240620' | 'claude-3-opus-20240229' | 'claude-3-sonnet-20240229' | 'claude-3-haiku-20240307' | 'claude-2.1' | 'claude-2.0';
 type OllamaModel = 'codegemma:2b' | 'codegemma:7b-code' | 'codegemma' | 'codellama:13b' | 'codellama:34b' | 'codellama:70b' | 'codellama:7b' | 'codellama:instruct' | 'codellama:latest' | 'codellama' | 'gemma:2b' | 'gemma:7b' | 'gemma:latest' | 'gemma' | 'llama2:13b' | 'llama2:70b' | 'llama2:chat' | 'llama2:latest' | 'llama2:text' | 'llama2' | 'llama3:70b-text' | 'llama3:70b' | 'llama3:latest' | 'llama3:text' | 'llama3.1:70b' | 'llama3.1:8b' | 'llama3.1:latest' | 'llama3.2' | 'llama3.2:latest' | 'llama3.2:1b' | 'llama3.2:3b' | 'llama3.2:1b-instruct-fp16' | 'llama3.2:1b-instruct-q3_K_M' | 'llama3' | 'mistral:7b' | 'mistral:latest' | 'mistral:text' | 'mistral' | 'phi3:14b' | 'phi3:3.8b' | 'phi3:instruct' | 'phi3:medium-128k' | 'phi3:medium-4k' | 'phi3:medium' | 'phi3' | 'qwen2:0.5b' | 'qwen2:1.5b' | 'qwen2:72b-text' | 'qwen2:72b' | 'qwen2';
-type LLMModel = TiktokenModel | OllamaModel;
+type LLMModel = TiktokenModel | OllamaModel | AnthropicModel;
 type BaseLLMService = {
     provider: LLMProvider;
     model: LLMModel;
@@ -146,7 +148,7 @@ type ChangelogArgv = Arguments<ChangelogOptions>;
 declare const _default$3: {
     command: string;
     desc: string;
-    builder: (yargsInstance: ReturnType<typeof yargs>) => yargs.Argv<yargs.Omit<{}, string> & yargs.InferredOptionTypes<Record<string, yargs.Options>>>;
+    builder: (yargs: yargs.Argv) => yargs.Argv<yargs.Omit<{}, string> & yargs.InferredOptionTypes<Record<string, yargs.Options>>>;
     handler: (argv: ChangelogArgv) => Promise<void>;
     options: Record<string, yargs.Options>;
 };
@@ -162,7 +164,7 @@ type CommitArgv = Arguments<CommitOptions>;
 declare const _default$2: {
     command: string;
     desc: string;
-    builder: (yargsInstance: ReturnType<typeof yargs>) => yargs.Argv<yargs.Omit<{}, string> & yargs.InferredOptionTypes<Record<string, yargs.Options>>>;
+    builder: (yargs: yargs.Argv) => yargs.Argv<yargs.Omit<{}, string> & yargs.InferredOptionTypes<Record<string, yargs.Options>>>;
     handler: (argv: CommitArgv) => Promise<void>;
     options: Record<string, yargs.Options>;
 };
@@ -195,16 +197,16 @@ 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>;
 
 declare const _default: {
     command: string;
     desc: string;
-    builder: (yargsInstance: ReturnType<typeof yargs>) => yargs.Argv<yargs.Omit<{}, string> & yargs.InferredOptionTypes<Record<string, yargs.Options>>>;
+    builder: (yargs: yargs.Argv) => yargs.Argv<yargs.Omit<{}, string> & yargs.InferredOptionTypes<Record<string, yargs.Options>>>;
     handler: (argv: RecapArgv) => Promise<void>;
     options: Record<string, yargs.Options>;
 };
@@ -216,7 +218,7 @@ declare const _default: {
  * @param configuration
  * @returns LLM Model
  */
-declare function getLlm(provider: LLMProvider, model: LLMModel, config: Config$1): ChatOllama | ChatOpenAI<_langchain_openai.ChatOpenAICallOptions>;
+declare function getLlm(provider: LLMProvider, model: LLMModel, config: Config$1): ChatAnthropic | ChatOllama | ChatOpenAI<_langchain_openai.ChatOpenAICallOptions>;
 
 interface LoggerOptions {
     color?: typeof Color;