@snelusha/noto 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Sithija Nelusha Silva<https://github.com/snelusha>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+<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>
+
+<pre align="center">
+  <p>npm install -g <b>@snelusha/noto</b></p>
+</pre>
+
+## Features
+
+- **Customizable:** Provide your own Google GenAI API Key for personalized experience.
+- **No Installation Required:** Use instantly with `npx @snelusha/noto` — just run and go!
+
+## Getting Started
+
+1. **Configuration:**
+   Before diving in, run the following command to configure your `noto`:
+
+   ```bash
+   noto config
+   ```
+
+Here, you’ll need to input your Google GenAI API Key.
+
+2. **Generate commit messages**
+    Simply run:
+
+    ```bash
+    noto
+    ```
+
+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/bin/noto.mjs

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+'use strict'
+
+import '../dist/cli.mjs'

package/dist/cli.cjs

@@ -0,0 +1,171 @@
+'use strict';
+
+const yargs = require('yargs');
+const prompts = require('@posva/prompts');
+const c = require('picocolors');
+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 tinyexec = require('tinyexec');
+const ai = require('ai');
+const google = require('@ai-sdk/google');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const yargs__default = /*#__PURE__*/_interopDefaultCompat(yargs);
+const prompts__default = /*#__PURE__*/_interopDefaultCompat(prompts);
+const c__default = /*#__PURE__*/_interopDefaultCompat(c);
+const os__default = /*#__PURE__*/_interopDefaultCompat(os);
+const process__default = /*#__PURE__*/_interopDefaultCompat(process$1);
+
+const CLI_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}`);
+  counter += 1;
+  return node_fs.promises.open(competitivePath, "wx").then((fd) => ({
+    fd,
+    path: competitivePath,
+    cleanup() {
+      fd.close().then(() => {
+        if (node_fs.existsSync(competitivePath))
+          node_fs.promises.unlink(competitivePath);
+      });
+    }
+  })).catch((error) => {
+    if (error && error.code === "EEXIST")
+      return openTemp();
+    else
+      return void 0;
+  });
+}
+async function writeFileSafe(path, data = "") {
+  const temp = await openTemp();
+  if (temp) {
+    try {
+      await node_fs.promises.writeFile(temp.path, data);
+      const directory = node_path.dirname(path);
+      if (!node_fs.existsSync(directory))
+        await node_fs.promises.mkdir(directory, { recursive: true });
+      await node_fs.promises.rename(temp.path, path);
+      return true;
+    } catch {
+      return false;
+    } finally {
+      temp.cleanup();
+    }
+  }
+  return false;
+}
+
+let storage;
+const storagePath = node_path.resolve(CLI_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))
+      await dump();
+  }
+  return storage;
+}
+async function dump() {
+  if (storage)
+    await writeFileSafe(storagePath, JSON.stringify(storage));
+}
+
+function isGitRepository(path) {
+  return node_fs.existsSync(node_path.join(path, ".git"));
+}
+async function getStagedDiff() {
+  try {
+    const fullDiff = (await tinyexec.x("git", ["diff", "--cached"])).stdout.toString();
+    return fullDiff;
+  } catch {
+    return null;
+  }
+}
+
+async function generateCommitMessage(diff) {
+  const storage = await load();
+  const google$1 = google.createGoogleGenerativeAI({
+    apiKey: storage.apiKey
+  });
+  const message = await ai.generateText({
+    model: google$1("gemini-1.5-flash-latest"),
+    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."
+      },
+      {
+        role: "user",
+        content: `generated commit message for the following staged changes:
+${diff}`
+      }
+    ]
+  });
+  return message.text.trim();
+}
+
+yargs__default(helpers.hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
+  "config",
+  "configure",
+  () => {
+  },
+  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?"
+      });
+      if (!response2.reset) {
+        console.log(`Use ${c__default.bold("`noto`")} to generate commit message!`);
+        return process.exit(0);
+      }
+    }
+    const response = await prompts__default({
+      type: "text",
+      name: "apiKey",
+      message: "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!`);
+  }
+).command(
+  "*",
+  "generate commit message",
+  () => {
+  },
+  async () => {
+    const storage = await load();
+    if (!storage.apiKey) {
+      console.log(
+        `Please run ${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"));
+      process.exit(1);
+    }
+    const diff = await getStagedDiff();
+    if (!diff) {
+      console.log(c__default.red("hmm! no staged diff found"));
+      process.exit(1);
+    }
+    const message = await generateCommitMessage(diff);
+    console.log(c__default.white(message));
+  }
+).alias("-v", "--version").alias("-h", "--help").argv;

package/dist/cli.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.d.mts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.mjs

@@ -0,0 +1,161 @@
+import yargs from 'yargs';
+import prompts from '@posva/prompts';
+import c from 'picocolors';
+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 { x } from 'tinyexec';
+import { generateText } from 'ai';
+import { createGoogleGenerativeAI } from '@ai-sdk/google';
+
+const CLI_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}`);
+  counter += 1;
+  return promises.open(competitivePath, "wx").then((fd) => ({
+    fd,
+    path: competitivePath,
+    cleanup() {
+      fd.close().then(() => {
+        if (existsSync(competitivePath))
+          promises.unlink(competitivePath);
+      });
+    }
+  })).catch((error) => {
+    if (error && error.code === "EEXIST")
+      return openTemp();
+    else
+      return void 0;
+  });
+}
+async function writeFileSafe(path, data = "") {
+  const temp = await openTemp();
+  if (temp) {
+    try {
+      await promises.writeFile(temp.path, data);
+      const directory = dirname(path);
+      if (!existsSync(directory))
+        await promises.mkdir(directory, { recursive: true });
+      await promises.rename(temp.path, path);
+      return true;
+    } catch {
+      return false;
+    } finally {
+      temp.cleanup();
+    }
+  }
+  return false;
+}
+
+let storage;
+const storagePath = resolve(CLI_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))
+      await dump();
+  }
+  return storage;
+}
+async function dump() {
+  if (storage)
+    await writeFileSafe(storagePath, JSON.stringify(storage));
+}
+
+function isGitRepository(path) {
+  return existsSync(join(path, ".git"));
+}
+async function getStagedDiff() {
+  try {
+    const fullDiff = (await x("git", ["diff", "--cached"])).stdout.toString();
+    return fullDiff;
+  } catch {
+    return null;
+  }
+}
+
+async function generateCommitMessage(diff) {
+  const storage = await load();
+  const google = createGoogleGenerativeAI({
+    apiKey: storage.apiKey
+  });
+  const message = await generateText({
+    model: google("gemini-1.5-flash-latest"),
+    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."
+      },
+      {
+        role: "user",
+        content: `generated commit message for the following staged changes:
+${diff}`
+      }
+    ]
+  });
+  return message.text.trim();
+}
+
+yargs(hideBin(process.argv)).scriptName("noto").usage("$0 [args]").command(
+  "config",
+  "configure",
+  () => {
+  },
+  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?"
+      });
+      if (!response2.reset) {
+        console.log(`Use ${c.bold("`noto`")} to generate commit message!`);
+        return process.exit(0);
+      }
+    }
+    const response = await prompts({
+      type: "text",
+      name: "apiKey",
+      message: "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!`);
+  }
+).command(
+  "*",
+  "generate commit message",
+  () => {
+  },
+  async () => {
+    const storage = await load();
+    if (!storage.apiKey) {
+      console.log(
+        `Please run ${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"));
+      process.exit(1);
+    }
+    const diff = await getStagedDiff();
+    if (!diff) {
+      console.log(c.red("hmm! no staged diff found"));
+      process.exit(1);
+    }
+    const message = await generateCommitMessage(diff);
+    console.log(c.white(message));
+  }
+).alias("-v", "--version").alias("-h", "--help").argv;

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@snelusha/noto",
+  "type": "module",
+  "version": "0.1.0",
+  "description": "generate clean commit messages in a snap! ✨",
+  "license": "MIT",
+  "author": {
+    "name": "Sithija Nelusha Silva",
+    "email": "hello@snelusha.dev",
+    "url": "https://snelusha.dev"
+  },
+  "homepage": "https://github.com/snelusha/noto",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/snelusha/noto.git"
+  },
+  "bugs": {
+    "url": "https://github.com/snelusha/noto/issues"
+  },
+  "main": "dist/cli.mjs",
+  "module": "dist/cli.mjs",
+  "types": "dist/cli.d.ts",
+  "bin": {
+    "noto": "bin/noto.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "start": "esno cli.ts"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/which": "^3.0.4",
+    "@types/yargs": "^17.0.33",
+    "esno": "^4.8.0"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "@ai-sdk/google": "^0.0.51",
+    "@posva/prompts": "^2.4.4",
+    "ai": "^3.4.9",
+    "picocolors": "^1.1.0",
+    "tinyexec": "^0.3.0",
+    "unbuild": "^2.0.0",
+    "which": "^5.0.0",
+    "yargs": "^17.7.2"
+  }
+}