wukong-gitlog-cli 1.0.38 → 1.0.40

package/src/infra/configStore.mjs

@@ -0,0 +1,128 @@
+/**
+ * @file: configStore.mjs
+ * @description: 配置存储与加载模块，支持 JS/MJS 动态配置。
+* 配置存储与加载模块。
+ 命令参数优先级：
+   CLI > RC文件 > 内置默认值 (DEFAULT_CONFIG)。
+   出厂配置 < 用户全局配置 < 项目配置 < 命令行参数
+* @author: King Monkey
+ * @created: 2026-01-01 01:45
+ */
+import fs from 'fs'
+import os from 'os'
+import path from 'path'
+import { pathToFileURL } from 'url'
+import yaml from 'yaml'
+
+// 1. 定义出厂默认配置（底座）
+export const DEFAULT_CONFIG = {
+  git: { merges: true, limit: undefined, numstat: false },
+  period: { groupBy: 'month' },
+  worktime: {
+    country: 'CN',
+    start: 9,
+    end: 18,
+    lunch: { start: 12, end: 14 },
+    overnightCutoff: 6
+  },
+  output: {
+    out: 'commits', //  文件名前缀
+    dir: 'output-wukong',
+    formats: ['text'],
+    perPeriod: { enabled: true, excelMode: 'sheets' }
+  },
+  // 用户自定义的作者别名映射（key 可以是邮箱或原始作者名，value 为规范化作者名）
+  authorAliases: {}
+}
+
+// 配置文件名列表
+export const RC_NAMES = [
+  '.wukonggitlogrc',
+  '.wukonggitlogrc.js',
+  '.wukonggitlogrc.mjs',
+  '.wukonggitlogrc.yml',
+  '.wukonggitlogrc.yaml',
+  '.wukonggitlogrc.json'
+]
+
+function deepMerge(target, source) {
+  const result = { ...target }
+  if (!source) return result
+
+  for (const key of Object.keys(source)) {
+    if (
+      source[key] instanceof Object &&
+      !Array.isArray(source[key]) &&
+      key in target
+    ) {
+      result[key] = deepMerge(target[key], source[key])
+    } else if (source[key] !== undefined) {
+      result[key] = source[key]
+    }
+  }
+  return result
+}
+
+let cachedConfig = null
+
+/**
+ * 核心加载逻辑：支持异步 import
+ */
+export async function loadRcConfig(cwd = process.cwd()) {
+  if (cachedConfig) return cachedConfig
+
+  // 优先级队列：家目录(全局) -> 当前项目目录
+  const searchDirs = [os.homedir(), cwd]
+  let config = { ...DEFAULT_CONFIG }
+
+  for (const dir of searchDirs) {
+    for (const name of RC_NAMES) {
+      const filePath = path.join(dir, name)
+      // eslint-disable-next-line no-continue
+      if (!fs.existsSync(filePath)) continue
+
+      try {
+        let parsed = {}
+        const ext = path.extname(filePath)
+
+        if (
+          ext === '.js' ||
+          ext === '.mjs' ||
+          (name.endsWith('.wukonggitlogrc') && !ext)
+        ) {
+          // 处理 JS/MJS 或 无后缀但可能是 JS 的文件
+          // 必须转为 URL 格式以兼容 Windows 和 ESM 动态导入
+          const fileUrl = pathToFileURL(filePath).href
+          // eslint-disable-next-line no-await-in-loop
+          const module = await import(`${fileUrl}?t=${Date.now()}`) // 加缓存击穿避免热更新问题
+          parsed = module.default || module
+        } else if (ext === '.json') {
+          parsed = JSON.parse(fs.readFileSync(filePath, 'utf8'))
+        } else {
+          // 处理 YAML
+          parsed = yaml.parse(fs.readFileSync(filePath, 'utf8'))
+        }
+        config = deepMerge(config, parsed)
+      } catch (e) {
+        console.warn(
+          `[Config] 无法解析配置文件: ${filePath}\n原因: ${e.message}`
+        )
+      }
+    }
+  }
+
+  cachedConfig = config
+
+  return cachedConfig
+}
+
+/**
+ * 获取已加载的配置，如果未加载则抛出异常或异步加载
+ * 注意：由于支持了 JS，现在建议统一 await loadRcConfig()
+ */
+export function getRcConfig() {
+  if (!cachedConfig) {
+    throw new Error('Config not loaded. Please await loadRcConfig() first.')
+  }
+  return cachedConfig
+}

