@snelusha/noto 0.2.2 → 0.3.0

package/README.md

@@ -1,6 +1,6 @@
-<h1 align="center">✨ Noto</h1>
+<h1 align="center">noto ✨</h1>
 <p align="center"><sup>(/nōto/, <em>notebook</em> in Japanese)</sup></p>
-<p align="center">Generate clean commit messages in a snap! ✨</p>
+<img src="https://github.com/snelusha/static/blob/main/noto/banner.png?raw=true" align="center"></img>
 
 <pre align="center">
   <p>npm install -g <b>@snelusha/noto</b></p>
@@ -29,17 +29,24 @@ Here, you’ll need to input your Google GenAI API Key.
    To generate a commit message, simply run:
 
    ```bash
-   noto
+   noto                 # generate a commit message
 
-   # apply the generated message:
-   noto --apply
-   # or
-   noto -a
+   # apply generated message
+   noto --apply         # apply the message to current commit
+   noto -a              # alias for apply 
 
-   # copy the generated message:
-   noto --copy
-   # or
-   noto -c
+   # copy generated message
+   noto --copy          # copy the message to clipboard
+   noto -c              # alias for copy
+
+   # access the previously generated message
+   noto prev            # view the last message
+
+   noto prev --apply    # apply the last message to current commit
+   noto prev -a         # alias for apply
+
+   noto prev --copy     # copy the last message to clipboard
+   noto prev -c         # alias for copy
    ```
 
 ## Pro Tips

package/dist/cli.cjs

@@ -78,16 +78,24 @@ function spinner() {
       s.start();
     },
     fail(text) {
-      if (s)
-        s.fail(text);
+      if (!s) {
+        s = ora__default();
+      }
+      s.fail(text);
+      s = void 0;
     },
     success(text) {
-      if (s)
-        s.succeed(text);
+      if (!s) {
+        s = ora__default();
+      }
+      s.succeed(text);
+      s = void 0;
     },
     stop() {
-      if (s)
+      if (s) {
         s.stop();
+        s = void 0;
+      }
     }
   };
 }
