@snelusha/noto 0.1.0 → 0.2.1

package/README.md

@@ -8,7 +8,10 @@
 
 ## Features
 
-- **Customizable:** Provide your own Google GenAI API Key for personalized experience.
+- **Instant Commit Messages**: Generate clear, context-aware messages based on staged changes.
+
+- **Seamless Git Integration**: Apply messages directly, skip the copy-paste.
+
 - **No Installation Required:** Use instantly with `npx @snelusha/noto` — just run and go!
 
 ## Getting Started
@@ -23,14 +26,33 @@
 Here, you’ll need to input your Google GenAI API Key.
 
 2. **Generate commit messages**
-    Simply run:
+   To generate a commit message, simply run:
+
+   ```bash
+   noto
+
+   # apply the generated message:
+   noto --apply
+   # or
+   noto -a
 
-    ```bash
-    noto
-    ```
+   # copy the generated message:
+   noto --copy
+   # or
+   noto -c
+   ```
+
+## Pro Tips
+
+- 🚀 Get fast commits on the fly with `noto -a` to streamline your workflow!
+
+## Contributing
+
+We welcome contributions and suggestions! If you have ideas or improvements, feel free to reach out or open a pull request.
 
 Thank you for using `noto`! If you have any feedback or suggestions, feel free to reach out or contribute to the project. ✨
 
 ## License
