wukong-gitlog-cli 0.0.5 → 0.0.6

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.6](https://github.com/tomatobybike/wukong-gitlog-cli/compare/v0.0.5...v0.0.6) (2025-11-27)
+
+
+### Features
+
+* 🎸 统计非工作时间提交量 ([7b8b0e7](https://github.com/tomatobybike/wukong-gitlog-cli/commit/7b8b0e7f2f85f2cd9e597d9bfd48cb4445937a09))
+* 🎸 lock package.json ([ae94dc7](https://github.com/tomatobybike/wukong-gitlog-cli/commit/ae94dc7c4445347ef0f06141176c9cb7f429ecf0))
+* 🎸 Statistical overtime culture ([c6841bb](https://github.com/tomatobybike/wukong-gitlog-cli/commit/c6841bbff1656e72a5a0129c1cc08f1ee457c768))
+* 🎸 Statistical overtime culture 统计加班文化 ([65ac7ca](https://github.com/tomatobybike/wukong-gitlog-cli/commit/65ac7ca3772ad018dc57623796859ad1f87df861))
+
 ### [0.0.5](https://github.com/tomatobybike/wukong-gitlog-cli/compare/v0.0.4...v0.0.5) (2025-11-27)
 
 ### [0.0.4](https://github.com/tomatobybike/wukong-gitlog-cli/compare/v0.0.3...v0.0.4) (2025-11-27)

package/README.md

@@ -76,6 +76,12 @@ Command-line options:
 - `--json`                 Output JSON
 - `--format <type>`        Output format: `text` | `excel` | `json` (default: `text`)
 - `--group-by <type>`      Group commits by date: `day` | `month`
+- `--overtime`              Analyze overtime culture: output counts/percentages for commits outside work hours and on non-workdays (per-person breakdown)
+  - `--country <code>`       Country/region for holidays (CN|US). Default: `CN`.
+  - `--work-start <hour>`    Workday start hour. Default: `9`.
+  - `--work-end <hour>`      Workday end hour. Default: `18`.
+  - `--lunch-start <hour>`   Lunch break start hour. Default: `12`.
+  - `--lunch-end <hour>`     Lunch break end hour. Default: `14`.
 - `--stats`                Include a `Stats` sheet in the Excel export
 - `--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)
@@ -212,6 +218,45 @@ 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
+```
+
+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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wukong-gitlog-cli",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Advanced Git commit log exporter with Excel/JSON/TXT output, grouping, stats and CLI.",
   "keywords": [
     "git",
@@ -45,6 +45,15 @@
     "cli:json-demo": "node ./src/cli.mjs --json --limit 5 --out commits.json",
     "cli:text-demo": "node ./src/cli.mjs --format text --limit 5 --out commits.txt",
     "cli:text-demo-parent": "node ./src/cli.mjs --out-parent --format text --limit 5 --out commits-parent.txt",
+    "cli:overtime-demo": "node ./src/cli.mjs --overtime --format text --limit 200",
+    "cli:overtime-text": "node ./src/cli.mjs --overtime --limit 100 --format text --out commits.txt",
+    "cli:overtime-excel": "node ./src/cli.mjs --overtime --limit 50 --format excel --out commits.xlsx",
+    "cli:overtime-text-us": "node ./src/cli.mjs --overtime --limit 50 --format text --out commits.txt --country US --work-start 10 --work-end 19 --lunch-start 12 --lunch-end 13",
+    "cli:overtime-text-us-parent": "node ./src/cli.mjs --out-parent --overtime --limit 50 --format text --out commits.txt --country US --work-start 10 --work-end 19 --lunch-start 12 --lunch-end 13",
+    "cli:overtime-text-us-outdir": "node ./src/cli.mjs --out-dir ../output --overtime --limit 50 --format text --out commits.txt --country US --work-start 10 --work-end 19 --lunch-start 12 --lunch-end 13",
+    "cli:overtime-excel-cn": "node ./src/cli.mjs --overtime --limit 50 --format excel --out commits.xlsx --country CN",
+    "cli:overtime-excel-cn-parent": "node ./src/cli.mjs --out-parent --overtime --limit 50 --format excel --out commits.xlsx --country CN",
+    "cli:overtime-excel-cn-outdir": "node ./src/cli.mjs --out-dir ../output --overtime --limit 50 --format excel --out commits.xlsx --country CN",
     "format": "prettier --write \"src/**/*.{js,mjs}\"",
     "lint": "eslint src --ext .js,.mjs src",
     "lint:fix": "eslint src --ext .js,.mjs --fix",
@@ -75,11 +84,13 @@
     ]
   },
   "dependencies": {
-    "chalk": "^5.3.0",
-    "commander": "^12.0.0",
-    "dayjs": "^1.11.10",
-    "exceljs": "^4.4.0",
-    "zx": "^7.2.3"
+    "chalk": "5.6.0",
+    "commander": "12.1.0",
+    "dayjs": "1.11.19",
+    "date-holidays": "2.1.1",
+    "string-width": "5.1.2",
+    "exceljs": "4.4.0",
+    "zx": "7.2.4"
   },
   "devDependencies": {
     "@trivago/prettier-plugin-sort-imports": "5.2.2",

package/src/cli.mjs

@@ -3,6 +3,7 @@ import chalk from 'chalk';
 import path from 'path';
 import { getGitLogs } from './git.mjs';
 import { renderText } from './text.mjs';
+import { analyzeOvertime, renderOvertimeText, renderOvertimeTab, renderOvertimeCsv } from './overtime.mjs';
 import { exportExcel } from './excel.mjs';
 import { groupRecords, writeJSON, writeTextFile, outputFilePath } from './utils/index.mjs';
 
@@ -24,6 +25,12 @@ program
   .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('--overtime', '分析公司加班文化（输出下班时间与非工作日提交占比）')
+  .option('--country <code>', '节假日国家：CN 或 US，默认为 CN', 'CN')
+  .option('--work-start <hour>', '上班开始小时，默认 9', (v) => parseInt(v, 10), 9)
+  .option('--work-end <hour>', '下班小时，默认 18', (v) => parseInt(v, 10), 18)
+  .option('--lunch-start <hour>', '午休开始小时，默认 12', (v) => parseInt(v, 10), 12)
+  .option('--lunch-end <hour>', '午休结束小时，默认 14', (v) => parseInt(v, 10), 14)
   .option('--out <file>', '输出文件名（不含路径）')
   .option('--out-dir <dir>', '自定义输出目录，支持相对路径或绝对路径，例如 `--out-dir ../output`')
   .option('--out-parent', '将输出目录放到当前工程的父目录的 `output/`（等同于 `--out-dir ../output`）')
@@ -133,6 +140,44 @@ const opts = program.opts();
   // --- 分组 ---
   const groups = opts.groupBy ? groupRecords(records, opts.groupBy) : null;
 
+  // --- Overtime analysis ---
+  if (opts.overtime) {
+    const stats = analyzeOvertime(records, {
+      startHour: opts.workStart || opts.workStart === 0 ? opts.workStart : 9,
+      endHour: opts.workEnd || opts.workEnd === 0 ? opts.workEnd : 18,
+      lunchStart: opts.lunchStart || opts.lunchStart === 0 ? opts.lunchStart : 12,
+      lunchEnd: opts.lunchEnd || opts.lunchEnd === 0 ? opts.lunchEnd : 14,
+      country: opts.country || 'CN',
+    });
+    // Output to console
+    console.log('\n--- Overtime analysis ---\n');
+    console.log(renderOvertimeText(stats));
+    // if user requested json format, write stats to file
+    if (opts.json || opts.format === 'json') {
+      const file = opts.out || 'overtime.json';
+      const filepath = outputFilePath(file, outDir);
+      writeJSON(filepath, stats);
+      console.log(chalk.green(`overtime JSON 已导出: ${filepath}`));
+    }
+    // Always write human readable overtime text to file (default: overtime.txt)
+    const outBase = opts.out ? path.basename(opts.out, path.extname(opts.out)) : 'commits';
+    const overtimeFileName = `overtime_${outBase}.txt`;
+    const overtimeFile = outputFilePath(overtimeFileName, outDir);
+    writeTextFile(overtimeFile, renderOvertimeText(stats));
+    // write tab-separated text file for better alignment in editors that use proportional fonts
+    const overtimeTabFileName = `overtime_${outBase}.tab.txt`;
+    const overtimeTabFile = outputFilePath(overtimeTabFileName, outDir);
+    writeTextFile(overtimeTabFile, renderOvertimeTab(stats));
+    // write CSV for structured data consumption
+    const overtimeCsvFileName = `overtime_${outBase}.csv`;
+    const overtimeCsvFile = outputFilePath(overtimeCsvFileName, outDir);
+    writeTextFile(overtimeCsvFile, renderOvertimeCsv(stats));
+    console.log(chalk.green(`Overtime text 已导出: ${overtimeFile}`));
+    console.log(chalk.green(`Overtime table (tabs) 已导出: ${overtimeTabFile}`));
+    console.log(chalk.green(`Overtime CSV 已导出: ${overtimeCsvFile}`));
+    // don't return — allow other outputs to proceed
+  }
+
   // --- JSON ---
   if (opts.json || opts.format === 'json') {
     const file = opts.out || 'commits.json';

package/src/overtime.mjs

@@ -0,0 +1,233 @@
+import dayjs from 'dayjs';
+import DateHolidays from 'date-holidays';
+import stringWidth from 'string-width';
+
+export function parseCommitDate(d) {
+  // d examples: '2025-11-14 23:53:04 +0800' or ISO format
+  // Try dayjs parsing; fallback to slicing timezone
+  let dt = dayjs(d);
+  if (!dt.isValid()) {
+    // strip timezone offset and try again
+    const m = String(d).match(/^(\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2})/);
+    if (m) dt = dayjs(m[1]);
+  }
+  return dt;
+}
+
+function isWeekend(dt) {
+  const day = dt.day();
+  return day === 0 || day === 6; // Sunday=0, Saturday=6
+}
+
+function isOutsideWorkHours(dt, startHour = 9, endHour = 18, lunchStart = 12, lunchEnd = 14) {
+  const hour = dt.hour();
+  // Working hours are startHour <= hour < endHour, excluding lunchtime lunchStart <= hour < lunchEnd
+  const inWorkHours = hour >= startHour && hour < endHour && !(hour >= lunchStart && hour < lunchEnd);
+  return !inWorkHours;
+}
+
+export function analyzeOvertime(records, opts = {}) {
+  const { startHour = 9, endHour = 18, lunchStart = 12, lunchEnd = 14, country = 'CN' } = opts;
+  const total = records.length;
+
+  let outsideWorkCount = 0;
+  let nonWorkdayCount = 0;
+  let holidayCount = 0;
+
+  const byAuthor = new Map();
+
+  let startCommit = null;
+  let endCommit = null;
+  let latestCommit = null;
+
+  // init holiday checker for country
+  const hd = new DateHolidays();
+  try {
+    hd.init(String(country).toUpperCase());
+  } catch (err) {
+    // fallback to CN
+    hd.init('CN');
+  }
+
+  records.forEach((r) => {
+    const dt = parseCommitDate(r.date);
+    if (!dt || !dt.isValid()) return; // skip
+
+    const outside = isOutsideWorkHours(dt, startHour, endHour, lunchStart, lunchEnd);
+    const isHoliday = !!hd.isHoliday(dt.toDate());
+    const isNonWork = isWeekend(dt) || isHoliday;
+
+    if (outside) outsideWorkCount++;
+    if (isNonWork) nonWorkdayCount++;
+    if (isHoliday) holidayCount++;
+
+    const authorName = r.author || r.email || 'unknown';
+    const key = `${authorName} <${r.email || ''}>`;
+    const info = byAuthor.get(key) || {
+      name: authorName,
+      email: r.email || '',
+      total: 0,
+      outsideWorkCount: 0,
+      nonWorkdayCount: 0,
+    };
+
+    info.total++;
+    if (outside) info.outsideWorkCount++;
+    if (isNonWork) info.nonWorkdayCount++;
+    if (isHoliday) info.holidayCount = (info.holidayCount || 0) + 1;
+    byAuthor.set(key, info);
+  });
+
+  const perAuthor = [];
+  for (const [, v] of byAuthor) {
+    perAuthor.push({
+      name: v.name,
+      email: v.email,
+      total: v.total,
+      outsideWorkCount: v.outsideWorkCount,
+      nonWorkdayCount: v.nonWorkdayCount,
+      holidayCount: v.holidayCount || 0,
+      outsideWorkRate: v.total ? +(v.outsideWorkCount / v.total).toFixed(3) : 0,
+      nonWorkdayRate: v.total ? +(v.nonWorkdayCount / v.total).toFixed(3) : 0,
+      holidayRate: v.total ? +((v.holidayCount || 0) / v.total).toFixed(3) : 0,
+    });
+  }
+
+  // compute start/end/latest commit
+  // convert to dayjs and find min/max
+  const validRecords = records
+    .map((r) => ({ ...r, _dt: parseCommitDate(r.date) }))
+    .filter((r) => r._dt && r._dt.isValid());
+  if (validRecords.length > 0) {
+    validRecords.sort((a, b) => a._dt.valueOf() - b._dt.valueOf());
+    [startCommit] = validRecords;
+    endCommit = validRecords[validRecords.length - 1];
+    latestCommit = endCommit;
+    // cleanup temp _dt
+    for (let i = 0; i < validRecords.length; i++) {
+      // copy the object without _dt for safety
+      delete validRecords[i]._dt;
+    }
+  }
+
+  // sort perAuthor by outsideWorkRate desc
+  perAuthor.sort((a, b) => b.outsideWorkRate - a.outsideWorkRate || b.total - a.total);
+
+  return {
+    total,
+    outsideWorkCount,
+    nonWorkdayCount,
+    outsideWorkRate: total ? +(outsideWorkCount / total).toFixed(3) : 0,
+    nonWorkdayRate: total ? +(nonWorkdayCount / total).toFixed(3) : 0,
+    perAuthor,
+    /// 提示：计算 min/max 日期 & latest commit
+    startCommit: startCommit || null,
+    endCommit: endCommit || null,
+    latestCommit: latestCommit || null,
+    startHour,
+    endHour,
+      lunchStart,
+      lunchEnd,
+      country,
+      holidayCount,
+      holidayRate: total ? +(holidayCount / total).toFixed(3) : 0,
+  };
+}
+
+export function renderOvertimeText(stats) {
+  const { total, outsideWorkCount, nonWorkdayCount, holidayCount, outsideWorkRate, nonWorkdayRate, holidayRate, perAuthor, startHour, endHour, lunchStart, lunchEnd, country } = stats;
+  const { startCommit, endCommit, latestCommit } = stats;
+  const lines = [];
+
+  const formatPercent = (v) => `${(v * 100).toFixed(1)}%`;
+  const padDisplayEnd = (s, width) => {
+    const t = String(s ?? '');
+    const w = stringWidth(t);
+    return t + ' '.repeat(Math.max(0, width - w));
+  };
+  const padDisplayStart = (s, width) => {
+    const t = String(s ?? '');
+    const w = stringWidth(t);
+    return ' '.repeat(Math.max(0, width - w)) + t;
+  };
+  const cols = {
+    name: 22,
+    total: 6,
+    outside: 9,
+    outsideRate: 10,
+    nonWork: 10,
+    nonWorkRate: 12,
+    holiday: 8,
+    holidayRate: 10,
+  };
+  lines.push(`总提交数：${total}`);
+  if (startCommit && endCommit) {
+    lines.push(`统计区间：${startCommit.date} — ${endCommit.date}`);
+  }
+  if (latestCommit) {
+    lines.push('最晚一次提交：');
+    lines.push(`  Hash   : ${latestCommit.hash}`);
+    lines.push(`  Author : ${latestCommit.author}`);
+    lines.push(`  Date   : ${latestCommit.date}`);
+    lines.push(`  Message: ${latestCommit.message}`);
+  }
+  // country: holiday region, lunchStart/lunchEnd define midday break
+  lines.push(`下班时间定义：${startHour}:00 - ${endHour}:00 (午休 ${lunchStart}:00 - ${lunchEnd}:00)`);
+  lines.push(`国家假期参考：${String(country).toUpperCase()}，节假日提交数：${holidayCount}，占比：${(holidayRate * 100).toFixed(1)}%`);
+  lines.push(`下班时间（工作时间外）提交数：${outsideWorkCount}，占比：${(outsideWorkRate * 100).toFixed(1)}%`);
+  lines.push(`非工作日（周末）提交数：${nonWorkdayCount}，占比：${(nonWorkdayRate * 100).toFixed(1)}%`);
+  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)}`;
+  lines.push(header);
+  const totalWidth = cols.name + cols.total + cols.outside + cols.outsideRate + cols.nonWork + cols.nonWorkRate + cols.holiday + cols.holidayRate + 3 * 7; // approximate separator widths
+  lines.push('-'.repeat(Math.max(80, totalWidth)));
+
+  perAuthor.forEach((p) => {
+    const name = (p.name || '-').toString();
+    const row = `  ${padDisplayEnd(name, cols.name)} | ${padDisplayStart(String(p.total), cols.total)} | ${padDisplayStart(String(p.outsideWorkCount), cols.outside)} | ${padDisplayStart(formatPercent(p.outsideWorkRate), cols.outsideRate)} | ${padDisplayStart(String(p.nonWorkdayCount), cols.nonWork)} | ${padDisplayStart(formatPercent(p.nonWorkdayRate), cols.nonWorkRate)} | ${padDisplayStart(String(p.holidayCount), cols.holiday)} | ${padDisplayStart(formatPercent(p.holidayRate), cols.holidayRate)}`;
+    lines.push(row);
+  });
+  lines.push('');
+
+  return lines.join('\n');
+}
+
+export function renderOvertimeTab(stats) {
+  const { total, outsideWorkCount, nonWorkdayCount, holidayCount, outsideWorkRate, nonWorkdayRate, holidayRate, perAuthor, startHour, endHour, lunchStart, lunchEnd, country } = stats;
+  const { startCommit, endCommit, latestCommit } = stats;
+  const rows = [];
+  rows.push(`总提交数:\t${total}`);
+  if (startCommit && endCommit) rows.push(`统计区间:\t${startCommit.date} — ${endCommit.date}`);
+  if (latestCommit) rows.push(`最晚一次提交:\t${latestCommit.hash}\t${latestCommit.author}\t${latestCommit.date}\t${latestCommit.message}`);
+  rows.push(`下班时间定义:\t${startHour}:00 - ${endHour}:00 (午休 ${lunchStart}:00 - ${lunchEnd}:00)`);
+  rows.push(`国家假期参考:\t${String(country).toUpperCase()}\t节假日提交数:\t${holidayCount}\t节假日占比:\t${(holidayRate * 100).toFixed(1)}%`);
+  rows.push(`下班时间（工作时间外）提交数:\t${outsideWorkCount}\t占比:\t${(outsideWorkRate * 100).toFixed(1)}%`);
+  rows.push(`非工作日（周末）提交数:\t${nonWorkdayCount}\t占比:\t${(nonWorkdayRate * 100).toFixed(1)}%`);
+  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'));
+  });
+  return rows.join('\n');
+}
+
+function escapeCsv(v) {
+  const s = String(v ?? '');
+  if (s.includes(',') || s.includes('"') || s.includes('\n')) {
+    return `"${s.replace(/"/g, '""')}"`;
+  }
+  return s;
+}
+
+export function renderOvertimeCsv(stats) {
+  const { perAuthor } = stats;
+  const rows = [];
+  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)}%`);
+  });
+  return rows.join('\n');
+}
+