wukong-gitlog-cli 1.0.39 → 1.0.41

package/src/app/journalAction.mjs

@@ -0,0 +1,117 @@
+import chalk from 'chalk'
+import path from 'path'
+import { createProfiler } from 'wukong-profiler'
+import { createMultiBar } from 'wukong-progress'
+
+import { getProfileDirFile } from '#utils/getProfileDirFile.mjs'
+
+import { parseOptions } from '../cli/parseOptions.mjs'
+import { getAuthorChangeStats } from '../domain/author/analyze.mjs'
+import { dedupeCommits, getGitLogsFast } from '../domain/git/getGitLogs.mjs'
+import { resolveGerrit } from '../domain/git/resolveGerrit.mjs'
+import { getWorkOvertimeStats } from '../domain/overtime/analyze.mjs'
+import { outputAll, outputJournalAnalysis } from '../output/index.mjs'
+import {
+  getGitLogsDayReport,
+  getLatestCommitByDay,
+  getOvertimeByMonth,
+  getOvertimeByWeek,
+  getWorkTimeConfig
+} from './helpers.mjs'
+import { t } from '../i18n/index.mjs'
+
+
+// 日报，把每天提交记录合并后，按天输出
+
+export async function journalAction(rawOpts = {}) {
+  const opts = await parseOptions(rawOpts)
+
+  const traceFile = getProfileDirFile('trace.json', opts)
+  const profileFile = getProfileDirFile('profile.json', opts)
+
+  const profiler = createProfiler(
+    { ...opts.profile, traceFile, profileFile },
+    opts
+  )
+
+  // 未来 可考虑将 MultiBar 抽离到更高层，支持所有 action 共用，wukong-progress 需要支持自定义子任务占位符
+  // 初始化 MultiBar
+  const mb = createMultiBar()
+  const bar = mb.create(100, {
+    prefix: chalk.cyan(t('journal.prefix')),
+    format: ' [:bar] :percent :payload'
+  })
+
+  const result = {}
+
+  try {
+    // 1️⃣ 拉取 Git 记录
+    bar.step(5, t('analyze.step_git_fetch'))
+    const { commits, authorMap } = await profiler.stepAsync('getGitLogs', () =>
+      getGitLogsFast(opts)
+    )
+
+    //  去重 commit（基于 Change-Id），过滤掉 Gerrit 产生的重复提交例如cherry-pick
+    const cleanCommits = dedupeCommits(commits, {
+      by: 'changeId',
+      prefer: 'original'
+    })
+
+    result.cleanCommits = cleanCommits
+
+    result.commits = commits
+    result.authorMap = authorMap
+    bar.step(15, t('analyze.step_git_done')) // 'Git 记录提取完成'
+
+    const records = result.commits
+
+    // 2️⃣ Gerrit enrich（公共）
+    const enrichedRecords = opts.gerrit
+      ? await resolveGerrit(records, opts)
+      : records
+
+    // 2️⃣ 分析作者变更
+    bar.step(10, t('analyze.step_author_stats')) // '正在分析作者代码贡献...'
+    const authorChanges = await profiler.stepAsync(
+      'analyzeAuthorChanges',
+      () => {
+        return getAuthorChangeStats(enrichedRecords)
+      }
+    )
+    result.authorChanges = authorChanges
+
+    const authorDayReport = await profiler.stepAsync(
+      'analyzeAuthorDayReport',
+      () => {
+        return getGitLogsDayReport(cleanCommits, opts)
+      }
+    )
+
+    result.authorDayReport = authorDayReport
+
+    // 4️⃣ 数据输出
+    bar.step(10, t('analyze.step_output')) // '正在持久化分析结果...'
+    await profiler.stepAsync('output', async () => {
+      const worktimeOptions = getWorkTimeConfig(opts)
+      await outputJournalAnalysis(result, {
+        dir: opts.output.dir || path.resolve('output-wukong'),
+        worktimeOptions
+      })
+    })
+
+    bar.step(100, t('journal.complete')) // '分析任务全部完成！'
+  } catch (error) {
+    // 异常处理：停止进度条并打印红色错误
+    mb.stop()
+    console.error(
+      `\n${chalk.bgRed(' ERROR ')} ${chalk.red(error.stack || error)}`
+    )
+    process.exit(1)
+  } finally {
+    // 正常结束
+    profiler.end('journal')
+    mb.stop()
+  }
+
+  return result
+}

