wukong-gitlog-cli 1.0.38 → 1.0.40

package/src/domain/export/exportAuthor.mjs

@@ -0,0 +1,28 @@
+import path from 'path'
+
+import { EXPORT_DIR } from '#src/constants/index.mjs'
+import { renderAuthorMapText } from '#src/output/renderAuthorMapText.mjs'
+import { getEsmJs } from '#src/output/utils/getEsmJs.mjs'
+import { writeTxtFile } from '#src/output/utils/index.mjs'
+
+/**
+ * @function handleExportAuthor
+ * @description 按周导出
+ * @param {type}
+ * @returns {type}
+ */
+export const handleExportAuthor = async ({ opts, records, fileName }) => {
+  const config = { dir: opts.output.dir || path.resolve('output-wukong') }
+  const baseDir = `${config.dir}/${EXPORT_DIR}`
+
+  try {
+    const commitFileName = fileName || `authors.txt`
+    const rawResult = renderAuthorMapText(records)
+    writeTxtFile(baseDir, commitFileName, rawResult)
+  } catch (err) {
+    console.warn(
+      'handleExportAuthor failed:',
+      err && err.message ? err.message : err
+    )
+  }
+}

package/src/domain/export/exportAuthorChanges.mjs

@@ -0,0 +1,27 @@
+import path from 'path'
+
+import { EXPORT_DIR } from '#src/constants/index.mjs'
+import { renderChangedLinesText } from '#src/output/text.mjs'
+import { writeTxtFile } from '#src/output/utils/index.mjs'
+
+/**
+ * @function handleExportAuthorChanges
+ * @description 按周导出
+ * @param {type}
+ * @returns {type}
+ */
+export const handleExportAuthorChanges = async ({ opts, records, fileName }) => {
+  const config = { dir: opts.output.dir || path.resolve('output-wukong') }
+  const baseDir = `${config.dir}/${EXPORT_DIR}`
+
+  try {
+    const commitFileName = fileName || `author-changes.txt`
+    const rawResult = renderChangedLinesText(records)
+    writeTxtFile(baseDir, commitFileName, rawResult)
+  } catch (err) {
+    console.warn(
+      'handleExportAuthorChanges failed:',
+      err && err.message ? err.message : err
+    )
+  }
+}

package/src/domain/export/exportAuthorChangesJson.mjs

@@ -0,0 +1,31 @@
+import path from 'path'
+
+import { EXPORT_DIR } from '#src/constants/index.mjs'
+import { renderAuthorChangesJson } from '#src/output/json.mjs'
+import { writeJsonFile } from '#src/output/utils/index.mjs'
+
+/**
+ * @function handleExportAuthorChangesJson
+ * @description 按周导出
+ * @param {type}
+ * @returns {type}
+ */
+export const handleExportAuthorChangesJson = async ({
+  opts,
+  records,
+  fileName
+}) => {
+  const config = { dir: opts.output.dir || path.resolve('output-wukong') }
+  const baseDir = `${config.dir}/${EXPORT_DIR}`
+
+  try {
+    const commitFileName = fileName || `author-changes.json`
+    const rawResult = renderAuthorChangesJson(records)
+    writeJsonFile(baseDir, commitFileName, rawResult)
+  } catch (err) {
+    console.warn(
+      'handleExportAuthorChangesJson failed:',
+      err && err.message ? err.message : err
+    )
+  }
+}

package/src/domain/export/exportByMonth.mjs

