kodevu 0.1.52 → 0.1.54

package/README.md

@@ -32,6 +32,7 @@ npx kodevu [target] [options]
 - `--reviewer, -r`: `codex`, `gemini`, `copilot`, `openai`, or `auto` (default: `auto`).
 - `--rev, -v`: A specific revision or commit hash to review.
 - `--last, -n`: Number of latest revisions to review (default: 1). Use negative values (e.g., `-3`) to review only the 3rd commit from the top.
+- `--uncommitted, -u`: Review current uncommitted changes in the target working tree.
 - `--lang, -l`: Output language (e.g., `zh`, `en`, `auto`).
 - `--prompt, -p`: Additional instructions for the reviewer. Use `@file.txt` to read from a file.
 - `--output, -o`: Report output directory (default: `~/.kodevu`).
@@ -47,6 +48,9 @@ npx kodevu [target] [options]
 > [!IMPORTANT]
 > `--rev` and `--last` are mutually exclusive. Specifying both will result in an error.
 
+> [!IMPORTANT]
+> `--uncommitted` is mutually exclusive with `--rev` and `--last`.
+
 ### Environment Variables
 
 You can set these in your shell to change default behavior without typing flags every time:
@@ -81,6 +85,11 @@ Review a **specific commit** hash:
 npx kodevu . --rev abc1234
 ```
 
+Review **current uncommitted changes** (Git/SVN working copy):
+```bash
+npx kodevu . --uncommitted
+```
+
 ### Options & Formatting
 
 Review using **custom instructions** from a file:

package/SKILL.md

@@ -0,0 +1,63 @@
+---
+name: kodevu
+description: A tool to fetch Git commits or SVN revisions, send the diff to a supported AI reviewer CLI, and write configurable review reports.
+---
+
+# Kodevu Skill
+
+Kodevu is a Node.js tool that fetches Git commits or SVN revisions, sends the diff to a supported AI reviewer CLI, and writes review results to report files.
+
+## Usage
+
+Use `npx kodevu` to review a codebase. It is designed to be stateless and requires no configuration files.
+
+### Reviewing the latest commit
+
+```bash
+npx kodevu .
+```
+
+### Reviewing a specific commit
+
+```bash
+npx kodevu . --rev <commit-hash>
+```
+
+### Reviewing the last N commits
+
+```bash
+npx kodevu . --last 3
+```
+
+### Supported Reviewers
+
+`kodevu` supports several AI reviewer CLIs: `auto`, `openai`, `gemini`, `codex`, `copilot`. The default is `auto`. Use the `--reviewer` option to override.
+
+Example using OpenAI:
+```bash
+npx kodevu . --reviewer openai --openai-api-key <YOUR_API_KEY> --openai-model gpt-4o
+```
+
+### Generating JSON Reports
+
+By default, review reports are generated as Markdown files in `~/.kodevu/`. You can specify `--format json` or change the output directory using `--output <dir>`.
+```bash
+npx kodevu . --format json --output ./reports
+```
+
+### Formatting the Prompt
+
+You can provide clear instructions to the reviewer using `--prompt`:
+```bash
+npx kodevu . --prompt "Focus on security issues and suggest optimizations."
+```
+Or from a file: `--prompt @my-rules.txt`
+
+## Working with Target Repositories
+
+- `target`: Repository path (Git) or SVN URL/Working copy (default: `.`).
+
+For example, to run on a specific path, you can use:
+```bash
+npx kodevu /path/to/project --last 1
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kodevu",
-  "version": "0.1.52",
+  "version": "0.1.54",
   "license": "MIT",
   "type": "module",
   "description": "Poll SVN revisions or Git commits, send each change diff to a reviewer CLI, and write configurable review reports.",