package/src/app/overtimeAction.mjs

@@ -0,0 +1,100 @@
+import chalk from 'chalk'
+import path from 'path'
+import { createProfiler } from 'wukong-profiler'
+import { createMultiBar } from 'wukong-progress'
+
+import { getProfileDirFile } from '#utils/getProfileDirFile.mjs'
+
+import { parseOptions } from '../cli/parseOptions.mjs'
+import { getGitLogsFast } from '../domain/git/getGitLogs.mjs'
+import { resolveGerrit } from '../domain/git/resolveGerrit.mjs'
+import { getWorkOvertimeStats } from '../domain/overtime/analyze.mjs'
+import { t } from '../i18n/index.mjs'
+import { outputAll, outputData } from '../output/index.mjs'
+import { resolveOutDir } from '../output/utils/outputPath.mjs'
+import {
+  getLatestCommitByDay,
+  getOvertimeByMonth,
+  getOvertimeByWeek,
+  getWorkTimeConfig
+} from './helpers.mjs'
+
+export async function overtimeAction(rawOpts = {}) {
+  const opts = await parseOptions(rawOpts)
+  const traceFile = getProfileDirFile('trace.json', opts)
+
+  const profiler = createProfiler({ ...opts.profile, traceFile })
+
+  // 未来 可考虑将 MultiBar 抽离到更高层，支持所有 action 共用，wukong-progress 需要支持自定义子任务占位符
+  // 初始化 MultiBar
+  const mb = createMultiBar()
+  const bar = mb.create(100, {
+    prefix: chalk.cyan(t('overtime.prefix')), // '加班分析' / 'Overtime'
+    format: ' [:bar] :percent :payload'
+  })
+
+  const result = {}
+  try {
+    // 1️⃣ 拉取 Git 记录
+    bar.step(5, t('analyze.step_git_fetch'))
+    const { commits } = await profiler.stepAsync('getGitLogs', () =>
+      getGitLogsFast(opts)
+    )
+    result.commits = commits
+
+    bar.step(5, t('analyze.step_git_done'))
+
+    const records = result.commits
+
+    // 2️⃣ Gerrit enrich（公共）
+    const enrichedRecords = opts.gerrit
+      ? await resolveGerrit(records, opts)
+      : records
+
+    // 3️⃣ 加班分析（根据配置可选）
+    const worktimeOptions = getWorkTimeConfig(opts)
+
+    bar.step(5, t('analyze.step_overtime_calc'))
+    result.overtime = await profiler.stepAsync('overtime', () => {
+      return getWorkOvertimeStats(enrichedRecords, worktimeOptions)
+    })
+
+    bar.step(5, t('analyze.step_trends'))
+    result.overtimeByWeek = await getOvertimeByWeek(enrichedRecords)
+    result.overtimeByMonth = await getOvertimeByMonth(enrichedRecords)
+    bar.step(10, t('analyze.step_latest_mark'))
+    result.overtimeLatestCommitByDay = await getLatestCommitByDay({
+      commits: enrichedRecords,
+      opts: worktimeOptions
+    })
+
+    // 4️⃣ 数据输出
+    bar.step(1, t('analyze.step_output'))
+    const dir = opts.output.dir || path.resolve('output-wukong')
+    await profiler.stepAsync('output', async () => {
+      return outputData(result, {
+        dir,
+        worktimeOptions,
+        git: opts.git || {}
+      })
+    })
+
+    bar.step(100, t('analyze.step_complete'))
+    console.log(
+      chalk.green(`\n${t('overtime.complete')} ${resolveOutDir(dir)}\n`)
+    )
+  } catch (error) {
+    // 异常处理：停止进度条并打印红色错误
+    mb.stop()
+    console.error(
+      `\n${chalk.bgRed(' ERROR ')} ${chalk.red(error.stack || error)}`
+    )
+    process.exit(1)
+  } finally {
+    // 正常结束
+    profiler.end('analyze')
+    mb.stop()
+  }
+
+  return result
+}

