neuro-commit 0.1.0 → 0.1.2

package/README.md

@@ -1,17 +1,43 @@
 <h1 align="center">NeuroCommit</h1>
 <p align="center">
-  <a href="https://www.npmjs.com/package/neuro-commit"><img src="https://img.shields.io/npm/v/neuro-commit.svg?colorB=97CA00&label=version"></a>
-  <a href="https://www.npmjs.com/package/neuro-commit"><img src="https://img.shields.io/npm/dm/neuro-commit.svg?colorB=97CA00&label=downloads"></a>
-  <a href="https://github.com/cr1ma/neuro-commit/blob/main/LICENSE"><img src="https://img.shields.io/github/license/cr1ma/neuro-commit"></a>
-  <a href="https://github.com/cr1ma/neuro-commit/actions/workflows/publish.yml"><img src="https://github.com/cr1ma/neuro-commit/actions/workflows/publish.yml/badge.svg"></a>
+  <strong>AI-ready commit message generator powered by <code>git diff</code></strong>
 </p>
-
 <p align="center">
-  A tool for generating high-quality commit messages based on <code>git diff</code>, designed for further use with neural networks.
+  <a href="https://www.npmjs.com/package/neuro-commit"><img src="https://img.shields.io/npm/v/neuro-commit.svg?colorB=97CA00&label=version" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/neuro-commit"><img src="https://img.shields.io/npm/dm/neuro-commit.svg?colorB=97CA00&label=downloads" alt="npm downloads"></a>
+  <a href="https://github.com/cr1ma/neuro-commit/blob/main/LICENSE"><img src="https://img.shields.io/github/license/cr1ma/neuro-commit" alt="license"></a>
+  <a href="https://github.com/cr1ma/neuro-commit/actions/workflows/publish.yml"><img src="https://github.com/cr1ma/neuro-commit/actions/workflows/publish.yml/badge.svg" alt="publish status"></a>
+  <a href="https://github.com/cr1ma/neuro-commit/issues"><img src="https://img.shields.io/github/issues/cr1ma/neuro-commit" alt="open issues"></a>
 </p>
 
 ---
 