package/src/output/csv/overtime.mjs

@@ -0,0 +1,12 @@
+import { writeText } from '../utils/writeFile.mjs'
+import { outFile } from '../utils/outputPath.mjs'
+import { renderOvertimeCsv } from '../../domain/overtime/render.mjs'
+
+export function outputOvertimeCsvByPeriod(map, period, config) {
+  for (const key of Object.keys(map)) {
+    writeText(
+      outFile(config.dir, `${period}/overtime_${config.base}_${key}.csv`),
+      renderOvertimeCsv(map[key])
+    )
+  }
+}

package/src/output/data/readData.mjs

@@ -0,0 +1,54 @@
+import fs from 'fs'
+import path from 'path'
+import { pathToFileURL } from 'url';
+
+/* ---------------- validation ---------------- */
+
+function validateSchema(schema) {
+  if (!schema.schemaVersion) {
+    throw new Error('Invalid data schema: missing schemaVersion')
+  }
+
+  if (!schema.data?.commits) {
+    throw new Error('Invalid data schema: commits missing')
+  }
+}
+
+
+export async function readServeData(dir) {
+  const dataDir = path.join(dir, 'data');
+  const schemaFile = path.join(dataDir, 'data.schema.json');
+
+  if (!fs.existsSync(schemaFile)) throw new Error('Missing data.schema.json');
+
+  // 读取 schema 依然可以用 fs，因为它是配置文件
+  const schema = JSON.parse(fs.readFileSync(schemaFile, 'utf8'));
+  validateSchema(schema);
+
+  const result = {};
+
+  for (const [key, meta] of Object.entries(schema.data)) {
+    if (!meta.file) continue;
+
+    const filePath = path.join(dataDir, meta.file);
+    if (!fs.existsSync(filePath)) {
+      if (meta.required) throw new Error(`Missing: ${meta.file}`);
+      continue;
+    }
+
+    // 关键点：将绝对路径转换为 file:// URL 以支持 Windows 和 dynamic import
+    const fileUrl = pathToFileURL(filePath).href;
+
+    if (filePath.endsWith('.mjs')) {
+      const module = await import(fileUrl);
+      result[key] = module.default;
+    } else {
+      // JSON 文件处理
+      const raw = fs.readFileSync(filePath, 'utf8');
+      result[key] = JSON.parse(raw);
+    }
+  }
+
+
+  return result;
+}

package/src/output/data/writeData.mjs