package/src/app/serveAction.mjs

@@ -0,0 +1,73 @@
+import { logger } from '#utils/logger.mjs'
+
+import { parseOptions } from '../cli/parseOptions.mjs'
+import { readServeData } from '../output/data/readData.mjs'
+import { startServer } from '../serve/startServer.mjs'
+import { analyzeAction } from './analyzeAction.mjs'
+
+export async function serveAction(rawOpts = {}) {
+  const opts = await parseOptions(rawOpts)
+
+  const dir = opts.output.dir || 'output-wukong'
+
+  // 🚀 在启动服务前，自动运行 analyze 以更新基础数据
+  try {
+    logger.info('⚡ Auto-running analyze to ensure latest data...')
+    await analyzeAction(rawOpts)
+    logger.info('✅ Data refreshed successfully')
+  } catch (error) {
+    logger.warn(
+      '⚠️  Auto-analyze failed, but continuing with cached data:',
+      error.message
+    )
+  }
+
+  let data = null
+
+  try {
+    data = await readServeData(dir)
+
+    if (!data) {
+      logger.error(
+        'No serve data found. Please run `wukong-gitlog analyze` first.'
+      )
+      process.exit(1)
+    }
+  } catch (error) {
+    logger.error(
+      'Failed to read serve data. Please run `wukong-gitlog analyze` first.'
+    )
+    process.exit(1)
+  }
+
+  const initialPort = Number(opts.serve.port || 3000)
+  let port = initialPort
+  let server = null
+  const maxTries = 50 // 尝试的端口数量上限
+
+  for (let i = 0; i < maxTries; i++) {
+    try {
+      // eslint-disable-next-line no-await-in-loop
+      server = await startServer(port, dir, data)
+      break
+    } catch (err) {
+      // 端口被占用，尝试下一个端口；其它错误抛出
+      if (err && err.code === 'EADDRINUSE') {
+        console.warn(`Port ${port} in use, trying ${port + 1}...`)
+        port += 1
+        continue
+      }
+      throw err
+    }
+  }
+
+  if (!server) {
+    throw new Error(`Failed to start server on ports ${initialPort} - ${port}.`)
+  }
+
+  if (port !== initialPort) {
+    console.log(`Port ${initialPort} occupied, server started on ${port}.`)
+  }
+
+  return server
+}

package/src/app/versionAction.mjs

@@ -0,0 +1,7 @@
+import { getPackage } from '../utils/getPackage.mjs'
+import { showVersionInfo } from '../utils/showVersionInfo.mjs'
+
+export const versionAction = () => {
+  const pkg = getPackage()
+  showVersionInfo(pkg)
+}

package/src/cli/defineOptions.mjs