@@ -0,0 +1,157 @@
+import path from 'path'
+
+import { EXPORT_DIR_MONTH } from '#src/constants/index.mjs'
+import {
+  renderOvertimeCsv,
+  renderOvertimeTab,
+  renderOvertimeText
+} from '#src/domain/overtime/overtime.mjs'
+import {
+  exportExcel,
+  exportExcelAuthorChangeStats,
+  exportExcelPerPeriodFiles,
+  exportExcelPerPeriodSheets
+} from '#src/output/excel.mjs'
+import { writeJsonFile, writeTxtFile } from '#src/output/utils/index.mjs'
+import { outFile } from '#src/output/utils/outputPath.mjs'
+import { groupRecords } from '#utils/groupRecords.mjs'
+import { logger } from '#utils/logger.mjs'
+
+import { getWorkOvertimeStats } from '../overtime/analyze.mjs'
+
+/**
+ * @function handleExportByMonth
+ * @description 按月导出
+ * @param {type}
+ * @returns {type}
+ */
+export const handleExportByMonth = async ({
+  opts,
+  records,
+  worktimeOptions
+}) => {
+  // Always write human readable overtime text to file (default: overtime.txt)
+  const outBase = opts.output.out || 'commits'
+  const config = { dir: opts.output.dir || path.resolve('output-wukong') }
+  const baseDir = `${config.dir}/${EXPORT_DIR_MONTH}`
+
+
+  // 按月输出 ... 保持原逻辑
+  const perPeriodFormats = opts.output.perPeriod.formats
+  try {
+    const monthGroups = groupRecords(records, 'month')
+    const monthlyFileName = `overtime_${outBase}_monthly.txt`
+
+    let monthlyContent = ''
+    const monthKeys = Object.keys(monthGroups).sort()
+    monthKeys.forEach((k) => {
+      const groupRecs = monthGroups[k]
+      const s = getWorkOvertimeStats(groupRecs, worktimeOptions)
+      monthlyContent += `===== ${k} =====\n`
+      monthlyContent += `${renderOvertimeText(s)}\n\n`
+      // Also write a single file per month under 'month/' folder
+      try {
+        const perMonthFileName = `month/overtime_${outBase}_${k}.txt`
+        // const perMonthFile = outFile(perMonthFileName, outDir)
+        // writeTextFile(perMonthFile, renderOvertimeText(s))
+        writeTxtFile(baseDir, perMonthFileName, renderOvertimeText(s))
+        logger.info(`Overtime 月度(${k}) 已导出: ${perMonthFileName}`)
+        // per-period CSV / Tab format (按需生成)
+        if (perPeriodFormats.includes('csv')) {
+          try {
+            const perMonthCsvName = `month/overtime_${outBase}_${k}.csv`
+            // writeTextFile(
+            //   outFile(perMonthCsvName, outDir),
+            //   renderOvertimeCsv(s)
+            // )
+            writeTxtFile(baseDir, perMonthCsvName, renderOvertimeCsv(s))
+
+            logger.info(`Overtime 月度(CSV)(${k}) 已导出: ${perMonthCsvName}`)
+          } catch (err) {
+            console.warn(
+              `Write monthly CSV for ${k} failed:`,
+              err && err.message ? err.message : err
+            )
+          }
+        }
+        if (perPeriodFormats.includes('tab')) {
+          try {
+            const perMonthTabName = `month/overtime_${outBase}_${k}.tab.txt`
+            // writeTextFile(
+            //   outFile(perMonthTabName, outDir),
+            //   renderOvertimeTab(s)
+            // )
+            writeTxtFile(baseDir, perMonthTabName, renderOvertimeTab(s))
+
+            logger.info(`Overtime 月度(Tab)(${k}) 已导出: ${perMonthTabName}`)
+          } catch (err) {
+            console.warn(
+              `Write monthly Tab for ${k} failed:`,
+              err && err.message ? err.message : err
+            )
+          }
+        }
+      } catch (err) {
+        console.warn(
+          `Write monthly file for ${k} failed:`,
+          err && err.message ? err.message : err
+        )
+      }
+    })
+    if (!opts.perPeriodOnly) {
+      // writeTextFile(monthlyFile, monthlyContent)
+      writeTxtFile(baseDir, monthlyFileName, monthlyContent)
+      logger.info(`Overtime 月度汇总 已导出: ${monthlyFileName}`)
+    }
+    // per-period Excel (sheets or files)
+    if (perPeriodFormats.includes('xlsx')) {
+      const perPeriodExcelMode = String(opts.perPeriodExcelMode || 'sheets')
+      if (perPeriodExcelMode === 'sheets') {
+        try {
+          const monthXlsxName = `overtime_${outBase}_monthly.xlsx`
+          const monthXlsxFile = outFile(baseDir, monthXlsxName)
+          await exportExcelPerPeriodSheets(monthGroups, monthXlsxFile, {
+            stats: opts.stats,
+            gerrit: opts.gerrit
+          })
+          logger.info(`Overtime 月度(XLSX) 已导出: ${monthXlsxFile}`)
+        } catch (err) {
+          console.warn(
+            'Export month XLSX (sheets) failed:',
+            err && err.message ? err.message : err
+          )
+        }
+      } else {
+        try {
+          const monthKeys2 = Object.keys(monthGroups).sort()
+          const tasks = monthKeys2.map((k2) => {
+            const perMonthXlsxName = `overtime_${outBase}_${k2}.xlsx`
+            const perMonthXlsxFile = outFile(baseDir, perMonthXlsxName)
+            return exportExcel(monthGroups[k2], null, {
+              file: perMonthXlsxFile,
+              stats: opts.stats,
+              gerrit: opts.gerrit
+            }).then(() =>
+              console.log(
+                chalk.green(
+                  `Overtime 月度(XLSX)(${k2}) 已导出: ${perMonthXlsxFile}`
+                )
+              )
+            )
+          })
+          await Promise.all(tasks)
+        } catch (err) {
+          console.warn(
+            'Export monthly XLSX files failed:',
+            err && err.message ? err.message : err
+          )
+        }
+      }
+    }
+  } catch (err) {
+    console.warn(
+      'Generate monthly overtime failed:',
+      err && err.message ? err.message : err
+    )
+  }
+}