@@ -0,0 +1,145 @@
+import fs from 'fs'
+
+import { outputExcelDayReport } from '#src/output/excel/outputExcelDayReport.mjs'
+import { outputTxtDayReport } from '#src/output/text/outputTxtDayReport.mjs'
+import { getCurrentTimestampSecond } from '#utils/index.mjs'
+
+import { getEsmJs } from '../utils/getEsmJs.mjs'
+import { writeJsonFile, writeTxtFile } from '../utils/index.mjs'
+
+const pkg = JSON.parse(
+  fs.readFileSync(new URL('../../../package.json', import.meta.url), 'utf-8')
+)
+
+function writeSchema(dir, files) {
+  const schema = {
+    schemaVersion: '1.0.0',
+    tool: {
+      name: pkg.name,
+      version: pkg.version
+    },
+    generatedAt: getCurrentTimestampSecond(),
+    data: {
+      commits: { file: files.commits, required: true },
+      authorMap: { file: files.authorMap, required: true },
+      overtime: { file: files.overtime, required: false },
+      overtimeByMonth: {
+        file: files.overtimeByMonth,
+        required: false
+      },
+      overtimeByWeek: {
+        file: files.overtimeByWeek,
+        required: false
+      },
+      options: { file: files.options, required: false }
+    }
+  }
+
+  writeJsonFile(dir, 'data.schema.json', schema)
+}
+
+export function writeServeData(result, config) {
+  const baseDir = `${config.dir}/data`
+
+  const files = {}
+
+  files.commits = writeJsonFile(baseDir, 'commits.json', result.commits)
+
+  files.authorMap = writeJsonFile(baseDir, 'authorMap.json', result.authorMap)
+
+  if (result.overtime) {
+    files.overtime = writeJsonFile(baseDir, 'overtime.json', result.overtime)
+  }
+
+  if (result.overtimeByMonth) {
+    files.overtimeByMonth = writeJsonFile(
+      baseDir,
+      'overtime.month.json',
+      result.overtimeByMonth
+    )
+  }
+
+  if (result.overtimeByWeek) {
+    files.overtimeByWeek = writeJsonFile(
+      baseDir,
+      'overtime.week.json',
+      result.overtimeByWeek
+    )
+  }
+
+  writeSchema(baseDir, files)
+}
+
+export function writeServeDataMjs(result, config) {
+  const baseDir = `${config.dir}/data`
+
+  const files = {}
+
+  files.config = writeTxtFile(
+    baseDir,
+    'config.mjs',
+    getEsmJs({ ...config.worktimeOptions, git: config.git || {} })
+  )
+
+  // 保存 CLI 运行时的 period（since/until/groupBy 等）和筛选条件（author），供前端展示采样信息
+  files.options = writeTxtFile(
+    baseDir,
+    'options.mjs',
+    getEsmJs({ period: config.period || {}, author: config.author || null })
+  )
+
+  files.commits = writeTxtFile(baseDir, 'commits.mjs', getEsmJs(result.commits))
+
+  files.authorMap = writeTxtFile(
+    baseDir,
+    'authorMap.mjs',
+    getEsmJs(result.authorMap)
+  )
+
+  if (result.authorChanges) {
+    files.authorChanges = writeTxtFile(
+      baseDir,
+      'author.changes.mjs',
+      getEsmJs(result.authorChanges)
+    )
+  }
+
+  if (result.overtime) {
+    files.overtime = writeTxtFile(
+      baseDir,
+      'overtime.mjs',
+      getEsmJs(result.overtime)
+    )
+  }
+
+  if (result.overtimeByMonth) {
+    files.overtimeByMonth = writeTxtFile(
+      baseDir,
+      'overtime.month.mjs',
+      getEsmJs(result.overtimeByMonth)
+    )
+  }
+
+  if (result.overtimeByWeek) {
+    files.overtimeByWeek = writeTxtFile(
+      baseDir,
+      'overtime.week.mjs',
+      getEsmJs(result.overtimeByWeek)
+    )
+  }
+  if (result.overtimeLatestCommitByDay) {
+    files.overtimeLatestCommitByDay = writeTxtFile(
+      baseDir,
+      'overtime.latest.commit.day.mjs',
+      getEsmJs(result.overtimeLatestCommitByDay)
+    )
+  }
+
+  writeSchema(baseDir, files)
+}
+
+// 输出 日报 数据excel
+export async function writeDayReportData({ dayReports = [], conf = {} }) {
+  await outputExcelDayReport({ dayReports, conf })
+  await outputTxtDayReport({ dayReports, conf })
+}

package/src/output/excel/commits.mjs

@@ -0,0 +1,9 @@
+import { exportExcel } from '../excel.mjs'
+
+export async function outputCommitsExcel(result, config) {
+  await exportExcel(result.records, null, {
+    file: `${config.dir}/${config.file || 'commits.xlsx'}`,
+    stats: config.stats,
+    gerrit: config.gerrit
+  })
+}

package/src/output/excel/outputExcelDayReport.mjs