@@ -9,7 +9,8 @@
   },
   "files": [
     "src",
-    "README.md"
+    "README.md",
+    "SKILL.md"
   ],
   "scripts": {
     "start": "node src/index.js",

package/src/config.js

@@ -23,6 +23,7 @@ const defaultConfig = {
   outputFormats: ["markdown"],
   rev: "",
   last: 0,
+  uncommitted: false,
   openaiApiKey: "",
   openaiBaseUrl: "https://api.openai.com/v1",
   openaiModel: "gpt-5-mini",
@@ -124,6 +125,7 @@ export function parseCliArgs(argv) {
     prompt: "",
     rev: "",
     last: "",
+    uncommitted: false,
     outputDir: "",
     outputFormats: "",
     openaiApiKey: "",
@@ -190,6 +192,11 @@ export function parseCliArgs(argv) {
       continue;
     }
 
+    if (value === "--uncommitted" || value === "-u") {
+      args.uncommitted = true;
+      continue;
+    }
+
     if (value === "--output" || value === "-o") {
       if (!hasNextValue) throw new Error(`Missing value for ${value}`);
       args.outputDir = nextValue;
@@ -268,6 +275,7 @@ export async function resolveConfig(cliArgs = {}) {
     "lang",
     "rev",
     "last",
+    "uncommitted",
     "outputDir",
     "outputFormats",
     "openaiApiKey",
@@ -285,6 +293,10 @@ export async function resolveConfig(cliArgs = {}) {
     throw new Error("Parameters --rev and --last are mutually exclusive. Please specify only one.");
   }
 
+  if (cliArgs.uncommitted && (cliArgs.rev || cliArgs.last)) {
+    throw new Error("Parameter --uncommitted is mutually exclusive with --rev and --last.");
+  }
+
   if (!config.target) {
     config.target = process.cwd();
   }
@@ -321,6 +333,7 @@ export async function resolveConfig(cliArgs = {}) {
   config.maxRevisionsPerRun = Number(config.maxRevisionsPerRun);
   config.commandTimeoutMs = Number(config.commandTimeoutMs);
   config.last = Number(config.last);
+  config.uncommitted = Boolean(config.uncommitted);
   config.outputFormats = normalizeOutputFormats(config.outputFormats);
   config.openaiApiKey = String(config.openaiApiKey || "").trim();
   config.openaiBaseUrl = String(config.openaiBaseUrl || defaultConfig.openaiBaseUrl).trim().replace(/\/+$/, "");
@@ -328,7 +341,7 @@ export async function resolveConfig(cliArgs = {}) {
   config.openaiOrganization = String(config.openaiOrganization || "").trim();
   config.openaiProject = String(config.openaiProject || "").trim();
 
-  if (!config.rev && (isNaN(config.last) || config.last === 0)) {
+  if (!config.uncommitted && !config.rev && (isNaN(config.last) || config.last === 0)) {
     config.last = 1;
   }
 
@@ -352,6 +365,7 @@ Options:
   --lang, -l        Output language (e.g. zh, en, auto)
   --rev, -v         Review specific revision(s), hashes, branches or ranges (comma-separated)
   --last, -n        Review the latest N revisions; use negative (-N) to review only the Nth-from-last revision (default: 1)
+  --uncommitted, -u    Review current uncommitted changes (mutually exclusive with --rev and --last)
   --output, -o      Output directory (default: ~/.kodevu)
   --format, -f      Output formats (markdown, json, comma-separated)
   --openai-api-key  API key used when reviewer=openai

package/src/git-client.js

@@ -181,6 +181,49 @@ function parseNameStatus(stdout) {
   return changedPaths;
 }
 
+function parseNameStatusLines(stdout) {
+  return stdout
+    .split(/\r?\n/)
+    .map((line) => line.trim())
+    .filter(Boolean)
+    .map((line) => line.split("\t"))
+    .map((parts) => {
+      const status = (parts[0] || "M").trim();
+      const action = status[0] || "M";
+
+      if ((action === "R" || action === "C") && parts.length >= 3) {
+        return {
+          action,
+          relativePath: parts[2],
+          previousPath: parts[1] || null
+        };
+      }
+
+      return {
+        action,
+        relativePath: parts[1] || "",
+        previousPath: null
+      };
+    })
+    .filter((item) => item.relativePath);
+}
+
+function mergeChangedPaths(...groups) {
+  const merged = [];
+  const seen = new Set();
+
+  for (const group of groups) {
+    for (const item of group) {
+      const key = `${item.action}|${item.relativePath}|${item.previousPath || ""}`;
+      if (seen.has(key)) continue;
+      seen.add(key);
+      merged.push(item);
+    }
+  }
+
+  return merged;
+}
+
 export async function getCommitDetails(config, targetInfo, commitHash) {
   const metaResult = await runGit(
     config,
@@ -214,3 +257,63 @@ export async function getCommitDetails(config, targetInfo, commitHash) {
     changedPaths: parseNameStatus(changedFilesResult.stdout)
   };
 }
+
+export async function getUncommittedDiff(config, targetInfo) {
+  const unstaged = await runGit(
+    config,
+    [
+      "diff",
+      "--find-renames",
+      "--find-copies",
+      "--no-ext-diff",
+      ...buildPathArgs(targetInfo)
+    ],
+    { cwd: targetInfo.repoRootPath, trim: false }
+  );
+  const staged = await runGit(
+    config,
+    [
+      "diff",
+      "--cached",
+      "--find-renames",
+      "--find-copies",
+      "--no-ext-diff",
+      ...buildPathArgs(targetInfo)
+    ],
+    { cwd: targetInfo.repoRootPath, trim: false }
+  );
+
+  const sections = [];
+  if (unstaged.stdout.trim()) {
+    sections.push("# Unstaged changes", unstaged.stdout.trimEnd());
+  }
+  if (staged.stdout.trim()) {
+    sections.push("# Staged changes", staged.stdout.trimEnd());
+  }
+
+  return sections.join("\n\n");
+}
+
+export async function getUncommittedDetails(config, targetInfo) {
+  const unstagedFiles = await runGit(
+    config,
+    ["diff", "--name-status", "-M", "-C", ...buildPathArgs(targetInfo)],
+    { cwd: targetInfo.repoRootPath, trim: false }
+  );
+  const stagedFiles = await runGit(
+    config,
+    ["diff", "--cached", "--name-status", "-M", "-C", ...buildPathArgs(targetInfo)],
+    { cwd: targetInfo.repoRootPath, trim: false }
+  );
+
+  const unstagedChanged = parseNameStatusLines(unstagedFiles.stdout);
+  const stagedChanged = parseNameStatusLines(stagedFiles.stdout);
+
+  return {
+    commitHash: "UNCOMMITTED",
+    author: "working-tree",
+    date: new Date().toISOString(),
+    message: "Uncommitted changes (staged + unstaged).",
+    changedPaths: mergeChangedPaths(unstagedChanged, stagedChanged)
+  };
+}

package/src/review-runner.js

@@ -155,7 +155,9 @@ export async function runReviewCycle(config) {
 
   let changeIdsToReview = [];
 
-  if (config.rev) {
+  if (config.uncommitted) {
+    changeIdsToReview = ["UNCOMMITTED"];
+  } else if (config.rev) {
     changeIdsToReview = await backend.resolveChangeIds(config, targetInfo, config.rev);
   } else if (config.last < 0) {
     const candidates = await backend.getLatestChangeIds(config, targetInfo, Math.abs(config.last));
@@ -169,7 +171,12 @@ export async function runReviewCycle(config) {
     return;
   }
 
-  logger.info(`Reviewing ${backend.displayName} ${backend.changeName}s ${formatChangeList(backend, changeIdsToReview)}`);
+  const isUncommittedBatch =
+    changeIdsToReview.length === 1 && changeIdsToReview[0] === "UNCOMMITTED";
+  const batchSummary = isUncommittedBatch
+    ? `Reviewing ${backend.displayName} uncommitted changes`
+    : `Reviewing ${backend.displayName} ${backend.changeName}s ${formatChangeList(backend, changeIdsToReview)}`;
+  logger.info(batchSummary);
   const progress = createProgressReporter(`${backend.displayName} ${backend.changeName} batch`);
   progress.update(0, `0/${changeIdsToReview.length} completed`);
 

package/src/svn-client.js

@@ -128,6 +128,24 @@ function toRelativePath(targetRepoPath, repoPath) {
   return repoPath.slice(targetRepoPath.length).replace(/^\/+/, "");
 }
 
+function parseSvnStatus(statusText) {
+  return statusText
+    .split(/\r?\n/)
+    .map((line) => line.replace(/\r$/, ""))
+    .filter(Boolean)
+    .map((line) => {
+      const action = (line[0] || " ").trim();
+      const relativePath = line.length > 8 ? line.slice(8).trim() : "";
+      return {
+        action,
+        relativePath,
+        previousPath: null
+      };
+    })
+    .filter((item) => item.relativePath)
+    .filter((item) => ["A", "D", "M", "R"].includes(item.action));
+}
+
 export async function getRevisionDetails(config, targetInfo, revision) {
   const result = await runCommand(
     SVN_COMMAND,
@@ -165,3 +183,37 @@ export async function getRevisionDetails(config, targetInfo, revision) {
     changedPaths
   };
 }
+
+export async function getUncommittedDiff(config, targetInfo) {
+  if (!targetInfo.workingCopyPath) {
+    throw new Error("SVN --uncommitted requires a working copy path target.");
+  }
+
+  const result = await runCommand(
+    SVN_COMMAND,
+    ["diff", "--git", "--internal-diff", "--ignore-properties", config.target],
+    { encoding: COMMAND_ENCODING, trim: false, debug: config.debug }
+  );
+
+  return result.stdout;
+}
+
+export async function getUncommittedDetails(config, targetInfo) {
+  if (!targetInfo.workingCopyPath) {
+    throw new Error("SVN --uncommitted requires a working copy path target.");
+  }
+
+  const statusResult = await runCommand(
+    SVN_COMMAND,
+    ["status", config.target],
+    { encoding: COMMAND_ENCODING, trim: false, debug: config.debug }
+  );
+
+  return {
+    revision: "UNCOMMITTED",
+    author: "working-copy",
+    date: new Date().toISOString(),
+    message: "Uncommitted changes in working copy.",
+    changedPaths: parseSvnStatus(statusResult.stdout)
+  };
+}

package/src/vcs-client.js

@@ -13,9 +13,13 @@ function createSvnBackend() {
     displayName: "SVN",
     changeName: "revision",
     formatChangeId(revision) {
+      if (revision === "UNCOMMITTED") return "uncommitted";
       return `r${revision}`;
     },
     getReportFileName(revision) {
+      if (revision === "UNCOMMITTED") {
+        return `${getTimestampPrefix()}-svn-uncommitted.md`;
+      }
       return `${getTimestampPrefix()}-svn-r${revision}.md`;
     },
 
@@ -33,9 +37,25 @@ function createSvnBackend() {
       return await svnClient.getLatestRevisionIds(config, targetInfo, limit);
     },
     async getChangeDiff(config, targetInfo, revision) {
+      if (revision === "UNCOMMITTED") {
+        return await svnClient.getUncommittedDiff(config, targetInfo);
+      }
       return await svnClient.getRevisionDiff(config, revision);
     },
     async getChangeDetails(config, targetInfo, revision) {
+      if (revision === "UNCOMMITTED") {
+        const details = await svnClient.getUncommittedDetails(config, targetInfo);
+
+        return {
+          id: "UNCOMMITTED",
+          displayId: "uncommitted",
+          author: details.author,
+          date: details.date,
+          message: details.message,
+          changedPaths: details.changedPaths
+        };
+      }
+
       const details = await svnClient.getRevisionDetails(config, targetInfo, revision);
 
       return {
@@ -56,9 +76,13 @@ function createGitBackend() {
     displayName: "Git",
     changeName: "commit",
     formatChangeId(commitHash) {
+      if (commitHash === "UNCOMMITTED") return "uncommitted";
       return commitHash.slice(0, 12);
     },
     getReportFileName(commitHash) {
+      if (commitHash === "UNCOMMITTED") {
+        return `${getTimestampPrefix()}-git-uncommitted.md`;
+      }
       return `${getTimestampPrefix()}-git-${commitHash.slice(0, 12)}.md`;
     },
 
@@ -82,9 +106,25 @@ function createGitBackend() {
       return await gitClient.getLatestCommitIds(config, targetInfo, limit);
     },
     async getChangeDiff(config, targetInfo, commitHash) {
+      if (commitHash === "UNCOMMITTED") {
+        return await gitClient.getUncommittedDiff(config, targetInfo);
+      }
       return await gitClient.getCommitDiff(config, targetInfo, commitHash);
     },
     async getChangeDetails(config, targetInfo, commitHash) {
+      if (commitHash === "UNCOMMITTED") {
+        const details = await gitClient.getUncommittedDetails(config, targetInfo);
+
+        return {
+          id: "UNCOMMITTED",
+          displayId: "uncommitted",
+          author: details.author,
+          date: details.date,
+          message: details.message,
+          changedPaths: details.changedPaths
+        };
+      }
+
       const details = await gitClient.getCommitDetails(config, targetInfo, commitHash);
 
       return {