@@ -0,0 +1,209 @@
+/**
+ * @file: defineOptions.mjs
+ * @description:
+ * @author: King Monkey
+ * @created: 2025-12-31 17:30
+ */
+import { t } from '../i18n/index.mjs'
+import { getPackage } from '../utils/getPackage.mjs'
+
+// 辅助函数：统一 Int 解析
+const toInt = (v, def) => (v ? parseInt(v, 10) : def)
+const toFloat = (v) => parseFloat(v)
+
+export function defineOptions(program) {
+  const pkg = getPackage()
+  program
+    .name('wukong-gitlog')
+    .version(pkg.version, '-v')
+    .description('Advanced Git commit log exporter.')
+    .option(
+      '--author <name>',
+      '指定 author,注意如果用户Git的user.name和user.email不规范,例如配置过不同的邮箱和name，应该通过--author-aliases 进行别名映射，并且不传递 --author 参数，以免过滤掉不规范的提交记录'
+    )
+    .option('--email <email>', '指定 email')
+    .option('--since <date>', '起始日期')
+    .option('--until <date>', '结束日期')
+    .option('--limit <n>', '限制数量', parseInt)
+    .option('--no-merges', '不包含 merge commit')
+    .option('--numstat', '显示每次提交中更改的文件以及增删的行数统计')
+
+    .option('--group-by <type>', '按日期分组: day | month | week | all ')
+    .option('--format <type>', '输出格式: text | excel | json', 'text')
+
+    .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('--overtime', '启用加班文化分析')
+
+    .option('--country <code>', '节假日国家：CN 或 US，默认为 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(
+      '--overnight-cutoff <hour>',
+      '次日凌晨归并窗口（小时），默认 6',
+      (v) => parseInt(v, 10),
+      6
+    )
+
+
+    .option(
+      '--out-dir <dir>',
+      '自定义输出目录，支持相对路径或绝对路径，例如 `--out-dir ../output-wukong`'
+    )
+    .option(
+      '--out-parent',
+      '将输出目录放到当前工程的父目录的 `output-wukong/`（等同于 `--out-dir ../output-wukong`）'
+    )
+    .option(
+      '--per-period-formats <formats>',
+      '每个周期单独输出的格式，逗号分隔：text,csv,tab,xlsx。默认为空（不输出 CSV/Tab/XLSX）',
+      ''
+    )
+    .option(
+      '--per-period-excel-mode <mode>',
+      'per-period Excel 模式：sheets|files（默认：sheets）',
+      'sheets'
+    )
+    .option(
+      '--per-period-only',
+      '仅输出 per-period（month/week）文件，不输出合并的 monthly/weekly 汇总文件'
+    )
+    .option(
+      '--port <n>',
+      '本地 web 服务端口（默认 3000）',
+      (v) => parseInt(v, 10),
+      3000
+    )
+    .option('--debug', 'enable debug logs')
+
+    .option('--profile', '输出性能分析 JSON')
+    .option('--verbose', '显示详细性能日志')
+    .option('--flame', '显示 flame-like 日志')
+    .option('--trace <file>', '生成 Chrome Trace')
+    .option('--hot-threshold <n>', 'HOT 比例阈值', parseFloat)
+    .option('--fail-on-hot', 'HOT 时 CI 失败')
+    .option('--diff-base <file>', '基线 profile.json')
+    .option('--diff-threshold <n>', '回归阈值', parseFloat)
+
+    .option('--version', 'show version information')
+}
+
+
+/**
+ * 1. 基础程序信息（全局通用）
+ */
+export function setupBaseProgram(program) {
+  const pkg = getPackage()
+  program
+    .name('wukong-gitlog')
+    .version(pkg.version, '-v')
+    .description(t('cli.desc'))
+    .option('-l, --lang <type>', t('options.lang')) // 放在这里，让所有命令都能看到 help
+    .option('-i,--info', t('options.info'))
+    .option('--debug', t('options.debug'))
+}
+
+/**
+ * 2. Git 数据源过滤参数 (Analyze, Export, Journal, Overtime 通用)
+ */
+export function addGitSourceOptions(cmd) {
+  return cmd
+    .option('--author <name>', t('options.author'))
+    .option('--email <email>', t('options.email'))
+    .option('--since <date>', t('options.since'))
+    .option('--until <date>', t('options.until'))
+    .option('--limit <n>', t('options.limit'), toInt)
+    .option('--no-merges', t('options.no_merges'))
+    .option('--numstat', t('options.numstat'))
+    // FIXME: 暂时没有Gerrit需求，先注释掉相关参数，等需要了再放开
+    // .option('--gerrit <prefix>', t('options.gerrit_prefix'))
+    // .option('--gerrit-api <url>', t('options.gerrit_api'))
+    // .option('--gerrit-auth <token>', t('options.gerrit_auth'))
+}
+
+/**
+ * 3. 核心算法与统计参数 (Analyze, Overtime 通用)
+ */
+export function addAnalysisOptions(cmd) {
+  return cmd
+    .option('--country <code>', t('options.country'), 'CN')
+    .option('--work-start <hour>', t('options.work_start'), toInt, 9)
+    .option('--work-end <hour>', t('options.work_end'), toInt, 18)
+    .option('--lunch-start <hour>', t('options.lunch_start'), toInt, 12)
+    .option('--lunch-end <hour>', t('options.lunch_end'), toInt, 14)
+    .option('--overnight-cutoff <hour>', t('options.overnight_cutoff'), toInt, 6)
+    .option('--group-by <type>', t('options.group_by'), 'day') // 默认 day
+    .option('--stats', t('options.stats'))
+    .option('--overtime', t('options.overtime_mode'))
+}
+
+/**
+ * 4. 文件导出与格式参数 (Export, Journal, Analyze)
+ */
+export function addOutputOptions(cmd) {
+  return cmd
+    .option('--format <type>', t('options.format'), 'text')
+    .option('--out-dir <dir>', t('options.out_dir'))
+    .option('--out-parent', t('options.out_parent'))
+    .option('--per-period-formats <formats>', t('options.per_period_formats'), '')
+    .option('--per-period-excel-mode <mode>', t('options.per_period_mode'), 'sheets')
+    .option('--per-period-only', t('options.per_period_only'))
+}
+
+/**
+ * 5. Web 服务专用参数
+ */
+export function addServeOptions(cmd) {
+  return cmd
+    .option('--port <n>', t('options.port'), toInt, 3000)
+    .option('--numstat', t('options.numstat'))
+}
+
+/**
+ * 6. 性能追踪与调试 (通常用于 analyze)
+ */
+export function addPerformanceOptions(cmd) {
+  return cmd
+    .option('--profile', t('options.profile'))
+    .option('--verbose', t('options.verbose'))
+    .option('--flame', t('options.flame'))
+    .option('--trace <file>', t('options.trace'))
+    // .option('--hot-threshold <n>', t('options.hot_threshold'), toFloat)
+    // .option('--fail-on-hot', t('options.fail_on_hot'))
+    // .option('--diff-base <file>', t('options.diff_base'))
+    // .option('--diff-threshold <n>', t('options.diff_threshold'), toFloat)
+}