@@ -0,0 +1,92 @@
+import dayjs from 'dayjs'
+import ExcelJS from 'exceljs'
+import path from 'path'
+
+import { DAY_REPORT_EXCEL } from '#src/constants/index.mjs'
+import { outFile } from '#src/output/utils/outputPath.mjs'
+
+/**
+ * @function outputExcelDayReport
+ * @description
+ * 按 author 输出 Excel 日报（每人一个 Excel）
+ * @param {Array} dayReports getGitLogsDayReport 的返回结果
+ * @param {Object} conf
+ * @param {string} conf.dir 输出目录
+ */
+export const outputExcelDayReport = async ({
+  dayReports = [],
+  conf = {}
+} = {}) => {
+  if (!Array.isArray(dayReports) || dayReports.length === 0) {
+    console.log('没有日报数据')
+    return
+  }
+
+  const config = { dir: conf.dir || path.resolve('output-wukong') }
+  const baseDir = `${config.dir}/${DAY_REPORT_EXCEL}`
+
+  // 按 author 分组
+  const authorMap = {}
+  dayReports.forEach((item) => {
+    if (!authorMap[item.author]) {
+      authorMap[item.author] = []
+    }
+    authorMap[item.author].push(item)
+  })
+
+  for (const [author, records] of Object.entries(authorMap)) {
+    records.sort((a, b) => dayjs(a.day).valueOf() - dayjs(b.day).valueOf())
+
+    const workbook = new ExcelJS.Workbook()
+    const sheet = workbook.addWorksheet('日报')
+
+    sheet.columns = [
+      { header: '日期', key: 'day', width: 15 },
+      { header: '姓名', key: 'author', width: 12 },
+      { header: '打卡时长', key: 'hours', width: 12 },
+      { header: '工作内容', key: 'msg', width: 60 },
+      { header: '偏差说明', key: 'remark', width: 20 },
+      { header: '生成时间', key: 'generatedAt', width: 22 }
+    ]
+
+    sheet.getRow(1).font = { bold: true }
+    // 🔴 生成时间表头红色（F列）
+    sheet.getCell('F1').font = {
+      bold: true,
+      color: { argb: 'FFFF0000' }
+    }
+    sheet.getColumn('day').numFmt = 'yyyy-mm-dd'
+    sheet.getColumn('msg').alignment = {
+      wrapText: true,
+      vertical: 'top'
+    }
+
+    const generatedTime = dayjs().format('YYYY-MM-DD HH:mm:ss')
+
+    records.forEach((item, index) => {
+      const row = sheet.addRow({
+        day: new Date(item.day),
+        author: item.author,
+        hours: 8,
+        msg: item.msg,
+        remark: '',
+        generatedAt: index === 0 ? generatedTime : ''
+      })
+
+      // ✅ 只给第一行的「生成时间」设红色字体
+      if (index === 0) {
+        row.getCell('generatedAt').font = {
+          color: { argb: 'FFFF0000' } // 红色
+        }
+      }
+    })
+
+    const excelFile = `${author}.xlsx`
+    const filePath = outFile(baseDir, excelFile)
+
+    // eslint-disable-next-line no-await-in-loop
+    await workbook.xlsx.writeFile(filePath)
+
+    console.log(`✅ 已生成 Excel：${filePath}`)
+  }
+}

package/src/output/excel/perPeriod.mjs

@@ -0,0 +1,24 @@
+import path from 'path'
+
+import { exportExcelPerPeriodSheets , exportExcel } from '../excel.mjs'
+
+export async function outputOvertimeExcelPerPeriod(map, period, config) {
+  if (config.mode === 'sheets') {
+    await exportExcelPerPeriodSheets(
+      map,
+      path.join(config.dir, `${period}/overtime_${config.base}.xlsx`)
+    )
+    return
+  }
+
+  // files 模式
+  for (const key of Object.keys(map)) {
+    // eslint-disable-next-line no-await-in-loop
+    await exportExcel(map[key], null, {
+      file: path.join(
+        config.dir,
+        `${period}/overtime_${config.base}_${key}.xlsx`
+      )
+    })
+  }
+}

package/src/{excel.mjs → output/excel.mjs}

@@ -1,6 +1,6 @@
 import dayjs from 'dayjs'
 import ExcelJS from 'exceljs'
