wukong-gitlog-cli 0.0.8 → 0.0.10

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 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.10](https://github.com/tomatobybike/wukong-gitlog-cli/compare/v0.0.9...v0.0.10) (2025-11-28)
+
+
+### Features
+
+* 🎸 each hour percent ([4f1a7e7](https://github.com/tomatobybike/wukong-gitlog-cli/commit/4f1a7e75a1c0d83c92aabf42e97932421c349b8d))
+* 🎸 hourline ([9035ecb](https://github.com/tomatobybike/wukong-gitlog-cli/commit/9035ecb33295fa5f4ff64bbd9b9281c543247683))
+
+### [0.0.9](https://github.com/tomatobybike/wukong-gitlog-cli/compare/v0.0.8...v0.0.9) (2025-11-28)
+
 ### [0.0.8](https://github.com/tomatobybike/wukong-gitlog-cli/compare/v0.0.7...v0.0.8) (2025-11-28)
 
 

package/README.md

@@ -92,20 +92,20 @@ Command-line options:
 You can generate per-month and per-week outputs under `output/month/` and `output/week/` using the `--per-period-formats` option. Example:
 
 ```bash
-node ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats csv,tab
+wukong-gitlog-cli ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats csv,tab
 ```
 
 Want per-period Excel outputs? Use `xlsx` along with `--per-period-excel-mode` for `sheets` or `files`:
 
 ```bash
-node ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats csv,tab,xlsx --per-period-excel-mode sheets
-node ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats xlsx --per-period-excel-mode files
+wukong-gitlog-cli ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats csv,tab,xlsx --per-period-excel-mode sheets
+wukong-gitlog-cli ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats xlsx --per-period-excel-mode files
 ```
 
 If you'd like only per-period outputs and not the combined monthly/weekly summary files, add `--per-period-only`:
 
 ```bash
-node ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats csv,tab,xlsx --per-period-only
+wukong-gitlog-cli ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats csv,tab,xlsx --per-period-only
 ```
 
 
@@ -188,132 +188,12 @@ wukong-gitlog-cli --out-dir ../output --format text --limit 5 --out custom1.txt
 
 ---
 
-## Quick demo (npm scripts)
 
-We provided a few convenient npm scripts to quickly run common scenarios. Run them from the project root:
-
-```bash
-# show help
-npm run cli:help
-
-# simple text export (commits.txt in ./output)
-npm run cli:text-demo
-
-# Excel export with stats (commits.xlsx + commits.txt in ./output)
-npm run cli:excel-demo
-
-# JSON export (commits.json in ./output)
-npm run cli:json-demo
-
-# Gerrit text export demo
-npm run cli:gerrit-demo
-# Gerrit Change-Id demo (use commit Change-Id to build Gerrit URLs when present)
-npm run cli:gerrit-changeid-demo
-```
-
-If you prefer to write output outside the project (e.g., a parent `output/` folder), we also provide `npm` scripts that run with `--out-parent`:
-
-```bash
-# text export to parent `output/`
-npm run cli:text-demo-parent
-
-# excel export to parent `output/`
-npm run cli:excel-demo-parent
-```
-
-Example text output (from `npm run cli:text-demo`):
-
-```text
-Hash       | Author             | Date                 | Message
----------------------------------------------------------------------------------------------------------------------
-c5bdf9d4   | tom                | 2025-11-25           | feat: 🎸 增加output目录
-
-ea82531   | tom                | 2025-11-25           | feat: 🎸 init
-
-741de50   | tom                | 2025-11-25           | first commit
-```
-
-You can also analyze overtime culture with the `--overtime` flag to get overall and per-person overtime submission rates (default work window is 09:00-18:00). Example:
 
 ```bash
 wukong-gitlog-cli --overtime --limit 500
 ```
 
-## Overtime demo scripts (npm)
-
-Below are helpful npm scripts added for quickly running the overtime analysis with commonly used configurations. They are already present in `package.json` and can be run from the project root.
-
-```bash
-# Run a US-focused overtime text report using 10:00-19:00 work hours and a 12:00-13:00 lunch break
-npm run cli:overtime-text-us
-
-# Run a US-focused overtime text report and write the outputs into the project parent's output folder
-npm run cli:overtime-text-us-parent
-
-# Run a US-focused overtime text report and write the output into ../output (explicit --out-dir)
-npm run cli:overtime-text-us-outdir
-
-# Run a CN-focused overtime Excel report (default 9:00-18:00 work hours and 12:00-14:00 lunch)
-npm run cli:overtime-excel-cn
-
-# Run a CN-focused overtime Excel report and write outputs to parent output folder
-npm run cli:overtime-excel-cn-parent
-
-# Run a CN-focused overtime Excel report and write outputs to ../output via --out-dir
-npm run cli:overtime-excel-cn-outdir
-# Per-period CSV/Tab export: write per-period files to output/month/ and output/week/
-npm run cli:overtime-per-period-csv-tab
-# Per-period Excel export with sheet-per-period workbook
-npm run cli:overtime-per-period-xlsx-sheets
-# Per-period Excel export with one file per period
-npm run cli:overtime-per-period-xlsx-files
-# Per-period only (no consolidated monthly/weekly files)
-npm run cli:overtime-per-period-only
-```
-
-Notes:
-
-- Output files are written into `output/` by default. Use `--out-dir` or `--out-parent` to change output location.
-- If you prefer different working hours or country codes, either modify the script in `package.json` or run the CLI manually with flags (e.g. `--work-start`, `--work-end`, `--lunch-start`, `--lunch-end`, `--country`).
-
-Formatting note:
-
-- The text report is formatted to align columns correctly even when commit messages or author names contain mixed Chinese and English characters (uses `string-width` for display-aware padding).
-
-Example JSON output (from `npm run cli:json-demo`):
-
-```json
-[
-  {
-    "hash": "c5bdf9d4f52f39bd7d580318bafc8ba4b6c129bc",
-    "author": "tom",
-    "email": "",
-    "date": "2025-11-25 17:24:32 +0800",
-    "message": "feat: 🎸 增加output目录"
-  }
-  /* truncated... */
-]
-```
-
-Example JSON output including `changeId`/`gerrit` when `--gerrit` uses `{{changeId}}` (if present in commit):
-
-```json
-[
-  {
-    "hash": "Iabc...",
-    "author": "tom",
-    "email": "",
-    "date": "2025-11-25 17:24:32 +0800",
-    "message": "feat: add feature",
-    "body": "feat: add feature\n\nChange-Id: Iabcd123456789",
-    "changeId": "Iabcd123456789",
-    "gerrit": "https://gerrit.example.com/c/project/+/Iabcd123456789"
-  }
-]
-```
-
----
-
 ## Notes & Developer Info
 
 - The CLI prints helpful messages after exporting files and writes outputs to the `output/` folder in the repo root.

package/doc/help.md

@@ -0,0 +1,194 @@
+### Per-period outputs
+
+You can generate per-month and per-week outputs under `output/month/` and `output/week/` using the `--per-period-formats` option. Example:
+
+```bash
+node ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats csv,tab
+```
+
+Want per-period Excel outputs? Use `xlsx` along with `--per-period-excel-mode` for `sheets` or `files`:
+
+```bash
+node ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats csv,tab,xlsx --per-period-excel-mode sheets
+node ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats xlsx --per-period-excel-mode files
+```
+
+If you'd like only per-period outputs and not the combined monthly/weekly summary files, add `--per-period-only`:
+
+```bash
+node ./src/cli.mjs --overtime --limit 200 --format text --out commits.txt --per-period-formats csv,tab,xlsx --per-period-only
+```
+
+---
+
+## Gerrit support
+
+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
+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.
+
+You can also use `{{changeId}}` in the template to reference Gerrit change id. The tool will try to extract a `Change-Id: I...` value from the commit body and replace `{{changeId}}` with it. If it can't find a `Change-Id`, the CLI will fall back to using the commit `hash`.
+
+The Gerrit link will show up in:
+
+- The text output if `--format text` (as a new `Gerrit` column)
+- The Excel export as a `Gerrit` column if `--format excel`
+- JSON output will include a `gerrit` field for each record when `--gerrit` is used
+- JSON output will include a `gerrit` field for each record when `--gerrit` is used
+- When `--gerrit` uses `{{changeId}}`, the CLI will try to extract `Change-Id:` from the commit body and include `changeId` and `body` in the JSON record. If no `Change-Id` is present, the CLI falls back to `hash` when forming the Gerrit URL.
+
+Note: `--out <file>` is the filename only and the directory used to store that file depends on:
+
+- The default directory `./output/` in the current working directory
+- `--out-dir <dir>` to override the target folder (relative or absolute)
+- `--out-parent` to write to the parent repository folder `../output/` (same as `--out-dir ../output`)
+
+For example:
+
+```bash
+# using globally installed CLI
+wukong-gitlog-cli --out parent.json --out-parent
+wukong-gitlog-cli --out demo.txt --out-dir ../temp
+```
+
+---
+
+## Examples
+
+Export as text, grouped by month, with Gerrit links:
+
+```bash
+wukong-gitlog-cli --format text --group-by month --gerrit "https://gerrit.example.com/c/project/+/{{hash}}"
+```
+
+---
+
+## Quick demo (npm scripts)
+
+We provided a few convenient npm scripts to quickly run common scenarios. Run them from the project root:
+
+```bash
+# show help
+npm run cli:help
+
+# simple text export (commits.txt in ./output)
+npm run cli:text-demo
+
+# Excel export with stats (commits.xlsx + commits.txt in ./output)
+npm run cli:excel-demo
+
+# JSON export (commits.json in ./output)
+npm run cli:json-demo
+
+# Gerrit text export demo
+npm run cli:gerrit-demo
+# Gerrit Change-Id demo (use commit Change-Id to build Gerrit URLs when present)
+npm run cli:gerrit-changeid-demo
+```
+
+If you prefer to write output outside the project (e.g., a parent `output/` folder), we also provide `npm` scripts that run with `--out-parent`:
+
+```bash
+# text export to parent `output/`
+npm run cli:text-demo-parent
+
+# excel export to parent `output/`
+npm run cli:excel-demo-parent
+```
+
+Example text output (from `npm run cli:text-demo`):
+
+```text
+Hash       | Author             | Date                 | Message
+---------------------------------------------------------------------------------------------------------------------
+c5bdf9d4   | tom                | 2025-11-25           | feat: 🎸 增加output目录
+
+ea82531   | tom                | 2025-11-25           | feat: 🎸 init
+
+741de50   | tom                | 2025-11-25           | first commit
+```
+
+You can also analyze overtime culture with the `--overtime` flag to get overall and per-person overtime submission rates (default work window is 09:00-18:00). Example:
+
+```bash
+wukong-gitlog-cli --overtime --limit 500
+```
+
+## Overtime demo scripts (npm)
+
+Below are helpful npm scripts added for quickly running the overtime analysis with commonly used configurations. They are already present in `package.json` and can be run from the project root.
+
+```bash
+# Run a US-focused overtime text report using 10:00-19:00 work hours and a 12:00-13:00 lunch break
+npm run cli:overtime-text-us
+
+# Run a US-focused overtime text report and write the outputs into the project parent's output folder
+npm run cli:overtime-text-us-parent
+
+# Run a US-focused overtime text report and write the output into ../output (explicit --out-dir)
+npm run cli:overtime-text-us-outdir
+
+# Run a CN-focused overtime Excel report (default 9:00-18:00 work hours and 12:00-14:00 lunch)
+npm run cli:overtime-excel-cn
+
+# Run a CN-focused overtime Excel report and write outputs to parent output folder
+npm run cli:overtime-excel-cn-parent
+
+# Run a CN-focused overtime Excel report and write outputs to ../output via --out-dir
+npm run cli:overtime-excel-cn-outdir
+# Per-period CSV/Tab export: write per-period files to output/month/ and output/week/
+npm run cli:overtime-per-period-csv-tab
+# Per-period Excel export with sheet-per-period workbook
+npm run cli:overtime-per-period-xlsx-sheets
+# Per-period Excel export with one file per period
+npm run cli:overtime-per-period-xlsx-files
+# Per-period only (no consolidated monthly/weekly files)
+npm run cli:overtime-per-period-only
+```
+
+Notes:
+
+- Output files are written into `output/` by default. Use `--out-dir` or `--out-parent` to change output location.
+- If you prefer different working hours or country codes, either modify the script in `package.json` or run the CLI manually with flags (e.g. `--work-start`, `--work-end`, `--lunch-start`, `--lunch-end`, `--country`).
+
+Formatting note:
+
+- The text report is formatted to align columns correctly even when commit messages or author names contain mixed Chinese and English characters (uses `string-width` for display-aware padding).
+
+Example JSON output (from `npm run cli:json-demo`):
+
+```json
+[
+  {
+    "hash": "c5bdf9d4f52f39bd7d580318bafc8ba4b6c129bc",
+    "author": "tom",
+    "email": "",
+    "date": "2025-11-25 17:24:32 +0800",
+    "message": "feat: 🎸 增加output目录"
+  }
+  /* truncated... */
+]
+```
+
+Example JSON output including `changeId`/`gerrit` when `--gerrit` uses `{{changeId}}` (if present in commit):
+
+```json
+[
+  {
+    "hash": "Iabc...",
+    "author": "tom",
+    "email": "",
+    "date": "2025-11-25 17:24:32 +0800",
+    "message": "feat: add feature",
+    "body": "feat: add feature\n\nChange-Id: Iabcd123456789",
+    "changeId": "Iabcd123456789",
+    "gerrit": "https://gerrit.example.com/c/project/+/Iabcd123456789"
+  }
+]
+```
+
+---

package/package.json

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

package/src/overtime.mjs

@@ -64,6 +64,8 @@ export function analyzeOvertime(records, opts = {}) {
     hd.init('CN');
   }
 
+  // 新增：每小时分布统计
+  const hourlyCommits = Array(24).fill(0);
   records.forEach((r) => {
     const dt = parseCommitDate(r.date);
     if (!dt || !dt.isValid()) return; // skip
@@ -72,6 +74,12 @@ export function analyzeOvertime(records, opts = {}) {
     const isHoliday = !!hd.isHoliday(dt.toDate());
     const isNonWork = isWeekend(dt) || isHoliday;
 
+    // 每小时分布
+    const hour = dt.hour();
+    if (hour >= 0 && hour < 24) {
+      hourlyCommits[hour]++;
+    }
+
     if (outside) {
       outsideWorkCount++;
       // 记录最新的加班提交
@@ -134,6 +142,8 @@ export function analyzeOvertime(records, opts = {}) {
   // sort perAuthor by outsideWorkRate desc
   perAuthor.sort((a, b) => b.outsideWorkRate - a.outsideWorkRate || b.total - a.total);
 
+  // 新增：每小时分布百分比
+  const hourlyPercent = hourlyCommits.map(v => total ? +(v / total).toFixed(3) : 0);
   return {
     total,
     outsideWorkCount,
@@ -148,16 +158,18 @@ export function analyzeOvertime(records, opts = {}) {
     latestOutsideCommit: latestOutsideCommit || null,
     startHour,
     endHour,
-      lunchStart,
-      lunchEnd,
-      country,
-      holidayCount,
-      holidayRate: total ? +(holidayCount / total).toFixed(3) : 0,
+    lunchStart,
+    lunchEnd,
+    country,
+    holidayCount,
+    holidayRate: total ? +(holidayCount / total).toFixed(3) : 0,
+    hourlyCommits,
+    hourlyPercent,
   };
 }
 
 export function renderOvertimeText(stats) {
-  const { total, outsideWorkCount, nonWorkdayCount, holidayCount, outsideWorkRate, nonWorkdayRate, holidayRate, perAuthor, startHour, endHour, lunchStart, lunchEnd, country } = stats;
+  const { total, outsideWorkCount, nonWorkdayCount, holidayCount, outsideWorkRate, nonWorkdayRate, holidayRate, perAuthor, startHour, endHour, lunchStart, lunchEnd, country, hourlyCommits = [], hourlyPercent = [] } = stats;
   const { startCommit, endCommit, latestCommit, latestOutsideCommit } = stats;
   const lines = [];
 
@@ -206,6 +218,18 @@ export function renderOvertimeText(stats) {
   lines.push(`下班时间（工作时间外）提交数：${outsideWorkCount}，占比：${(outsideWorkRate * 100).toFixed(1)}%`);
   lines.push(`非工作日（周末）提交数：${nonWorkdayCount}，占比：${(nonWorkdayRate * 100).toFixed(1)}%`);
   lines.push('');
+  lines.push('每小时分布（提交数/占比）：');
+  const hourLine = '  Hour | Count | Percent';
+  lines.push(hourLine);
+  lines.push('  -----|-------|--------');
+  for (let h = 0; h < 24; h++) {
+    const cnt = hourlyCommits[h] || 0;
+    if (cnt > 0) {
+      const pct = hourlyPercent[h] ? (hourlyPercent[h] * 100).toFixed(1) : '0.0';
+      lines.push(`  ${String(h).padStart(2, '0')}   | ${String(cnt).padStart(5, ' ')} | ${pct.padStart(6, ' ')}%`);
+    }
+  }
+  lines.push('');
   lines.push('按人员统计：');
   // header
   const header = `  ${padDisplayEnd('Name', cols.name)} | ${padDisplayStart('总数', cols.total)} | ${padDisplayStart('下班外数', cols.outside)} | ${padDisplayStart('下班外占比', cols.outsideRate)} | ${padDisplayStart('非工作日数', cols.nonWork)} | ${padDisplayStart('非工作日占比', cols.nonWorkRate)} | ${padDisplayStart('假日数', cols.holiday)} | ${padDisplayStart('假日占比', cols.holidayRate)}`;
@@ -224,7 +248,7 @@ export function renderOvertimeText(stats) {
 }
 
 export function renderOvertimeTab(stats) {
-  const { total, outsideWorkCount, nonWorkdayCount, holidayCount, outsideWorkRate, nonWorkdayRate, holidayRate, perAuthor, startHour, endHour, lunchStart, lunchEnd, country } = stats;
+  const { total, outsideWorkCount, nonWorkdayCount, holidayCount, outsideWorkRate, nonWorkdayRate, holidayRate, perAuthor, startHour, endHour, lunchStart, lunchEnd, country, hourlyCommits = [], hourlyPercent = [] } = stats;
   const { startCommit, endCommit, latestCommit, latestOutsideCommit } = stats;
   const rows = [];
   rows.push(`总提交数:\t${total}`);
@@ -236,6 +260,16 @@ export function renderOvertimeTab(stats) {
   rows.push(`下班时间（工作时间外）提交数:\t${outsideWorkCount}\t占比:\t${(outsideWorkRate * 100).toFixed(1)}%`);
   rows.push(`非工作日（周末）提交数:\t${nonWorkdayCount}\t占比:\t${(nonWorkdayRate * 100).toFixed(1)}%`);
   rows.push('');
+  rows.push('每小时分布（提交数/占比）：');
+  rows.push(['Hour', 'Count', 'Percent'].join('\t'));
+  for (let h = 0; h < 24; h++) {
+    const cnt = hourlyCommits[h] || 0;
+    if (cnt > 0) {
+      const pct = hourlyPercent[h] ? (hourlyPercent[h] * 100).toFixed(1) : '0.0';
+      rows.push([String(h).padStart(2, '0'), cnt, `${pct}%`].join('\t'));
+    }
+  }
+  rows.push('');
   rows.push(['Name', '总数', '下班外数', '下班外占比', '非工作日数', '非工作日占比', '假日数', '假日占比'].join('\t'));
   perAuthor.forEach((p) => {
     rows.push([p.name || '-', p.total, p.outsideWorkCount, `${(p.outsideWorkRate * 100).toFixed(1)}%`, p.nonWorkdayCount, `${(p.nonWorkdayRate * 100).toFixed(1)}%`, p.holidayCount || 0, `${((p.holidayCount || 0) / p.total * 100).toFixed(1)}%`].join('\t'));
@@ -252,12 +286,22 @@ function escapeCsv(v) {
 }
 
 export function renderOvertimeCsv(stats) {
-  const { perAuthor, latestOutsideCommit, country } = stats;
+  const { perAuthor, latestOutsideCommit, country, hourlyCommits = [], hourlyPercent = [], total = 0 } = stats;
   const rows = [];
   if (latestOutsideCommit) {
     rows.push(`# 加班最晚的一次提交,Hash,Author,Date,Message`);
     rows.push(`# ,${escapeCsv(latestOutsideCommit.hash)},${escapeCsv(latestOutsideCommit.author)},${escapeCsv(formatDateForCountry(latestOutsideCommit.date, country))},${escapeCsv(latestOutsideCommit.message)}`);
   }
+  rows.push('');
+  rows.push('Hour,Count,Percent');
+  for (let h = 0; h < 24; h++) {
+    const cnt = hourlyCommits[h] || 0;
+    if (cnt > 0) {
+      const pct = hourlyPercent[h] ? (hourlyPercent[h] * 100).toFixed(1) : '0.0';
+      rows.push(`${h.toString().padStart(2, '0')},${cnt},${pct}%`);
+    }
+  }
+  rows.push('');
   rows.push('Name,Total,OutsideCount,OutsideRate,NonWorkdayCount,NonWorkdayRate,HolidayCount,HolidayRate');
   perAuthor.forEach((p) => {
     rows.push(`${escapeCsv(p.name)},${p.total},${p.outsideWorkCount},${(p.outsideWorkRate * 100).toFixed(1)}%,${p.nonWorkdayCount},${(p.nonWorkdayRate * 100).toFixed(1)}%,${p.holidayCount || 0},${((p.holidayCount || 0) / p.total * 100).toFixed(1)}%`);