package/src/domain/export/exportByWeek.mjs

@@ -0,0 +1,121 @@
+import path from 'path'
+
+import { EXPORT_DIR_WEEK } from '#src/constants/index.mjs'
+import {
+  renderOvertimeCsv,
+  renderOvertimeTab,
+  renderOvertimeText
+} from '#src/domain/overtime/overtime.mjs'
+import {
+  exportExcel,
+  exportExcelAuthorChangeStats,
+  exportExcelPerPeriodFiles,
+  exportExcelPerPeriodSheets
+} from '#src/output/excel.mjs'
+import { writeJsonFile, writeTxtFile } from '#src/output/utils/index.mjs'
+import { outFile } from '#src/output/utils/outputPath.mjs'
+import { groupRecords } from '#utils/groupRecords.mjs'
+import { logger } from '#utils/logger.mjs'
+
+import { getWorkOvertimeStats } from '../overtime/analyze.mjs'
+
+/**
+ * @function handleExportByWeek
+ * @description 按周导出
+ * @param {type}
+ * @returns {type}
+ */
+export const handleExportByWeek = async ({
+  opts,
+  records,
+  worktimeOptions
+}) => {
+  // Always write human readable overtime text to file (default: overtime.txt)
+  const outBase = opts.output.out || 'commits'
+  const config = { dir: opts.output.dir || path.resolve('output-wukong') }
+  const baseDir = `${config.dir}/${EXPORT_DIR_WEEK}`
+
+
+
+  try {
+    const weekGroups = groupRecords(records, 'week')
+    const weeklyFileName = `overtime_${outBase}_weekly.txt`
+    // const weeklyFile = outputFilePath(weeklyFileName, outDir)
+    let weeklyContent = ''
+    const weekKeys = Object.keys(weekGroups).sort()
+    weekKeys.forEach((k) => {
+      const groupRecs = weekGroups[k]
+      const s = getWorkOvertimeStats(groupRecs, worktimeOptions)
+      weeklyContent += `===== ${k} =====\n`
+      weeklyContent += `${renderOvertimeText(s)}\n\n`
+      try {
+        const perWeekFileName = `week/overtime_${outBase}_${k}.txt`
+        // const perWeekFile = outputFilePath(perWeekFileName, outDir)
+        // writeTextFile(perWeekFile, renderOvertimeText(s))
+        writeTxtFile(baseDir, perWeekFileName, renderOvertimeText(s))
+
+        // console.log(chalk.green(`Overtime 周度(${k}) 已导出: ${perWeekFile}`))
+        logger.info(`Overtime 周度(${k}) 已导出: ${perWeekFileName}`)
+
+        // eslint-disable-next-line no-shadow
+        const perPeriodFormats = String(opts.perPeriodFormats || '')
+          .split(',')
+          // eslint-disable-next-line no-shadow
+          .map((s) =>
+            String(s || '')
+              .trim()
+              .toLowerCase()
+          )
+          .filter(Boolean)
+        if (perPeriodFormats.includes('csv')) {
+          try {
+            const perWeekCsvName = `week/overtime_${outBase}_${k}.csv`
+            // writeTextFile(
+            //   outputFilePath(perWeekCsvName, outDir),
+            //   renderOvertimeCsv(s)
+            // )
+            writeTxtFile(baseDir, perWeekCsvName, renderOvertimeCsv(s))
+
+            logger.info(`Overtime 周度(CSV)(${k}) 已导出: ${perWeekCsvName}`)
+          } catch (err) {
+            console.warn(
+              `Write weekly CSV for ${k} failed:`,
+              err && err.message ? err.message : err
+            )
+          }
+        }
+        if (perPeriodFormats.includes('tab')) {
+          try {
+            const perWeekTabName = `week/overtime_${outBase}_${k}.tab.txt`
+            // writeTextFile(
+            //   outputFilePath(perWeekTabName, outDir),
+            //   renderOvertimeTab(s)
+            // )
+            writeTxtFile(baseDir, perWeekTabName, renderOvertimeTab(s))
+
+            logger.info(`Overtime 周度(Tab)(${k}) 已导出: ${perWeekTabName}`)
+          } catch (err) {
+            console.warn(
+              `Write weekly Tab for ${k} failed:`,
+              err && err.message ? err.message : err
+            )
+          }
+        }
+      } catch (err) {
+        console.warn(
+          `Write weekly file for ${k} failed:`,
+          err && err.message ? err.message : err
+        )
+      }
+    })
+    // writeTextFile(weeklyFile, weeklyContent)
+    writeTxtFile(baseDir, weeklyFileName, weeklyContent)
+
+    logger.info(`Overtime 周度汇总 已导出: ${weeklyFileName}`)
+  } catch (err) {
+    console.warn(
+      'Generate weekly overtime failed:',
+      err && err.message ? err.message : err
+    )
+  }
+}