+
 This project is licensed under the MIT License.
 © 2024 [Sithija Nelusha Silva](https://github.com/snelusha)

package/dist/cli.cjs

@@ -3,12 +3,14 @@
 const yargs = require('yargs');
 const prompts = require('@posva/prompts');
 const c = require('picocolors');
+const clipboardy = require('clipboardy');
 const helpers = require('yargs/helpers');
 const node_path = require('node:path');
 const node_fs = require('node:fs');
 const os = require('node:os');
 const process$1 = require('node:process');
 require('which');
+const ora = require('ora');
 const tinyexec = require('tinyexec');
 const ai = require('ai');
 const google = require('@ai-sdk/google');
@@ -18,15 +20,17 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 const yargs__default = /*#__PURE__*/_interopDefaultCompat(yargs);
 const prompts__default = /*#__PURE__*/_interopDefaultCompat(prompts);
 const c__default = /*#__PURE__*/_interopDefaultCompat(c);
+const clipboardy__default = /*#__PURE__*/_interopDefaultCompat(clipboardy);
 const os__default = /*#__PURE__*/_interopDefaultCompat(os);
 const process__default = /*#__PURE__*/_interopDefaultCompat(process$1);
+const ora__default = /*#__PURE__*/_interopDefaultCompat(ora);
 
-const CLI_TEMP_DIR = node_path.join(os__default.tmpdir(), "snelusha-noto");
+const TEMP_DIR = node_path.join(os__default.tmpdir(), "snelusha-noto");
 let counter = 0;
 async function openTemp() {
-  if (!node_fs.existsSync(CLI_TEMP_DIR))
-    await node_fs.promises.mkdir(CLI_TEMP_DIR, { recursive: true });
-  const competitivePath = node_path.join(CLI_TEMP_DIR, `.${process__default.pid}.${counter}`);
+  if (!node_fs.existsSync(TEMP_DIR))
+    await node_fs.promises.mkdir(TEMP_DIR, { recursive: true });
+  const competitivePath = node_path.join(TEMP_DIR, `.${process__default.pid}.${counter}`);
   counter += 1;
   return node_fs.promises.open(competitivePath, "wx").then((fd) => ({
     fd,
@@ -62,22 +66,56 @@ async function writeFileSafe(path, data = "") {
   }
   return false;
 }
+function spinner() {
+  let s;
+  return {
+    start(text) {
+      s = ora__default(text);
+      s.spinner = {
+        interval: 150,
+        frames: ["\u2736", "\u2738", "\u2739", "\u273A", "\u2739", "\u2737"]
+      };
+      s.start();
+    },
+    fail(text) {
+      if (s)
+        s.fail(text);
+    },
+    success(text) {
+      if (s)
+        s.succeed(text);
+    },
+    stop() {
+      if (s)
+        s.stop();
+    }
+  };
+}
 
-let storage;
-const storagePath = node_path.resolve(CLI_TEMP_DIR, "storage.json");
+let storage = {};
+const storagePath = node_path.resolve(TEMP_DIR, "storage.json");
 async function load(fn) {
-  if (!storage) {
-    storage = node_fs.existsSync(storagePath) ? JSON.parse(await node_fs.promises.readFile(storagePath, "utf-8") || "{}") || {} : {};
-  }
-  if (fn) {
-    if (await fn(storage))
+  try {
+    if (!Object.keys(storage).length) {
+      storage = node_fs.existsSync(storagePath) ? JSON.parse(await node_fs.promises.readFile(storagePath, "utf-8") || "{}") || {} : {};
+    }
+    if (fn && await fn(storage)) {
       await dump();
+    }
+  } catch (error) {
+    console.error("error loading storage:", error);
+    storage = {};
   }
   return storage;
 }
 async function dump() {
-  if (storage)
-    await writeFileSafe(storagePath, JSON.stringify(storage));
+  try {
+    if (storage) {
+      await writeFileSafe(storagePath, JSON.stringify(storage, null, 2));
+    }
+  } catch (error) {
+    console.error("error saving storage:", error);
+  }
 }
 
 function isGitRepository(path) {
@@ -85,12 +123,20 @@ function isGitRepository(path) {
 }
 async function getStagedDiff() {
   try {
-    const fullDiff = (await tinyexec.x("git", ["diff", "--cached"])).stdout.toString();
-    return fullDiff;
+    const diff = (await tinyexec.x("git", ["diff", "--cached"])).stdout.toString();
+    return diff;
   } catch {
     return null;
   }
 }
+async function commit(message) {
+  try {
+    const result = await tinyexec.x("git", ["commit", "-m", message]);
+    return /file(s)? changed/i.test(result.stdout.toString());
+  } catch {
+    return false;
+  }
+}
 
 async function generateCommitMessage(diff) {
   const storage = await load();
@@ -116,56 +162,113 @@ ${diff}`
 
 yargs__default(helpers.hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
   "config",
-  "configure",
+  "setup you API key to enable noto.",
   () => {
   },
   async () => {
     const storage = await load();
     if (storage.apiKey) {
-      const response2 = await prompts__default({
-        type: "confirm",
-        name: "reset",
-        message: "Do you want to reset your API key?"
-      });
+      const response2 = await prompts__default(
+        {
+          type: "confirm",
+          name: "reset",
+          message: "Do you want to reset your API key?"
+        },
+        {
+          onCancel: () => process.exit(0)
+        }
+      );
       if (!response2.reset) {
-        console.log(`Use ${c__default.bold("`noto`")} to generate commit message!`);
+        console.log(
+          `Use ${c__default.greenBright(
+            c__default.bold("`noto`")
+          )} to generate your commit message!`
+        );
         return process.exit(0);
       }
     }
     const response = await prompts__default({
-      type: "text",
+      type: "password",
       name: "apiKey",
-      message: "Enter your API key:",
-      validate: (value) => value ? true : "API key is required"
+      message: "Please enter your API key:",
+      validate: (value) => value ? true : "API key is required!"
     });
-    storage.apiKey = response.apiKey;
-    dump();
-    console.log(`Use ${c__default.bold("`noto`")} to generate commit message!`);
+    if (response.apiKey) {
+      storage.apiKey = response.apiKey;
+      dump();
+      console.log("API key saved successfully!");
+      console.log(
+        `Use ${c__default.greenBright(
+          c__default.bold("`noto`")
+        )} to generate your commit message!`
+      );
+    }
   }
 ).command(
   "*",
   "generate commit message",
-  () => {
+  (args) => {
+    args.option("copy", {
+      alias: "c",
+      type: "boolean",
+      description: "Copy the generated commit message to the clipboard."
+    });
+    args.option("apply", {
+      alias: "a",
+      type: "boolean",
+      description: "Commit the staged changes with the generated message."
+    });
   },
-  async () => {
+  async (args) => {
     const storage = await load();
     if (!storage.apiKey) {
       console.log(
-        `Please run ${c__default.bold("`noto config`")} to set your API key.`
+        `Please run ${c__default.cyan(c__default.bold("`noto config`"))} to set your API key.`
       );
       process.exit(1);
     }
     const cwd = process.cwd();
     if (!isGitRepository(cwd)) {
-      console.log(c__default.red("hmm! git repository not found"));
+      console.log(
+        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`"))}`
+      );
       process.exit(1);
     }
     const diff = await getStagedDiff();
     if (!diff) {
-      console.log(c__default.red("hmm! no staged diff found"));
+      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.`
+      );
+      process.exit(1);
+    }
+    const spin = spinner();
+    try {
+      spin.start("Generating commit message...");
+      const message = await generateCommitMessage(diff);
+      const copy = args.copy;
+      const apply = args.apply;
+      spin.success(`Commit Message: ${c__default.dim(c__default.bold(message))}`);
+      if (copy) {
+        clipboardy__default.writeSync(message);
+        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);
+        }
+        spin.success("Staged changes committed successfully!");
+      }
+    } catch (error) {
+      spin.fail("Failed to generate commit message.");
       process.exit(1);
     }
-    const message = await generateCommitMessage(diff);
-    console.log(c__default.white(message));
   }
-).alias("-v", "--version").alias("-h", "--help").argv;
+).version().alias("-v", "--version").alias("-h", "--help").argv;

package/dist/cli.mjs

@@ -1,22 +1,24 @@
 import yargs from 'yargs';
 import prompts from '@posva/prompts';
 import c from 'picocolors';
+import clipboardy from 'clipboardy';
 import { hideBin } from 'yargs/helpers';
 import { join, dirname, resolve } from 'node:path';
 import { promises, existsSync } from 'node:fs';
 import os from 'node:os';
 import process$1 from 'node:process';
 import 'which';
+import ora from 'ora';
 import { x } from 'tinyexec';
 import { generateText } from 'ai';
 import { createGoogleGenerativeAI } from '@ai-sdk/google';
 
-const CLI_TEMP_DIR = join(os.tmpdir(), "snelusha-noto");
+const TEMP_DIR = join(os.tmpdir(), "snelusha-noto");
 let counter = 0;
 async function openTemp() {
-  if (!existsSync(CLI_TEMP_DIR))
-    await promises.mkdir(CLI_TEMP_DIR, { recursive: true });
-  const competitivePath = join(CLI_TEMP_DIR, `.${process$1.pid}.${counter}`);
+  if (!existsSync(TEMP_DIR))
+    await promises.mkdir(TEMP_DIR, { recursive: true });
+  const competitivePath = join(TEMP_DIR, `.${process$1.pid}.${counter}`);
   counter += 1;
   return promises.open(competitivePath, "wx").then((fd) => ({
     fd,
@@ -52,22 +54,56 @@ async function writeFileSafe(path, data = "") {
   }
   return false;
 }
+function spinner() {
+  let s;
+  return {
+    start(text) {
+      s = ora(text);
+      s.spinner = {
+        interval: 150,
+        frames: ["\u2736", "\u2738", "\u2739", "\u273A", "\u2739", "\u2737"]
+      };
+      s.start();
+    },
+    fail(text) {
+      if (s)
+        s.fail(text);
+    },
+    success(text) {
+      if (s)
+        s.succeed(text);
+    },
+    stop() {
+      if (s)
+        s.stop();
+    }
+  };
+}
 
-let storage;
-const storagePath = resolve(CLI_TEMP_DIR, "storage.json");
+let storage = {};
+const storagePath = resolve(TEMP_DIR, "storage.json");
 async function load(fn) {
-  if (!storage) {
-    storage = existsSync(storagePath) ? JSON.parse(await promises.readFile(storagePath, "utf-8") || "{}") || {} : {};
-  }
-  if (fn) {
-    if (await fn(storage))
+  try {
+    if (!Object.keys(storage).length) {
+      storage = existsSync(storagePath) ? JSON.parse(await promises.readFile(storagePath, "utf-8") || "{}") || {} : {};
+    }
+    if (fn && await fn(storage)) {
       await dump();
+    }
+  } catch (error) {
+    console.error("error loading storage:", error);
+    storage = {};
   }
   return storage;
 }
 async function dump() {
-  if (storage)
-    await writeFileSafe(storagePath, JSON.stringify(storage));
+  try {
+    if (storage) {
+      await writeFileSafe(storagePath, JSON.stringify(storage, null, 2));
+    }
+  } catch (error) {
+    console.error("error saving storage:", error);
+  }
 }
 
 function isGitRepository(path) {
@@ -75,12 +111,20 @@ function isGitRepository(path) {
 }
 async function getStagedDiff() {
   try {
-    const fullDiff = (await x("git", ["diff", "--cached"])).stdout.toString();
-    return fullDiff;
+    const diff = (await x("git", ["diff", "--cached"])).stdout.toString();
+    return diff;
   } catch {
     return null;
   }
 }
+async function commit(message) {
+  try {
+    const result = await x("git", ["commit", "-m", message]);
+    return /file(s)? changed/i.test(result.stdout.toString());
+  } catch {
+    return false;
+  }
+}
 
 async function generateCommitMessage(diff) {
   const storage = await load();
@@ -106,56 +150,113 @@ ${diff}`
 
 yargs(hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
   "config",
-  "configure",
+  "setup you API key to enable noto.",
   () => {
   },
   async () => {
     const storage = await load();
     if (storage.apiKey) {
-      const response2 = await prompts({
-        type: "confirm",
-        name: "reset",
-        message: "Do you want to reset your API key?"
-      });
+      const response2 = await prompts(
+        {
+          type: "confirm",
+          name: "reset",
+          message: "Do you want to reset your API key?"
+        },
+        {
+          onCancel: () => process.exit(0)
+        }
+      );
       if (!response2.reset) {
-        console.log(`Use ${c.bold("`noto`")} to generate commit message!`);
+        console.log(
+          `Use ${c.greenBright(
+            c.bold("`noto`")
+          )} to generate your commit message!`
+        );
         return process.exit(0);
       }
     }
     const response = await prompts({
-      type: "text",
+      type: "password",
       name: "apiKey",
-      message: "Enter your API key:",
-      validate: (value) => value ? true : "API key is required"
+      message: "Please enter your API key:",
+      validate: (value) => value ? true : "API key is required!"
     });
-    storage.apiKey = response.apiKey;
-    dump();
-    console.log(`Use ${c.bold("`noto`")} to generate commit message!`);
+    if (response.apiKey) {
+      storage.apiKey = response.apiKey;
+      dump();
+      console.log("API key saved successfully!");
+      console.log(
+        `Use ${c.greenBright(
+          c.bold("`noto`")
+        )} to generate your commit message!`
+      );
+    }
   }
 ).command(
   "*",
   "generate commit message",
-  () => {
+  (args) => {
+    args.option("copy", {
+      alias: "c",
+      type: "boolean",
+      description: "Copy the generated commit message to the clipboard."
+    });
+    args.option("apply", {
+      alias: "a",
+      type: "boolean",
+      description: "Commit the staged changes with the generated message."
+    });
   },
-  async () => {
+  async (args) => {
     const storage = await load();
     if (!storage.apiKey) {
       console.log(
-        `Please run ${c.bold("`noto config`")} to set your API key.`
+        `Please run ${c.cyan(c.bold("`noto config`"))} to set your API key.`
       );
       process.exit(1);
     }
     const cwd = process.cwd();
     if (!isGitRepository(cwd)) {
-      console.log(c.red("hmm! git repository not found"));
+      console.log(
+        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`"))}`
+      );
       process.exit(1);
     }
     const diff = await getStagedDiff();
     if (!diff) {
-      console.log(c.red("hmm! no staged diff found"));
+      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.`
+      );
+      process.exit(1);
+    }
+    const spin = spinner();
+    try {
+      spin.start("Generating commit message...");
+      const message = await generateCommitMessage(diff);
+      const copy = args.copy;
+      const apply = args.apply;
+      spin.success(`Commit Message: ${c.dim(c.bold(message))}`);
+      if (copy) {
+        clipboardy.writeSync(message);
+        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);
+        }
+        spin.success("Staged changes committed successfully!");
+      }
+    } catch (error) {
+      spin.fail("Failed to generate commit message.");
       process.exit(1);
     }
-    const message = await generateCommitMessage(diff);
-    console.log(c.white(message));
   }
-).alias("-v", "--version").alias("-h", "--help").argv;
+).version().alias("-v", "--version").alias("-h", "--help").argv;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@snelusha/noto",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "generate clean commit messages in a snap! ✨",
   "license": "MIT",
   "author": {
@@ -28,7 +28,8 @@
   ],
   "scripts": {
     "build": "unbuild",
-    "start": "esno cli.ts"
+    "start": "esno cli.ts",
+    "publish": "npm publish --public"
   },
   "devDependencies": {
     "@types/bun": "latest",
@@ -43,6 +44,8 @@
     "@ai-sdk/google": "^0.0.51",
     "@posva/prompts": "^2.4.4",
     "ai": "^3.4.9",
+    "clipboardy": "^4.0.0",
+    "ora": "^8.1.0",
     "picocolors": "^1.1.0",
     "tinyexec": "^0.3.0",
     "unbuild": "^2.0.0",