+**NeuroCommit** is a zero-config CLI tool that analyzes your staged Git changes and generates a clean, structured Markdown summary — ready to be fed into any AI/LLM for high-quality commit message generation.
+
+<p align="center">
+  <img src="docs/assets/neuro-commit-screenshot.png" alt="NeuroCommit CLI screenshot" width="700">
+</p>
+
+## Table of Contents
+
+- [Features](#-features)
+- [Quick Start](#-quick-start)
+- [How It Works](#-how-it-works)
+- [Development](#-development)
+- [Contributing](#-contributing)
+- [Security](#-security)
+- [License](#-license)
+- [Star History](#-star-history)
+
+## ✨ Features
+
+- **Zero configuration** — works out of the box with any Git repository
+- **Interactive TUI** — beautiful terminal menu with keyboard navigation
+- **Smart lock file handling** — detects lock files (`package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `Cargo.lock`, etc.) and omits their noisy diffs
+- **Token estimation** — reports estimated token count (using `o200k_base` tokenizer) so you know the prompt size before pasting into an LLM
+- **Structured Markdown output** — generates a `neuro-commit.md` with file list, per-file stats, and full diff
+- **Update notifications** — automatically notifies you when a new version is available
+
 ## 🚀 Quick Start
 
 ### Using npx (No Installation Required)
@@ -37,18 +63,29 @@ neuro-commit
 1. Stage your changes with `git add`
 2. Run `neuro-commit`
 3. Select **Commit** mode from the interactive menu
-4. The tool collects your staged diff, file list and stats
-5. A `neuro-commit.md` file is generated in the current directory with:
-   - Combined file list with statuses (`M`, `A`, `D`, etc.) and per-file stats
-   - Lock file updates mentioned without noisy diffs
-   - Summary of total insertions / deletions
+4. The tool collects your staged diff, file list, and per-file stats
+5. A `neuro-commit.md` file is generated in the current directory containing:
+   - File list with statuses (`Added`, `Modified`, `Deleted`, etc.) and per-file insertions/deletions
+   - Lock file entries listed without their diffs
+   - Summary line with total files changed, insertions, and deletions
    - Full diff output in a fenced `diff` code block
+6. Copy the contents of `neuro-commit.md` into your preferred AI assistant and ask it to write a commit message
 
-> **Note:** Lock files (`package-lock.json`, `pnpm-lock.yaml`, `yarn.lock`, `uv.lock`, `Cargo.lock`, etc.) are listed as updated but their diffs are omitted to keep the output clean.
+> **Tip:** Lock files (`package-lock.json`, `pnpm-lock.yaml`, `yarn.lock`, `uv.lock`, `Cargo.lock`, and others) are listed as changed but their diffs are omitted to keep the output clean and token-efficient.
 
 ## 🔧 Development
 
 ```bash
+# Clone the repository
+git clone https://github.com/cr1ma/neuro-commit.git
+cd neuro-commit
+
+# Install dependencies
+npm install
+
+# Run locally
+npm start
+
 # Lint
 npm run lint
 
@@ -56,13 +93,19 @@ npm run lint
 npm run lint:fix
 ```
 
-## 📝 License
+## 🤝 Contributing
 
-[Apache License 2.0](LICENSE)
+Contributions, issues, and feature requests are welcome! Please read the [Contributing Guide](CONTRIBUTING.md) before submitting a pull request.
 
-## 🤝 Contributing
+Feel free to check the [open issues](https://github.com/cr1ma/neuro-commit/issues).
+
+## 🔒 Security
+
+To report a vulnerability, please see our [Security Policy](SECURITY.md).
+
+## 📝 License
 
-Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/cr1ma/neuro-commit/issues).
+This project is licensed under the [Apache License 2.0](LICENSE).
 
 ## ⭐ Star History
 

package/bin/neuro-commit.js

@@ -119,6 +119,21 @@ async function main() {
   console.clear();
   console.log(banner);
 
+  try {
+    const { default: updateNotifier } = await import("update-notifier");
+    const pkg = require("../package.json");
+
+    updateNotifier({
+      pkg,
+      updateCheckInterval: 1000 * 60 * 60 * 24,
+    }).notify({
+      defer: false,
+      isGlobal: true,
+    });
+  } catch {
+    // Ignore update check errors
+  }
+
   const choice = await showMenu();
 
   switch (choice) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neuro-commit",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "neuro-commit CLI utility",
   "author": "cr1ma.dev",
   "bin": {
@@ -38,6 +38,7 @@
     "globals": "^17.3.0"
   },
   "dependencies": {
-    "tiktoken": "^1.0.22"
+    "tiktoken": "^1.0.22",
+    "update-notifier": "^7.3.1"
   }
 }

package/src/commit.js

@@ -22,12 +22,50 @@ const CYAN = "\x1b[36m";
 const OUTPUT_FILE = "neuro-commit.md";
 const encoder = get_encoding("o200k_base");
 
+// AI Prompt that will be added at the beginning of the generated file
+const AI_PROMPT = `You are an expert in writing commit messages for repositories. Your task is to write me a commit message based on my diff file, which I will provide to you.
+
+### Rules for writing a commit message:
+
+1. Write in English, strictly considering the context.
+2. Return the answer using markdown formatting.
+3. Use the imperative mood, as if you are giving a command to the system that corresponds to messages that create changes in the code.
+4. The first line of the message (title) should be short, usually no longer than 50 characters. This makes it easier to quickly understand the changes. Do not end the title with a period.
+5. Leave one empty line after the title before starting the body of the message. This separation helps Git tools to correctly display the message text.
+6. Commits with messages like "Fix" or "Update" do not provide useful information. Always explain what exactly was fixed or updated.
+7. **Use lowercase letters to describe change types. Use** semantic tags in message titles:
+   - \`feat:\` — adding a new feature
+   - \`fix:\` — bug fixes
+   - \`docs:\` — changes in documentation
+   - \`style:\` — changes that do not affect the code (e.g., formatting fixes)
+   - \`refactor:\` — code change that doesn't add new functionality or fix bugs
+   - \`test:\` — adding or changing tests
+
+### Example of a correct commit message:
+
+\`\`\`diff
+refactor: update environment configuration and API connection
+
+- Edited \`.env\` file to support different environments (production, development) and API connection modes (docker, local, remote).
+- Updated \`config.py\` to load tokens and URLs depending on the environment and API mode.
+- Removed logic for determining the operating system.
+- Updated \`api_client.py\` to use BASE_API_URL instead of OS-specific URLs.
+- Reduced the number of retries in \`_make_request\`.
+\`\`\`
+
+---
+
+`;
+
 /**
  * Build the markdown content for neuro-commit.md
  */
 function buildMarkdown(stagedFiles, diff, numstat) {
   const lines = [];
 
+  // Start with the AI prompt
+  lines.push(AI_PROMPT);
+
   const lockFiles = stagedFiles.filter((f) => isLockFile(f.file));
   const regularFiles = stagedFiles.filter((f) => !isLockFile(f.file));
 
@@ -104,6 +142,14 @@ function printSummary(files, content, outputFile) {
     `${CYAN}✓${RESET} Generated ${BOLD}${outputFile}${RESET} ${DIM}(${formatNumber(totalFiles)} files, ${formatNumber(totalTokens)} tokens, ${formatNumber(totalChars)} chars)${RESET}`,
   );
   console.log("");
+  console.log(`${BOLD}Next steps:${RESET}`);
+  console.log(`  1. Open ${CYAN}${outputFile}${RESET}`);
+  console.log(
+    `  2. Copy the ${BOLD}entire content${RESET} (AI prompt is already included!)`,
+  );
+  console.log(`  3. Paste into your LLM (ChatGPT, Claude, etc.)`);
+  console.log(`  4. Get your perfect commit message! 🎉`);
+  console.log("");
 }
 
 /**