@snelusha/noto 1.2.0 → 1.2.1

package/README.md

@@ -154,7 +154,7 @@ noto branch delete --force # simply: noto branch delete -f
 
 ## Pro Tips
 
-- 🚀 Get fast commits on the fly with `noto -e -a` to streamline your workflow!
+- 🚀 Get fast commits on the fly with `noto -a` to streamline your workflow!
 
 ## Contributing
 

package/dist/index.js

@@ -323,7 +323,7 @@ var getModel = async () => {
 };
 
 // src/ai/index.ts
-var generateCommitMessage = async (diff, type) => {
+var generateCommitMessage = async (diff, type, context) => {
   const model2 = await getModel();
   const { object } = await generateObject({
     model: model2,
@@ -334,27 +334,65 @@ var generateCommitMessage = async (diff, type) => {
       {
         role: "system",
         content: dedent3`
-        You are a state-of-the-art AI model tasked with generating a precise Git commit message based on staged changes.
-        Adhere strictly to the following instructions, ranked by priority:
-    
-        1. Write the commit message in present tense, starting with a present-tense verb such as add, fix, update, remove, improve, or implement. This applies to all repositories, including Java.
-        2. Summarize the key changes only, crafting a concise and clear commit message in the format "<type>: <description>".
-        3. Use one of the following standardized types: feat, fix, refactor, docs, test, or chore.
-        4. Ensure the commit message is a single line, fully lowercase, with no scope or body, and omit punctuation such as full stops at the end.
-        5. Limit the length of the commit message to 72 characters.
-        6. Avoid mentioning file names unless a file was renamed or is critical for understanding the changes.
-        7. Prioritize clarity and focus on the most impactful changes for the commit.
-    
-        You are expected to generate structured outputs that align with the provided guidelines and produce a message optimized for readability and accuracy. Strictly follow all constraints to ensure high-quality results.
-        
-        ${type ? `if a type is provided (e.g., feat, fix), include it in the commit message in the format "type: message"
+        ## Persona
+        You are a highly specialized AI assistant engineered for generating precise, standards-compliant Git commit messages. Your function is to serve as an automated tool ensuring consistency and clarity in version control history, adhering strictly to predefined formatting rules optimized for software development workflows.
+
+        ## Core Objective
+        Your objective is to meticulously analyze provided code changes (diffs) and synthesize a Git commit message that strictly conforms to the specified output requirements. The focus is on accuracy, conciseness, and unwavering adherence to the format.
+
+        ## Input Specification
+        The input provided by the user will be structured as follows:
+
+        1.  **Optional Type Override:** A line indicating the desired commit type, formatted as:
+            \`USER_SPECIFIED_TYPE: <value>\`
+            *   The \`<value>\` will either be one of the valid types (\`chore\`, \`feat\`, \`fix\`, \`docs\`, \`refactor\`, \`perf\`, \`test\) or the special keyword \`[none]\` if the user does not wish to force a specific type.
+        2.  **Optional User Context:** A section providing supplementary information about the changes, formatted as:
+            \`USER_PROVIDED_CONTEXT:\`
+            \`{context_placeholder or [none]}\`
+            *   This context (e.g., issue details, goal description) is optional. If provided, use it to better understand the *purpose* and *intent* behind the code changes. If not provided, the value will be \`[none]\`.
+        3.  **Diff Content:** The raw diff output, typically generated by \`git diff --staged\`, encapsulated within triple backticks.
+
+        **You must parse the \`USER_SPECIFIED_TYPE:\` and \`USER_PROVIDED_CONTEXT:\` inputs before analyzing the diff.**
           
-          type: ${type}` : ""}`
+        ## Output Specification & Constraints (Mandatory Adherence)
+        Adherence to the following specifications is mandatory and non-negotiable. Any deviation constitutes an incorrect output.
+
+        1.  **Commit Message Format:**
+            *   The output MUST strictly follow the single-line format: \`<type>: <description>\`
+            *   A single colon (\`:\`) followed by a single space MUST separate the \`<type>\` and \`<description>\`.
+            *   Scopes within the type (e.g., \`feat(api):\`) are explicitly disallowed.
+            *   Message bodies and footers are explicitly disallowed. The output MUST be exactly one line.
+
+        2.  **Type (\`<type>\`) - Determination Logic:**
+            *   **Priority 1: User-Specified Type:** Check the value provided on the \`USER_SPECIFIED_TYPE:\` line. If this value is exactly one of \`chore\`, \`feat\`, \`fix\`, \`docs\`, \`refactor\`, \`perf\`, \`test\`, then you **MUST** use this user-specified type.
+            *   **Priority 2: Diff & Context Analysis (Default Behavior):** If the value on the \`USER_SPECIFIED_TYPE:\` line is \`[none]\` or invalid, you **MUST** select the \`<type>\` exclusively from the predefined vocabulary (\`chore\`, \`feat\`, \`fix\`, \`docs\`, \`refactor\`, \`perf\`, \`test\`). Base your selection on your analysis of the diff, **informed by the \`USER_PROVIDED_CONTEXT\`** if available, to accurately reflect the primary semantic purpose of the changes.
+
+        3.  **Description (\`<description>\`):**
+            *   **Tense:** MUST employ the imperative, present tense (e.g.,\`add\`, \`fix\`, \`update\`, \`implement\`, \`refactor\`, \`remove\`).
+            *   **Content:** Must succinctly convey the core semantic change introduced by the diff.
+                *   **Leverage Context:** If \`USER_PROVIDED_CONTEXT\` is available and not \`[none]\`, use it to **refine the description**, ensuring it reflects the *intent* and *purpose* behind the changes, while still accurately summarizing *what* was changed in the diff.
+                *   **Focus:** Prioritize the most significant aspects of the change.
+            *   **File Name Reference:** Inclusion of file names should be exceptional, reserved only for renaming operations or when essential for disambiguating the change's primary focus.
+            *   **Case Sensitivity:** The entire output string, encompassing both \`<type>\` and \`<description>\`, MUST be rendered in lowercase.
+            *   **Punctuation:** The description MUST NOT conclude with any terminal punctuation (e.g., no period/full stop).
+            *   **Length Constraint:** The total character count of the generated commit message line MUST NOT exceed 72 characters. **The description must be concise enough to fit within this limit alongside the chosen type.**`
       },
       {
         role: "user",
-        content: dedent3`generate a commit message for the following staged changes:
-        ${diff}`
+        content: dedent3`
+        \`\`\`text
+        USER_SPECIFIED_TYPE: ${type ?? "[none]"}
+
+        USER_PROVIDED_CONTEXT:
+        ${context ?? "[none]"}
+        \`\`\`
+
+        
+
+        \`\`\`diff
+        ${diff}
+        \`\`\`
+        `
       }
     ]
   });
@@ -386,6 +424,12 @@ var command = {
       alias: "-t",
       description: "generate commit message based on type"
     },
+    {
+      type: String,
+      flag: "--message",
+      alias: "-m",
+      description: "provide context for the commit message"
+    },
     {
       type: Boolean,
       flag: "--copy",
@@ -424,10 +468,28 @@ var command = {
         } else if (typeof type === "string") {
           options.type = type;
         }
+        const context = options["--message"];
+        if (typeof context === "string") {
+          options.context = context;
+        } else if (typeof context === "boolean") {
+          const context2 = await p3.text({
+            message: "provide context for the commit message",
+            placeholder: "describe the changes"
+          });
+          if (p3.isCancel(context2)) {
+            p3.log.error(color3.red("nothing changed!"));
+            return await exit(1);
+          }
+          options.context = context2;
+        }
         spin.start("generating commit message");
         let message = null;
         if (!await isFirstCommit()) {
-          message = await generateCommitMessage(diff, options.type);
+          message = await generateCommitMessage(
+            diff,
+            options.type,
+            options.context
+          );
         } else {
           message = INIT_COMMIT_MESSAGE;
         }
@@ -995,7 +1057,7 @@ var listCommand = () => {
 };
 
 // package.json
-var version = "1.2.0";
+var version = "1.2.1";
 
 // src/index.ts
 var globalSpec = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snelusha/noto",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Generate clean commit messages in a snap! ✨",
   "license": "MIT",
   "type": "module",
@@ -49,10 +49,10 @@
   "dependencies": {
     "@ai-sdk/google": "^1.2.14",
     "@clack/prompts": "^0.10.1",
-    "ai": "^4.3.12",
+    "ai": "^4.3.13",
     "arg": "^5.0.2",
     "clipboardy": "^4.0.0",
-    "dedent": "^1.5.3",
+    "dedent": "^1.6.0",
     "picocolors": "^1.1.1",
     "simple-git": "^3.27.0",
     "tinyexec": "^0.3.2",