@@ -148,7 +156,14 @@ async function generateCommitMessage(diff) {
     messages: [
       {
         role: "system",
-        content: "You are tasked with generating a Git commit message based on the following staged changes across multiple files. Identify only the key changes and generate a concise commit message in the format: <type>: <description>. The commit message must be a single line, in all lowercase, without a scope or body, and no full stops at the end. Use one of these types: feat, fix, refactor, docs, test, or chore. Do not mention file names unless a file was renamed or is essential to understanding the change. Focus on the most important change, and the message must not exceed 72 characters."
+        content: `You are tasked with generating a Git commit message for the following staged changes across multiple files. Strictly follow the instructions given below to generate the commit message. The instructions are given according to order of importance, as such, make sure each instruction is followed before moving on to the next. Likewise, make sure all instructions are followed successfully.
+          - Ensure the description is written in the present-tense(start with a present tense verb such as add, fix, update, remove, improve, implement, etc...) (IMPORTANT! follow this for java repositories as well).
+          - Identify the key changes only and generate a detailed but brief commit message in the format "<type>: <description>".
+          - Use one of these types: feat, fix, refactor, docs, test, or chore.
+          - The commit message must be a single line, in all lowercase, without a scope or body, and no full stops at the end.
+          - Ensure the message does not exceed 72 characters.
+          - Do not mention file names unless a file was renamed or is essential for understanding the changes.
+          - Focus on the most important changes.`
       },
       {
         role: "user",
@@ -160,6 +175,8 @@ ${diff}`
   return message.text.trim();
 }
 
+const version = "0.2.4";
+
 yargs__default(helpers.hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
   "config",
   "setup you API key to enable noto.",
@@ -204,6 +221,75 @@ yargs__default(helpers.hideBin(process.argv)).scriptName("noto").usage("$0 [args
       );
     }
   }
+).command(
+  "prev",
+  "access previous commit message",
+  (args) => {
+    args.option("copy", {
+      alias: "c",
+      type: "boolean",
+      description: "Copy the previous commit message to the clipboard."
+    });
+    args.option("apply", {
+      alias: "a",
+      type: "boolean",
+      description: "Commit the staged changes with the previous message."
+    });
+  },
+  async (args) => {
+    const spin = spinner();
+    const storage = await load();
+    if (!storage.lastGeneratedMessage) {
+      console.log(c__default.red("No previous commit message found."));
+      console.log(
+        c__default.dim(
+          `Generate a new message with ${c__default.cyan(c__default.bold("`noto`"))} command.`
+        )
+      );
+      process.exit(1);
+    }
+    const message = storage.lastGeneratedMessage;
+    const copy = args.copy;
+    const apply = args.apply;
+    spin.success(`Previous Commit Message: ${c__default.dim(c__default.bold(message))}`);
+    if (copy) {
+      clipboardy__default.writeSync(message);
+      spin.success("Message copied to clipboard!");
+    }
+    if (apply) {
+      const cwd = process.cwd();
+      if (!isGitRepository(cwd)) {
+        console.log(
+          c__default.red("Oops! No Git repository found in the current directory.")
+        );
+        console.log(
+          c__default.dim(
+            `You can initialize one by running ${c__default.cyan(
+              c__default.bold("`git init`")
+            )}`
+          )
+        );
+        process.exit(1);
+      }
+      const diff = await getStagedDiff();
+      if (!diff) {
+        console.log(c__default.red("Oops! No staged changes found to commit."));
+        console.log(
+          c__default.dim(
+            `Stage changes with ${c__default.cyan(
+              c__default.bold("`git add <file>`")
+            )} or ${c__default.cyan(c__default.bold("`git add .`"))} for stage all files.`
+          )
+        );
+        process.exit(1);
+      }
+      if (!await commit(message)) {
+        spin.fail("Failed to commit staged changes.");
+        process.exit(1);
+      }
+      spin.success("Staged changes committed successfully!");
+    }
+  }
 ).command(
   "*",
   "generate commit message",
@@ -233,7 +319,9 @@ yargs__default(helpers.hideBin(process.argv)).scriptName("noto").usage("$0 [args
         c__default.red("Oops! No Git repository found in the current directory.")
       );
       console.log(
-        `You can initialize one by running ${c__default.cyan(c__default.bold("`git init`"))}`
+        c__default.dim(
+          `You can initialize one by running ${c__default.cyan(c__default.bold("`git init`"))}`
+        )
       );
       process.exit(1);
     }
@@ -241,9 +329,11 @@ yargs__default(helpers.hideBin(process.argv)).scriptName("noto").usage("$0 [args
     if (!diff) {
       console.log(c__default.red("Oops! No staged changes found to commit."));
       console.log(
-        `Stage changes with ${c__default.cyan(c__default.bold("`git add <file>`"))} or ${c__default.cyan(
-          c__default.bold("`git add .`")
-        )} for stage all files.`
+        c__default.dim(
+          `Stage changes with ${c__default.cyan(
+            c__default.bold("`git add <file>`")
+          )} or ${c__default.cyan(c__default.bold("`git add .`"))} for stage all files.`
+        )
       );
       process.exit(1);
     }
@@ -251,6 +341,8 @@ yargs__default(helpers.hideBin(process.argv)).scriptName("noto").usage("$0 [args
     try {
       spin.start("Generating commit message...");
       const message = await generateCommitMessage(diff);
+      storage.lastGeneratedMessage = message;
+      await dump();
       const copy = args.copy;
       const apply = args.apply;
       spin.success(`Commit Message: ${c__default.dim(c__default.bold(message))}`);
@@ -259,7 +351,6 @@ yargs__default(helpers.hideBin(process.argv)).scriptName("noto").usage("$0 [args
         spin.success("Message copied to clipboard!");
       }
       if (apply) {
-        spin.start("Committing staged changes...");
         if (!await commit(message)) {
           spin.fail("Failed to commit staged changes.");
           process.exit(1);
@@ -271,4 +362,4 @@ yargs__default(helpers.hideBin(process.argv)).scriptName("noto").usage("$0 [args
       process.exit(1);
     }
   }
-).version().alias("-v", "--version").alias("-h", "--help").argv;
+).version("version", version).alias("-v", "--version").alias("-h", "--help").argv;

package/dist/cli.mjs

@@ -66,16 +66,24 @@ function spinner() {
       s.start();
     },
     fail(text) {
-      if (s)
-        s.fail(text);
+      if (!s) {
+        s = ora();
+      }
+      s.fail(text);
+      s = void 0;
     },
     success(text) {
-      if (s)
-        s.succeed(text);
+      if (!s) {
+        s = ora();
+      }
+      s.succeed(text);
+      s = void 0;
     },
     stop() {
-      if (s)
+      if (s) {
         s.stop();
+        s = void 0;
+      }
     }
   };
 }
@@ -136,7 +144,14 @@ async function generateCommitMessage(diff) {
     messages: [
       {
         role: "system",
-        content: "You are tasked with generating a Git commit message based on the following staged changes across multiple files. Identify only the key changes and generate a concise commit message in the format: <type>: <description>. The commit message must be a single line, in all lowercase, without a scope or body, and no full stops at the end. Use one of these types: feat, fix, refactor, docs, test, or chore. Do not mention file names unless a file was renamed or is essential to understanding the change. Focus on the most important change, and the message must not exceed 72 characters."
+        content: `You are tasked with generating a Git commit message for the following staged changes across multiple files. Strictly follow the instructions given below to generate the commit message. The instructions are given according to order of importance, as such, make sure each instruction is followed before moving on to the next. Likewise, make sure all instructions are followed successfully.
+          - Ensure the description is written in the present-tense(start with a present tense verb such as add, fix, update, remove, improve, implement, etc...) (IMPORTANT! follow this for java repositories as well).
+          - Identify the key changes only and generate a detailed but brief commit message in the format "<type>: <description>".
+          - Use one of these types: feat, fix, refactor, docs, test, or chore.
+          - The commit message must be a single line, in all lowercase, without a scope or body, and no full stops at the end.
+          - Ensure the message does not exceed 72 characters.
+          - Do not mention file names unless a file was renamed or is essential for understanding the changes.
+          - Focus on the most important changes.`
       },
       {
         role: "user",
@@ -148,6 +163,8 @@ ${diff}`
   return message.text.trim();
 }
 
+const version = "0.2.4";
+
 yargs(hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
   "config",
   "setup you API key to enable noto.",
@@ -192,6 +209,75 @@ yargs(hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
       );
     }
   }
+).command(
+  "prev",
+  "access previous commit message",
+  (args) => {
+    args.option("copy", {
+      alias: "c",
+      type: "boolean",
+      description: "Copy the previous commit message to the clipboard."
+    });
+    args.option("apply", {
+      alias: "a",
+      type: "boolean",
+      description: "Commit the staged changes with the previous message."
+    });
+  },
+  async (args) => {
+    const spin = spinner();
+    const storage = await load();
+    if (!storage.lastGeneratedMessage) {
+      console.log(c.red("No previous commit message found."));
+      console.log(
+        c.dim(
+          `Generate a new message with ${c.cyan(c.bold("`noto`"))} command.`
+        )
+      );
+      process.exit(1);
+    }
+    const message = storage.lastGeneratedMessage;
+    const copy = args.copy;
+    const apply = args.apply;
+    spin.success(`Previous Commit Message: ${c.dim(c.bold(message))}`);
+    if (copy) {
+      clipboardy.writeSync(message);
+      spin.success("Message copied to clipboard!");
+    }
+    if (apply) {
+      const cwd = process.cwd();
+      if (!isGitRepository(cwd)) {
+        console.log(
+          c.red("Oops! No Git repository found in the current directory.")
+        );
+        console.log(
+          c.dim(
+            `You can initialize one by running ${c.cyan(
+              c.bold("`git init`")
+            )}`
+          )
+        );
+        process.exit(1);
+      }
+      const diff = await getStagedDiff();
+      if (!diff) {
+        console.log(c.red("Oops! No staged changes found to commit."));
+        console.log(
+          c.dim(
+            `Stage changes with ${c.cyan(
+              c.bold("`git add <file>`")
+            )} or ${c.cyan(c.bold("`git add .`"))} for stage all files.`
+          )
+        );
+        process.exit(1);
+      }
+      if (!await commit(message)) {
+        spin.fail("Failed to commit staged changes.");
+        process.exit(1);
+      }
+      spin.success("Staged changes committed successfully!");
+    }
+  }
 ).command(
   "*",
   "generate commit message",
@@ -221,7 +307,9 @@ yargs(hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
         c.red("Oops! No Git repository found in the current directory.")
       );
       console.log(
-        `You can initialize one by running ${c.cyan(c.bold("`git init`"))}`
+        c.dim(
+          `You can initialize one by running ${c.cyan(c.bold("`git init`"))}`
+        )
       );
       process.exit(1);
     }