package/src/domain/export/exportCommits.mjs

@@ -0,0 +1,26 @@
+import path from 'path'
+
+import { EXPORT_DIR } from '#src/constants/index.mjs'
+import { renderText } from '#src/output/text.mjs'
+import { writeTxtFile } from '#src/output/utils/index.mjs'
+
+/**
+ * @function handleExportCommits
+ * @description 按周导出
+ * @param {type}
+ * @returns {type}
+ */
+export const handleExportCommits = async ({ opts, records, fileName }) => {
+  const config = { dir: opts.output.dir || path.resolve('output-wukong') }
+  const baseDir = `${config.dir}/${EXPORT_DIR}`
+
+  try {
+    const commitFileName = fileName || `commits.txt`
+    writeTxtFile(baseDir, commitFileName, renderText(records))
+  } catch (err) {
+    console.warn(
+      'handleExportCommits failed:',
+      err && err.message ? err.message : err
+    )
+  }
+}

package/src/domain/export/exportCommitsExcel.mjs

@@ -0,0 +1,45 @@
+import path from 'path'
+
+import { EXPORT_DIR } from '#src/constants/index.mjs'
+import {
+  exportExcel,
+  exportExcelAuthorChangeStats,
+  exportExcelPerPeriodFiles,
+  exportExcelPerPeriodSheets
+} from '#src/output/excel.mjs'
+import { renderText } from '#src/output/text.mjs'
+import { writeTxtFile } from '#src/output/utils/index.mjs'
+import { outFile } from '#src/output/utils/outputPath.mjs'
+
+/**
+ * @function handleExportCommitsExcel
+ * @description 按周导出
+ * @param {type}
+ * @returns {type}
+ */
+export const handleExportCommitsExcel = async ({
+  opts,
+  records,
+  fileName,
+  groups
+}) => {
+  const config = { dir: opts.output.dir || path.resolve('output-wukong') }
+  const baseDir = `${config.dir}/${EXPORT_DIR}`
+
+  try {
+    const excelFile = fileName || 'commits.xlsx'
+
+    const excelPath = outFile(baseDir, excelFile)
+
+    await exportExcel(records, groups, {
+      file: excelPath,
+      stats: opts.stats,
+      gerrit: opts.gerrit
+    })
+  } catch (err) {
+    console.warn(
+      'handleExportCommitsExcel failed:',
+      err && err.message ? err.message : err
+    )
+  }
+}