package/src/cli/parseOptions.mjs

@@ -1,9 +1,127 @@
-export function parseOptions(opts) {
-  return {
-    startHour: opts.workStart ?? 9,
-    endHour: opts.workEnd ?? 18,
-    lunchStart: opts.lunchStart ?? 12,
-    lunchEnd: opts.lunchEnd ?? 14,
-    country: opts.country ?? 'CN'
-  };
+/**
+ * @file: parseOptions.mjs
+ * @description:
+ * @author: King Monkey
+ * @created: 2025-12-31 17:24
+ */
+import { resolveBool, resolveValue } from '#src/utils/resolve.mjs'
+
+import { loadRcConfig } from '../infra/configStore.mjs'
+
+/**
+ * 深度合并辅助函数 (如果你的项目里没引入 lodash，可以直接用这个)
+ */
+function deepMerge(target, source) {
+  const result = { ...target }
+  for (const key in source) {
+    if (source[key] instanceof Object && key in target) {
+      result[key] = deepMerge(target[key], source[key])
+    } else if (source[key] !== undefined) {
+      result[key] = source[key]
+    }
+  }
+  return result
+}
+
+export async function parseOptions(cliOpts) {
+  // 1. 加载“底座”配置（此时已包含：出厂默认 + RC文件）
+  // 确保拿到 baseConfig
+  const baseConfig = await loadRcConfig()
+
+  const overtime = resolveBool(cliOpts.overtime, baseConfig?.overtime, false)
+
+  const country = resolveValue(
+    cliOpts.country,
+    baseConfig?.worktime?.country,
+    'CN'
+  )
+
+  // 2. 将扁平的 CLI 参数映射为嵌套结构 (与 RC 结构对齐)
+  // 注意：只有当 CLI 确实传了值时，才映射到对象里，否则保持 undefined
+  const mappedCli = {
+    author: cliOpts.author,
+    email: cliOpts.email,
+    git: {
+      merges: cliOpts.merges,
+      limit: cliOpts.limit,
+      numstat: cliOpts.numstat
+    },
+    period: {
+      groupBy: cliOpts.groupBy,
+      since: cliOpts.since,
+      until: cliOpts.until
+    },
+    overtime,
+    gerrit: {
+      prefix: cliOpts.gerrit,
+      api: cliOpts.gerritApi,
+      auth: cliOpts.gerritAuth
+    },
+    worktime: {
+      country,
+      start: cliOpts.workStart,
+      end: cliOpts.workEnd,
+      overnightCutoff: cliOpts.overnightCutoff,
+      // 只有当传了任何一个午休参数时才生成 lunch 对象
+      lunch:
+        cliOpts.lunchStart || cliOpts.lunchEnd
+          ? {
+              start: cliOpts.lunchStart,
+              end: cliOpts.lunchEnd
+            }
+          : undefined
+    },
+    output: {
+      dir: cliOpts.outParent ? '../output-wukong' : cliOpts.outDir,
+      formats: cliOpts.format ? cliOpts.format : undefined,
+      perPeriod: {
+        // formats: cliOpts.perPeriodFormats?.split(','),
+        formats: String(cliOpts.perPeriodFormats || '')
+          .split(',')
+          .map((s) =>
+            String(s || '')
+              .trim()
+              .toLowerCase()
+          )
+          .filter(Boolean),
+        excelMode: cliOpts.perPeriodExcelMode,
+        only: cliOpts.perPeriodOnly
+      }
+    },
+    serve: {
+      port: cliOpts.port
+    },
+    profile: {
+      enabled: cliOpts.profile,
+      verbose: cliOpts.verbose ,
+      flame: cliOpts.flame || true,
+      traceFile: cliOpts.traceFile || 'trace.json',
+      hotThreshold: cliOpts.hotThreshold || 0.8,
+      diffThreshold: cliOpts.diffThreshold || 0.2,
+      failOnHot: cliOpts.failOnHot || false,
+      diffBaseFile: cliOpts.diffBaseFile || 'baseline.json'
+      /*
+      enabled: true,
+      flame: true,
+      traceFile: 'trace.json',
+      hotThreshold: 0.8,
+      failOnHot: true,
+      diffBaseFile: 'baseline.json',
+      diffThreshold: 0.2
+      */
+    }
+  }
+
+  // 3. 终极合并：用映射后的 CLI 配置 覆盖 底座配置
+  const finalConfig = deepMerge(baseConfig, mappedCli)
+
+  // 4. 最后做一点“路径标准化”或“格式转换”
+  // 例如：如果 format 选了 json，自动勾选 cliOpts.json
+  if (cliOpts.json) {
+    finalConfig.output.formats = Array.from(
+      new Set([...finalConfig.output.formats, 'json'])
+    )
+  }
+
+  return finalConfig
 }

package/src/constants/index.mjs

@@ -1,3 +1,17 @@
-export const CLI_NAME = 'wukong-gitlog-cli'
+// 输出目录
+export const EXPORT_DIR = "export"
 
-export const GIT_HUB ='https://www.npmjs.com/package/wukong-gitlog-cli'
+// 日报相关
+export const DAY_REPORT = "dayReport"
+export const DAY_REPORT_TXT = "dayReport/txt"
+export const DAY_REPORT_EXCEL = "dayReport/excel"
+
+// 按月导出相关
+export const EXPORT_DIR_MONTH = "export/month"
+export const EXPORT_DIR_WEEK = "export/week"
+
+// profile
+export const EXPORT_DIR_PROFILE = "export/profile"
+
+// 配置文件名
+export const WUKONG_GITLOG_RC = ".wukonggitlogrc"

package/src/domain/author/analyze.mjs

@@ -0,0 +1,6 @@
+import { buildAuthorChangeStats } from '#utils/buildAuthorChangeStats.mjs'
+
+// 分析作者变更统计
+export const getAuthorChangeStats = (records) => {
+  return buildAuthorChangeStats(records)
+}