@@ -229,9 +317,11 @@ yargs(hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
     if (!diff) {
       console.log(c.red("Oops! No staged changes found to commit."));
       console.log(
-        `Stage changes with ${c.cyan(c.bold("`git add <file>`"))} or ${c.cyan(
-          c.bold("`git add .`")
-        )} for stage all files.`
+        c.dim(
+          `Stage changes with ${c.cyan(
+            c.bold("`git add <file>`")
+          )} or ${c.cyan(c.bold("`git add .`"))} for stage all files.`
+        )
       );
       process.exit(1);
     }
@@ -239,6 +329,8 @@ yargs(hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
     try {
       spin.start("Generating commit message...");
       const message = await generateCommitMessage(diff);
+      storage.lastGeneratedMessage = message;
+      await dump();
       const copy = args.copy;
       const apply = args.apply;
       spin.success(`Commit Message: ${c.dim(c.bold(message))}`);
@@ -247,7 +339,6 @@ yargs(hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
         spin.success("Message copied to clipboard!");
       }
       if (apply) {
-        spin.start("Committing staged changes...");
         if (!await commit(message)) {
           spin.fail("Failed to commit staged changes.");
           process.exit(1);
@@ -259,4 +350,4 @@ yargs(hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
       process.exit(1);
     }
   }
-).version().alias("-v", "--version").alias("-h", "--help").argv;
+).version("version", version).alias("-v", "--version").alias("-h", "--help").argv;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@snelusha/noto",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "generate clean commit messages in a snap! ✨",
   "license": "MIT",
   "author": {