package/src/domain/export/exportCommitsJson.mjs

@@ -0,0 +1,31 @@
+import path from 'path'
+
+import { EXPORT_DIR } from '#src/constants/index.mjs'
+import { renderText } from '#src/output/text.mjs'
+import { writeJsonFile } from '#src/output/utils/index.mjs'
+
+/**
+ * @function handleExportCommitsJson
+ * @description 按周导出
+ * @param {type}
+ * @returns {type}
+ */
+export const handleExportCommitsJson = async ({
+  opts,
+  records,
+  fileName,
+  groups
+}) => {
+  const config = { dir: opts.output.dir || path.resolve('output-wukong') }
+  const baseDir = `${config.dir}/${EXPORT_DIR}`
+
+  try {
+    const commitFileName = fileName || `commits.json`
+    writeJsonFile(baseDir, commitFileName, groups || records)
+  } catch (err) {
+    console.warn(
+      'handleExportCommitsJson failed:',
+      err && err.message ? err.message : err
+    )
+  }
+}

package/src/domain/export/index.mjs

@@ -0,0 +1,91 @@
+import path from 'path'
+
+import { EXPORT_DIR } from '#src/constants/index.mjs'
+import { writeJsonFile, writeTxtFile } from '#src/output/utils/index.mjs'
+import { logger } from '#utils/logger.mjs'
+
+/**
+ * @handleExport
+ * @description
+ * @param {type} param - suffix: json,txt,csv
+ * @returns {type}
+ */
+export const handleExport = ({
+  fileName,
+  suffix,
+  opts,
+  result,
+  msg = '已导出'
+}) => {
+  const config = { dir: opts.output.dir || path.resolve('output-wukong') }
+  const baseDir = `${config.dir}/${EXPORT_DIR}`
+  if (suffix === 'json') {
+    writeJsonFile(baseDir, fileName, result)
+  } else {
+    writeTxtFile(baseDir, fileName, result)
+  }
+
+  const file = `${baseDir}/${fileName}`
+  logger.success(`${fileName}`, file, msg)
+}
+
+export const handleExportOvertimeMain = ({
+  fileName,
+  suffix = 'json',
+  opts,
+  result
+}) => {
+  handleExport({
+    fileName,
+    suffix,
+    opts,
+    result,
+    msg: 'overtime JSON 已导出'
+  })
+}
+
+export const handleExportOvertimeTxt = ({
+  fileName,
+  suffix = 'txt',
+  opts,
+  result
+}) => {
+  handleExport({
+    fileName,
+    suffix,
+    opts,
+    result,
+    msg: '已导出(Overtime text)'
+  })
+}
+
+export const handleExportOvertimeTabTxt = ({
+  fileName,
+  suffix = 'txt',
+  opts,
+  result
+}) => {
+  handleExport({
+    fileName,
+    suffix,
+    opts,
+    result,
+    msg: '已导出(Overtime table (tabs))'
+  })
+}
+
+export const handleExportOvertimeCsv = ({
+  fileName,
+  suffix = 'csv',
+  opts,
+  result
+}) => {
+  handleExport({
+    fileName,
+    suffix,
+    opts,
+    result,
+    msg: '已导出(Overtime CSV )'
+  })
+}
+

