wukong-gitlog-cli 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.3](https://github.com/tomatobybike/wukong-gitlog-cli/compare/v0.0.2...v0.0.3) (2025-11-26)
+
+
+### Features
+
+* 🎸 gerrit ([76f71b8](https://github.com/tomatobybike/wukong-gitlog-cli/commit/76f71b8ab7b1636bee4c243fd670383268e1f771))
+
+### [0.0.2](https://github.com/tomatobybike/wukong-gitlog-cli/compare/v0.0.1...v0.0.2) (2025-11-26)
+
 ### 0.0.1 (2025-11-26)
 
 

package/README.md

@@ -33,17 +33,15 @@ cd wukong-gitlog-cli
 npm install
 ```
 
-Run from the repo using Node:
-
-```bash
-node ./src/cli.mjs --help
-```
-
-(Optional) Install globally to run with a short command:
+Install globally to run with a short command (recommended for CLI consumers):
 
 ```bash
+# Install globally from the repo (for development):
 npm link
-# then you can run
+# Or install via npm when published:
+npm i -g wukong-gitlog-cli
+
+# Then you can run the CLI globally:
 wukong-gitlog-cli --help
 ```
 
@@ -52,7 +50,7 @@ wukong-gitlog-cli --help
 ## Usage
 
 ```bash
-node ./src/cli.mjs [options]
+wukong-gitlog-cli [options]
 ```
 
 Command-line options:
@@ -67,7 +65,9 @@ Command-line options:
 - `--format <type>`        Output format: `text` | `excel` | `json` (default: `text`)
 - `--group-by <type>`      Group commits by date: `day` | `month`
 - `--stats`                Include a `Stats` sheet in the Excel export
-- `--gerrit <prefix>`      Show Gerrit URL for each commit (supports templates `{{hash}}` and `{{changeId}}`; `{{changeId}}` falls back to `hash` when absent)
+- `--gerrit-api <url>`    Optional: Gerrit REST API base URL for resolving `{{changeNumber}}` (e.g. `https://gerrit.example.com/gerrit`)
+- `--gerrit-auth <token>` Optional: Authorization for Gerrit REST API (either `user:pass` for Basic or token string for Bearer)
+- `--gerrit <prefix>`      Show Gerrit URL for each commit (supports templates `{{hash}}`, `{{changeId}}` and `{{changeNumber}}`; `{{changeId}}` falls back to `hash` when absent; `{{changeNumber}}` requires `--gerrit-api` and falls back to `changeId` or `hash`)
 - `--out <file>`           Output file name (without path). Defaults: `commits.json` / `commits.txt` / `commits.xlsx`
 - `--out-dir <dir>`      Output directory path — supports relative or absolute path, e.g., `--out-dir ../output`
 - `--out-parent`         Place output in the parent directory's `output/` folder (same as `--out-dir ../output`)
@@ -83,7 +83,7 @@ Command-line options:
 Use the `--gerrit` option to include a Gerrit link for each commit. You can provide a template containing `{{hash}}` to place the full commit hash into the URL, for example:
 
 ```bash
-node ./src/cli.mjs --gerrit "https://gerrit.example.com/c/project/+/{{hash}}" --limit 5 --format text
+wukong-gitlog-cli --gerrit "https://gerrit.example.com/c/project/+/{{hash}}" --limit 5 --format text
 ```
 
 If `{{hash}}` is not present, the CLI will append the commit hash to the prefix with a `/` separator.
@@ -107,8 +107,9 @@ Note: `--out <file>` is the filename only and the directory used to store that f
 For example:
 
 ```bash
-node ./src/cli.mjs --out parent.json --out-parent
-node ./src/cli.mjs --out demo.txt --out-dir ../temp
+# using globally installed CLI
+wukong-gitlog-cli --out parent.json --out-parent
+wukong-gitlog-cli --out demo.txt --out-dir ../temp
 ```
 
 ---
@@ -118,25 +119,38 @@ node ./src/cli.mjs --out demo.txt --out-dir ../temp
 Export as text, grouped by month, with Gerrit links:
 
 ```bash
-node ./src/cli.mjs --format text --group-by month --gerrit "https://gerrit.example.com/c/project/+/{{hash}}"
+wukong-gitlog-cli --format text --group-by month --gerrit "https://gerrit.example.com/c/project/+/{{hash}}"
+```
+
+// Resolve numeric change ID using Gerrit API (if available)
+wukong-gitlog-cli --format text --group-by month --gerrit "https://gerrit.example.com/c/project/+/{{changeNumber}}" --gerrit-api <GERRIT_API_BASE_URL>
+
+If your Gerrit requires authentication (HTTP Basic or token), use `--gerrit-auth`:
+
+```bash
+# HTTP Basic: username:password
+wukong-gitlog-cli --format text --gerrit "https://gerrit.example.com/c/project/+/{{changeNumber}}" --gerrit-api <GERRIT_API_BASE_URL> --gerrit-auth "username:password"
+
+# Token (Bearer)
+wukong-gitlog-cli --format text --gerrit "https://gerrit.example.com/c/project/+/{{changeNumber}}" --gerrit-api <GERRIT_API_BASE_URL> --gerrit-auth "MYTOKEN"
 ```
 
 Export to Excel with stats and Gerrit URLs:
 
 ```bash
-node ./src/cli.mjs --format excel --stats --gerrit "https://gerrit.example.com/c/project/+/{{hash}}"
+wukong-gitlog-cli --format excel --stats --gerrit "https://gerrit.example.com/c/project/+/{{hash}}"
 ```
 
 Export raw JSON:
 
 ```bash
-node ./src/cli.mjs --json --out commits.json
+wukong-gitlog-cli --json --out commits.json
 ```
 
 Export text to a custom directory (parent output folder):
 
 ```bash
-node ./src/cli.mjs --out-dir ../output --format text --limit 5 --out custom1.txt
+wukong-gitlog-cli --out-dir ../output --format text --limit 5 --out custom1.txt
 ```
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wukong-gitlog-cli",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Advanced Git commit log exporter with Excel/JSON/TXT output, grouping, stats and CLI.",
   "keywords": [
     "git",

package/src/cli.mjs

@@ -22,6 +22,8 @@ program
   .option('--group-by <type>', '按日期分组: day | month')
   .option('--stats', '输出每日统计数据')
   .option('--gerrit <prefix>', '显示 Gerrit 地址，支持在 prefix 中使用 {{hash}} 占位符')
+  .option('--gerrit-api <url>', '可选：Gerrit REST API 基础地址，用于解析 changeNumber，例如 `https://gerrit.example.com`')
+  .option('--gerrit-auth <tokenOrUserPass>', '可选：Gerrit API 授权，格式为 `user:pass` 或 `TOKEN`（表示 Bearer token）')
   .option('--out <file>', '输出文件名（不含路径）')
   .option('--out-dir <dir>', '自定义输出目录，支持相对路径或绝对路径，例如 `--out-dir ../output`')
   .option('--out-parent', '将输出目录放到当前工程的父目录的 `output/`（等同于 `--out-dir ../output`）')
@@ -40,8 +42,78 @@ const opts = program.opts();
   // --- Gerrit 地址处理（若提供） ---
   if (opts.gerrit) {
     const prefix = opts.gerrit;
+    // support optional changeNumber resolution via Gerrit REST API
+    const { gerritApi, gerritAuth } = opts;
     // create new array to avoid mutating function parameters (eslint: no-param-reassign)
-    records = records.map(r => {
+    if (prefix.includes('{{changeNumber}}') && gerritApi) {
+      // async mapping to resolve changeNumber using Gerrit API
+      const cache = new Map();
+      const headers = {};
+      if (gerritAuth) {
+        if (gerritAuth.includes(':')) {
+          headers.Authorization = `Basic ${Buffer.from(gerritAuth).toString('base64')}`;
+        } else {
+          headers.Authorization = `Bearer ${gerritAuth}`;
+        }
+      }
+
+      const fetchGerritJson = async (url) => {
+        try {
+          const res = await fetch(url, { headers });
+          const txt = await res.text();
+          // Gerrit prepends )]}' to JSON responses — strip it
+          const jsonText = txt.replace(/^\)\]\}'\n/, '');
+          return JSON.parse(jsonText);
+        } catch (err) {
+          return null;
+        }
+      };
+
+      const resolveChangeNumber = async (r) => {
+        // try changeId first
+        if (r.changeId) {
+          if (cache.has(r.changeId)) return cache.get(r.changeId);
+          // try `changes/{changeId}/detail`
+          const url = `${gerritApi.replace(/\/$/, '')}/changes/${encodeURIComponent(r.changeId)}/detail`;
+          let j = await fetchGerritJson(url);
+          if (j && j._number) {
+            cache.set(r.changeId, j._number);
+            return j._number;
+          }
+          // fallback: query search
+          const url2 = `${gerritApi.replace(/\/$/, '')}/changes/?q=change:${encodeURIComponent(r.changeId)}`;
+          j = await fetchGerritJson(url2);
+          if (Array.isArray(j) && j.length > 0 && j[0]._number) {
+            cache.set(r.changeId, j[0]._number);
+            return j[0]._number;
+          }
+        }
+        // try commit hash
+        if (r.hash) {
+          if (cache.has(r.hash)) return cache.get(r.hash);
+          const url3 = `${gerritApi.replace(/\/$/, '')}/changes/?q=commit:${encodeURIComponent(r.hash)}`;
+          const j = await fetchGerritJson(url3);
+          if (Array.isArray(j) && j.length > 0 && j[0]._number) {
+            cache.set(r.hash, j[0]._number);
+            return j[0]._number;
+          }
+        }
+        return null;
+      };
+
+      records = await Promise.all(
+        records.map(async (r) => {
+          const changeNumber = await resolveChangeNumber(r);
+          const changeNumberOrFallback = changeNumber || r.changeId || r.hash;
+          const gerritUrl = prefix.replace('{{changeNumber}}', changeNumberOrFallback);
+          return { ...r, gerrit: gerritUrl };
+        })
+      );
+    } else if (prefix.includes('{{changeNumber}}') && !gerritApi) {
+        console.warn('prefix contains {{changeNumber}} but no --gerrit-api provided — falling back to changeId/hash');
+        records = records.map((r) => ({ ...r, gerrit: prefix.replace('{{changeNumber}}', r.changeId || r.hash) }));
+      } else {
+      records = records.map((r) => {
       let gerritUrl;
       if (prefix.includes('{{changeId}}')) {
         const changeId = r.changeId || r.hash;
@@ -54,7 +126,8 @@ const opts = program.opts();
       }
 
       return { ...r, gerrit: gerritUrl };
-    });
+      });
+      }
   }
 
   // --- 分组 ---