-import { buildAuthorChangeStats } from './stats.mjs'
+import { buildAuthorChangeStats } from '#utils/buildAuthorChangeStats.mjs'
 
 
 export async function exportExcel(records, groups, options = {}) {
@@ -58,7 +58,7 @@ export async function exportExcel(records, groups, options = {}) {
 }
 
 export async function exportExcelPerPeriodSheets(groups, file, options = {}) {
-  const { stats, gerrit } = options
+  const {  gerrit } = options
 
   const wb = new ExcelJS.Workbook()
 
@@ -106,6 +106,7 @@ export async function exportExcelPerPeriodFiles(
   const keys = Object.keys(groups).sort()
   for (const k of keys) {
     const perFile = `${dir}/overtime_${filePrefix}_${k}.xlsx`
+    // eslint-disable-next-line no-await-in-loop
     await exportExcel(groups[k], null, {
       file: perFile,
       stats: options.stats,

package/src/output/index.mjs

@@ -0,0 +1,79 @@
+import { getCurrentTimestampSecond } from '#utils/index.mjs'
+
+import { outputOvertimeCsvByPeriod } from './csv/overtime.mjs'
+import {
+  writeDayReportData,
+  writeServeData,
+  writeServeDataMjs
+} from './data/writeData.mjs'
+import { outputCommitsExcel } from './excel/commits.mjs'
+import { outputOvertimeExcelPerPeriod } from './excel/perPeriod.mjs'
+import { outputOvertimeJson } from './json/overtime.mjs'
+import { outputOvertimeTabByPeriod } from './tab/overtime.mjs'
+import { outputCommitsText } from './text/commits.mjs'
+import { outputOvertimeText } from './text/overtime.mjs'
+import { resolveOutDir } from './utils/outputPath.mjs'
+
+export async function outputAll(result, config) {
+  const dir = resolveOutDir(config.dir)
+  const base = config.base || 'commits'
+
+  /* ---------- serve data（永远写） ---------- */
+  writeServeData(result, { dir })
+
+  /* ---------- 人类可读输出 ---------- */
+  if (config.formats.includes('text')) {
+    outputCommitsText(result, { dir })
+  }
+
+  if (config.formats.includes('excel')) {
+    await outputCommitsExcel(result, { dir })
+  }
+
+  if (!result.overtime) return
+
+  outputOvertimeText(result.overtime, { dir, base })
+
+  if (config.formats.includes('json')) {
+    outputOvertimeJson(result.overtime, { dir, base })
+  }
+
+  if (result.overtimeByMonth) {
+    if (config.perPeriod.formats.includes('csv')) {
+      outputOvertimeCsvByPeriod(result.overtimeByMonth, 'month', { dir, base })
+    }
+
+    if (config.perPeriod.formats.includes('tab')) {
+      outputOvertimeTabByPeriod(result.overtimeByMonth, 'month', { dir, base })
+    }
+
+    if (config.perPeriod.formats.includes('xlsx')) {
+      await outputOvertimeExcelPerPeriod(result.overtimeByMonth, 'month', {
+        dir,
+        base,
+        mode: config.perPeriod.excelMode
+      })
+    }
+  }
+}
+
+export async function outputData(result, config) {
+  const dir = resolveOutDir(config.dir)
+
+  /* ---------- serve data（永远写） ---------- */
+  await writeServeDataMjs(result, {
+    dir,
+    ...config,
+    worktimeOptions: config.worktimeOptions
+  })
+}
+
+export async function outputJournalAnalysis(result, config) {
+  const dir = resolveOutDir(config.dir)
+
+  const time = getCurrentTimestampSecond()
+  writeDayReportData({
+    dayReports: result.authorDayReport,
+    conf: { dir, time }
+  })
+}

package/src/output/json/overtime.mjs

@@ -0,0 +1,9 @@
+import { writeJson } from '../utils/writeFile.mjs'
+import { outFile } from '../utils/outputPath.mjs'
+
+export function outputOvertimeJson(stats, config) {
+  writeJson(
+    outFile(config.dir, `overtime_${config.base}.json`),
+    stats
+  )
+}

package/src/output/tab/overtime.mjs

@@ -0,0 +1,12 @@
+import { writeText } from '../utils/writeFile.mjs'
+import { outFile } from '../utils/outputPath.mjs'
+import { renderOvertimeTab } from '../../domain/overtime/render.mjs'
+
+export function outputOvertimeTabByPeriod(map, period, config) {
+  for (const key of Object.keys(map)) {
+    writeText(
+      outFile(config.dir, `${period}/overtime_${config.base}_${key}.tab.txt`),
+      renderOvertimeTab(map[key])
+    )
+  }
+}

package/src/output/text/commits.mjs

@@ -0,0 +1,9 @@
+import { writeText } from '../utils/writeFile.mjs'
+// import { writeJsonFile, writeTxtFile } from '#src/output/utils/index.mjs'
+import { outFile } from '../utils/outputPath.mjs'
+import { renderText } from '../text.mjs' // 复用你原来的
+
+export function outputCommitsText(result, config) {
+  const file = outFile(config.dir, config.file || 'commits.txt')
+  writeText(file, renderText(result.records))
+}

package/src/output/text/index.mjs

@@ -0,0 +1,3 @@
+export { outputCommitsText } from './commits.mjs'
+
+