neuro-commit 0.1.1 → 0.1.3

package/bin/neuro-commit.js

@@ -2,6 +2,17 @@
 
 const readline = require("readline");
 const { runCommitMode } = require("../src/commit");
+const pkg = require("../package.json");
+
+// --- ANSI helpers ---
+const RESET = "\x1b[0m";
+const BOLD = "\x1b[1m";
+const DIM = "\x1b[2m";
+const GREEN = "\x1b[32m";
+const YELLOW = "\x1b[33m";
+const CYAN = "\x1b[36m";
+const HIDE_CURSOR = "\x1b[?25l";
+const SHOW_CURSOR = "\x1b[?25h";
 
 const banner = `
 ███╗   ██╗███████╗██╗   ██╗██████╗  ██████╗        ██████╗ ██████╗ ███╗   ███╗███╗   ███╗██╗████████╗
@@ -12,20 +23,45 @@ const banner = `
 ╚═╝  ╚═══╝╚══════╝ ╚═════╝ ╚═╝  ╚═╝ ╚═════╝        ╚═════╝ ╚═════╝ ╚═╝     ╚═╝╚═╝     ╚═╝╚═╝   ╚═╝                                                                                                      
 `;
 
+// --- CLI flags ---
+const args = process.argv.slice(2);
+
+if (args.includes("--help") || args.includes("-h")) {
+  console.log(`
+${BOLD}neuro-commit${RESET} v${pkg.version} — AI-powered commit message generator
+
+${BOLD}USAGE${RESET}
+  neuro-commit              Launch interactive mode
+  neuro-commit [options]
+
+${BOLD}OPTIONS${RESET}
+  -h, --help                Show this help message
+  -v, --version             Show installed version
+
+${BOLD}WORKFLOW${RESET}
+  1. Stage your changes      ${DIM}git add <files>${RESET}
+  2. Run neuro-commit        ${DIM}neuro-commit${RESET}
+  3. Copy generated file     ${DIM}neuro-commit.md${RESET}
+  4. Paste into your LLM     ${DIM}(ChatGPT, Claude, etc.)${RESET}
+  5. Get your commit message!
+
+${BOLD}LINKS${RESET}
+  Repository   ${CYAN}${pkg.homepage}${RESET}
+  Issues       ${CYAN}${pkg.bugs.url}${RESET}
+`);
+  process.exit(0);
+}
+
+if (args.includes("--version") || args.includes("-v")) {
+  console.log(`neuro-commit v${pkg.version}`);
+  process.exit(0);
+}
+
 // --- Menu options ---
 const menuItems = [
   { label: "Commit", icon: "📝", description: "Generate a commit message" },
 ];
 
-// --- ANSI helpers ---
-const RESET = "\x1b[0m";
-const BOLD = "\x1b[1m";
-const DIM = "\x1b[2m";
-const GREEN = "\x1b[32m";
-const CYAN = "\x1b[36m";
-const HIDE_CURSOR = "\x1b[?25l";
-const SHOW_CURSOR = "\x1b[?25h";
-
 // Ensure cursor is restored if the process exits unexpectedly
 process.on("exit", () => {
   process.stdout.write(SHOW_CURSOR);
@@ -121,15 +157,33 @@ async function main() {
 
   try {
     const { default: updateNotifier } = await import("update-notifier");
-    const pkg = require("../package.json");
 
-    updateNotifier({
+    const notifier = updateNotifier({
       pkg,
-      updateCheckInterval: 1000 * 60 * 60 * 24,
-    }).notify({
-      defer: false,
-      isGlobal: true,
+      updateCheckInterval: 0,
     });
+
+    // Cache may be empty on first run — fetch directly as fallback
+    let updateInfo = notifier.update;
+    if (!updateInfo) {
+      try {
+        updateInfo = await notifier.fetchInfo();
+        if (updateInfo.type === "latest") {
+          updateInfo = null;
+        }
+      } catch {
+        // Network error — skip silently
+      }
+    }
+
+    if (updateInfo) {
+      console.log(
+        `  ${YELLOW}Update available!${RESET} ${DIM}${updateInfo.current}${RESET} → ${GREEN}${updateInfo.latest}${RESET}`,
+      );
+      console.log(
+        `  Run ${CYAN}npm install -g neuro-commit${RESET} to update\n`,
+      );
+    }
   } catch {
     // Ignore update check errors
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neuro-commit",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "neuro-commit CLI utility",
   "author": "cr1ma.dev",
   "bin": {

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("");
 }
 
 /**