package/src/domain/git/ensureGitAvailable.mjs

@@ -0,0 +1,66 @@
+/**
+ * CLI 启动时检测 git 是否可用
+ *
+ * - 不使用 shell
+ * - 不触发 WSL
+ * - Windows / macOS / Linux 通用
+ */
+import { execFile } from 'node:child_process'
+import { promisify } from 'node:util'
+
+const execFileAsync = promisify(execFile)
+
+export async function ensureGitAvailable() {
+  try {
+    const { stdout } = await execFileAsync('git', ['--version'], {
+      windowsHide: true,
+      timeout: 5000,
+      maxBuffer: 1024 * 1024
+    })
+
+    // 示例输出：git version 2.45.1.windows.1
+    if (!stdout || !stdout.toLowerCase().includes('git version')) {
+      throw new Error(`Unexpected git output: ${stdout}`)
+    }
+
+    return stdout.trim()
+  } catch (err) {
+    /**
+     * 统一抛出人类可读错误
+     */
+    const { platform } = process
+
+    let hint = ''
+
+    if (platform === 'win32') {
+      hint = `
+请确认：
+1️⃣ 已安装 Git for Windows
+   https://git-scm.com/download/win
+
+2️⃣ 安装时勾选：
+   ✔ "Add Git to PATH"
+
+3️⃣ 关闭并重新打开终端后再试
+`
+    } else if (platform === 'darwin') {
+      hint = `
+可通过以下方式安装 git：
+  xcode-select --install
+或
+  brew install git
+`
+    } else {
+      hint = `
+请使用系统包管理器安装 git，例如：
+  apt install git
+  yum install git
+`
+    }
+
+    const error = new Error(`❌ Git 不可用，CLI 无法继续运行\n\n${hint}`)
+
+    error.cause = err
+    throw error
+  }
+}

package/src/domain/git/ensureGitRepo.mjs

@@ -0,0 +1,41 @@
+/**
+ * 确保当前目录在 git 仓库内
+ */
+import chalk from 'chalk'
+
+import { execFile } from 'node:child_process'
+import { promisify } from 'node:util'
+import { getGitCapability } from './gitCapability.mjs'
+
+const execFileAsync = promisify(execFile)
+
+/**
+ * @returns {Promise<boolean>}
+ */
+export async function ensureGitRepo() {
+  await getGitCapability()
+
+  try {
+    const { stdout } = await execFileAsync(
+      'git',
+      ['rev-parse', '--is-inside-work-tree'],
+      {
+        windowsHide: true,
+        timeout: 5000,
+        maxBuffer: 1024 * 1024
+      }
+    )
+
+    if (stdout.trim() !== 'true') {
+      throw new Error('Not a git repository')
+    }
+
+    return true
+  } catch {
+    // throw new Error(
+    //   `❌ 当前目录不是 Git 仓库\n\n请在 Git 项目根目录下运行该命令`
+    // )
+    console.log(`${chalk.red("❌")} 当前目录不是 Git 仓库\n\n请在 Git 项目根目录下运行该命令`)
+    process.exit(1)
+  }
+}