@snelusha/noto 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,108 @@
+<h1 align="center">noto ✨</h1>
+<p align="center"><sup>(/nōto/, <em>notebook</em> in Japanese)</sup></p>
+<img src="https://github.com/snelusha/static/blob/main/noto/banner.png?raw=true" align="center"></img>
+
+## Features
+
+- **Instant Commit Messages**: Generate clear, context-aware messages based on staged changes.
+
+- **Seamless Git Integration**: Apply messages directly, skip the copy-paste.
+
+- **Interactive Editing:** Easily refine your commit message with the new `--edit` flag.
+
+- **Enhanced Configuration:** Manage your LLM model preferences with an improved configuration interface.
+
+## Installation
+
+Install noto globally using npm:
+
+```bash
+npm install -g @snelusha/noto
+```
+
+After installation, you can run `noto` from any terminal.
+
+## Prerequisites
+
+Before using noto, you must configure your [Google Generative API](https://aistudio.google.com/app/apikey) key. Run the following command to set it up:
+
+```bash
+noto config key # or simply noto config key YOUR_API_KEY
+```
+
+Optionally, if you wish to configure a different Gemini model (the default model will be used if not configured), run:
+
+```bash
+noto config model
+```
+
+If you ever need to reset your configuration, you can now run:
+
+```bash
+noto config reset
+```
+
+## Usage
+
+Generate a new commit message:
+
+```bash
+noto
+```
+
+Apply the generated commit message to your current commit:
+
+```bash
+noto --apply # or simply noto -a
+```
+
+Copy the generated commit message to your clipboard:
+
+```bash
+noto --copy # or simply noto -c
+```
+
+Specify the commit type for your commit message:
+
+```bash
+noto --type # or simply noto -t
+
+noto --type chore # or simply noto -t chore
+```
+
+Open an interactive editor to refine the generated commit message:
+
+```bash
+noto --edit # or simply noto -e
+```
+
+Combine all flags to specify the commit type, open the interactive editor, and apply the generated commit message in one go:
+
+```bash
+noto --edit --type feat --apply  # or simply: noto -e -t feat -a
+```
+
+This command will generate a commit message for a "feat" commit, let you refine it interactively, and then apply it directly to your current commit.
+
+Retrieve the previously generated commit message:
+
+```bash
+noto prev
+```
+
+Note: All of the flags shown above (`--apply`, `--copy`, `--type`, `--edit`) can also be used with the `noto prev` command to work with the previously generated commit message.
+
+## Pro Tips
+
+- 🚀 Get fast commits on the fly with `noto -e -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/index.js

@@ -118,6 +118,10 @@ var StorageManager = class {
     await this.load();
     return JSON.parse(JSON.stringify(this.storage));
   }
+  static async clear() {
+    this.storage = {};
+    await this.save();
+  }
 };
 
 // src/utils/process.ts
@@ -550,7 +554,24 @@ var model = {
     console.log();
   }
 };
-var subCommands = [key, model];
+var reset = {
+  name: "reset",
+  description: "reset configuration",
+  usage: "noto config reset",
+  execute: async () => {
+    const confirm2 = await p5.confirm({
+      message: "are you sure you want to reset the configuration?"
+    });
+    if (p5.isCancel(confirm2) || !confirm2) {
+      p5.log.error(color5.red("nothing changed!"));
+      return await exit(1);
+    }
+    await StorageManager.clear();
+    p5.log.success(color5.green("configuration reset!"));
+    console.log();
+  }
+};
+var subCommands = [key, model, reset];
 var command3 = {
   name: "config",
   description: "configure noto",
@@ -585,7 +606,7 @@ var getCommand = (name, cmds = commands) => {
 };
 
 // package.json
-var version = "1.0.0";
+var version = "1.0.2";
 
 // src/index.ts
 var globalSpec = {
@@ -611,7 +632,7 @@ function main() {
     );
     if (subCommand) {
       selectedCommand = subCommand;
-      commandArgs = commandArgs.slice(1);
+      commandArgs = commandArgs.slice(2);
     }
   }
   const commandSpec = (selectedCommand.options ?? []).reduce((acc, opt) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snelusha/noto",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Generate clean commit messages in a snap! ✨",
   "license": "MIT",
   "type": "module",
@@ -40,21 +40,21 @@
     "cli"
   ],
   "devDependencies": {
-    "@types/node": "^22.12.0",
-    "tsup": "^8.3.6",
-    "typescript": "^5.7.3"
+    "@types/node": "^22.13.10",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2"
   },
   "dependencies": {
-    "@ai-sdk/google": "^1.1.14",
+    "@ai-sdk/google": "^1.1.20",
     "@clack/prompts": "^0.10.0",
-    "ai": "^4.1.40",
+    "ai": "^4.1.54",
     "arg": "^5.0.2",
     "clipboardy": "^4.0.0",
     "dedent": "^1.5.3",
     "picocolors": "^1.1.1",
     "simple-git": "^3.27.0",
     "tinyexec": "^0.3.2",
-    "vitest": "^3.0.5",
+    "vitest": "^3.0.8",
     "zod": "^3.24.2"
   }
 }