@hecom/codearts 0.2.1 → 0.2.3

package/README.md

@@ -24,14 +24,24 @@ npx @hecom/codearts daily
 # 生成当年工时统计
 npx @hecom/codearts work-hour
 
+# 按迭代统计产品缺陷率
+npx @hecom/codearts bug-rate "迭代1,迭代2"
+```
+
+### 3. 更新配置
+
+```bash
 # 更新全局配置
 npx @hecom/codearts config
 
 # 单独更新角色配置
 npx @hecom/codearts config role-id
+
+# 查看当前配置
+npx @hecom/codearts config show
 ```
 
-### 3. 升级
+### 4. 升级
 
 ```bash
 # 更新最新版本
@@ -56,13 +66,15 @@ npm install
 
 ### 本地运行
 
+> 本地运行命令时，注意使用 `--` 分隔 npm 参数和 CLI 参数，否则 CLI 参数可能无法正确传递。
+
 ```bash
 # 运行命令
 npm run dev
 
-npm run dev daily
+npm run dev -- daily
 
-npm run dev work-hour
+npm run dev -- work-hour
 ```
 
 ### 本地链接 CLI 工具
@@ -79,10 +91,10 @@ codearts --help
 | --------------------------- | ---------------------------------- | ---- |
 | `HUAWEI_CLOUD_IAM_ENDPOINT` | IAM 认证端点                       | 是   |
 | `HUAWEI_CLOUD_REGION`       | 华为云区域                         | 是   |
+| `CODEARTS_BASE_URL`         | CodeArts API 地址                  | 是   |
+| `HUAWEI_CLOUD_DOMAIN`       | 华为云账号名                       | 是   |
 | `HUAWEI_CLOUD_USERNAME`     | IAM 用户名                         | 是   |
 | `HUAWEI_CLOUD_PASSWORD`     | IAM 密码                           | 是   |
-| `HUAWEI_CLOUD_DOMAIN`       | 华为云账号名                       | 是   |
-| `CODEARTS_BASE_URL`         | CodeArts API 地址                  | 是   |
 | `PROJECT_ID`                | 项目 ID                            | 是   |
 | `ROLE_ID`                   | 角色 ID（支持逗号分隔，如: 1,2,3） | 是   |
 

package/dist/bin/cli.js

@@ -41,7 +41,9 @@ const bug_command_1 = require("../commands/bug.command");
 const config_command_1 = require("../commands/config.command");
 const daily_command_1 = require("../commands/daily.command");
 const work_hour_command_1 = require("../commands/work-hour.command");
+const constant_1 = require("../constant");
 const config_loader_1 = require("../utils/config-loader");
+const logger_1 = require("../utils/logger");
 // 读取 package.json 中的版本号
 const packageJsonPath = path.join(__dirname, '../../package.json');
 const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
@@ -49,12 +51,15 @@ const version = packageJson.version;
 const program = new commander_1.Command();
 program.name('codearts').description('华为云 CodeArts 统计分析工具').version(version);
 // 全局选项（环境变量覆盖）
-program.option('--role-id <ids>', '角色 ID（支持逗号分隔，如: 1,2,3），优先级高于环境变量 ROLE_ID');
+program
+    .option('--role-id <ids>', '角色 ID（支持逗号分隔，如: 1,2）')
+    .option('--output <format>', '输出格式：console、csv、json', 'console');
 // config 命令 - 交互式配置向导
 const configCmd = program
     .command('config')
-    .description('交互式配置向导，引导用户创建或更新全局配置文件\n\n')
+    .description('交互式配置向导，引导用户创建或更新全局配置文件')
     .action(async () => {
+    (0, constant_1.showLogo)();
     await (0, config_command_1.configCommand)();
 });
 // config show 子命令 - 显示当前配置
@@ -62,6 +67,7 @@ configCmd
     .command('show')
     .description('显示当前配置信息')
     .action(async () => {
+    (0, constant_1.showLogo)();
     await (0, config_command_1.showConfigCommand)();
 });
 // 为每个项目配置项添加子命令
@@ -72,43 +78,49 @@ availableConfigs.forEach((configItem) => {
         .command(subCommandName)
         .description(`更新${configItem.label}`)
         .action(async () => {
+        (0, constant_1.showLogo)();
         await (0, config_command_1.updateProjectConfigCommand)(configItem.key);
     });
 });
 // daily 命令
 program
     .command('daily [date]')
-    .description('生成日报统计')
-    .action(async (date) => {
-    const opts = program.opts();
-    await (0, daily_command_1.dailyCommand)(date, opts);
+    .description('每日工时统计（默认日期为当天）')
+    .option('-r, --report', '显示总结报告', false)
+    .action(async (date, options, command) => {
+    const cliOptions = { ...command.parent.opts(), report: options.report };
+    logger_1.logger.setOutputFormat(cliOptions.output);
+    await (0, daily_command_1.dailyCommand)(date, cliOptions);
 });
 // work-hour 命令
 program
     .command('work-hour [year]')
-    .description('生成年度工时统计')
-    .action(async (year) => {
-    const opts = program.opts();
-    await (0, work_hour_command_1.workHourCommand)(year, opts);
+    .description('年度工时统计（默认当前年份）')
+    .action(async (year, options, command) => {
+    const cliOptions = command.parent.opts();
+    logger_1.logger.setOutputFormat(cliOptions.output);
+    await (0, work_hour_command_1.workHourCommand)(year, cliOptions);
 });
 // bug-rate 命令
 program
     .command('bug-rate <iterations>')
-    .description('按迭代统计产品缺陷率，支持多个迭代（逗号分隔）')
-    .action(async (iterations) => {
-    const opts = program.opts();
-    await (0, bug_command_1.bugCommand)(iterations, opts);
+    .description('产品缺陷率统计，支持多个迭代')
+    .action(async (iterations, options, command) => {
+    const cliOptions = command.parent.opts();
+    logger_1.logger.setOutputFormat(cliOptions.output);
+    await (0, bug_command_1.bugCommand)(iterations, cliOptions);
 });
 // 检查配置并自动执行 config 命令
 async function checkConfigAndRun() {
     const args = process.argv.slice(2);
     // 如果没有参数（直接执行 codearts），检测配置
     if (args.length === 0) {
+        (0, constant_1.showLogo)();
         // 检查是否有全局配置
-        const hasGlobalConfig = (0, config_loader_1.globalConfigExists)();
-        if (!hasGlobalConfig) {
+        const hasConfig = (0, config_loader_1.configExists)();
+        if (!hasConfig) {
             // 没有配置，自动执行 config 命令
-            console.log('未检测到配置文件，启动配置向导...\n');
+            logger_1.logger.info('未检测到配置文件，启动配置向导...\n');
             await (0, config_command_1.configCommand)();
             return;
         }
@@ -118,7 +130,17 @@ async function checkConfigAndRun() {
     // 有参数，正常解析命令
     program.parse();
 }
+process.on('uncaughtException', (error) => {
+    if (error instanceof Error && error.name === 'ExitPromptError') {
+        console.log('👋 操作取消!');
+        process.exit(0);
+    }
+    else {
+        // 重新抛出未知错误
+        throw error;
+    }
+});
 checkConfigAndRun().catch((error) => {
-    console.error('执行失败:', error);
+    logger_1.logger.error('执行失败: ', error);
     process.exit(1);
 });

package/dist/commands/bug.command.d.ts

@@ -1,7 +1,5 @@
 import { CliOptions } from '../utils/config-loader';
 /**
  * bug 命令入口
- * @param iterationTitlesStr 迭代标题（支持逗号、分号、空格、竖线、顿号等分隔符）
- * @param cliOptions CLI 选项
  */
 export declare function bugCommand(iterationTitlesStr: string, cliOptions?: CliOptions): Promise<void>;

package/dist/commands/bug.command.js

@@ -4,13 +4,12 @@ exports.bugCommand = bugCommand;
 const business_service_1 = require("../services/business.service");
 const types_1 = require("../types");
 const config_loader_1 = require("../utils/config-loader");
+const csv_writer_1 = require("../utils/csv-writer");
+const logger_1 = require("../utils/logger");
 /**
  * 判断 Bug 是否属于需求变更或产品设计问题
- * @param bug Bug 工作项
- * @returns 是否属于需求变更或产品设计问题
  */
 function isRequirementOrDesignBug(bug) {
-    // 检查 customValueNew（v2 版本的自定义字段，是对象格式）
     const defectAnalysisValue = bug.customValueNew?.custom_field32;
     if (defectAnalysisValue) {
         return (defectAnalysisValue === types_1.DefectAnalysisType.REQUIREMENT_CHANGE ||
@@ -19,32 +18,35 @@ function isRequirementOrDesignBug(bug) {
     return false;
 }
 /**
- * 生成 Bug 统计报告
+ * 查询 Bug 统计数据
  */
-async function generateBugReport(businessService, projectId, roleIds, iterationTitles) {
-    console.log(`\n正在统计迭代中的 Bug 数据...`);
-    console.log(`目标迭代: ${iterationTitles.join(', ')}`);
-    console.log(`角色过滤: ${roleIds.length > 0 ? roleIds.join(', ') : '无（保留所有人）'}`);
-    console.log(`统计规则: 统计所有 Bug，同时标记"需求变更问题"和"产品设计问题"`);
-    // Step 1: 获取指定角色的成员列表（如果启用了角色过滤）
+async function queryBugReportData(businessService, projectId, roleIds, iterationTitles) {
+    const roleNames = new Set();
     const targetMemberIds = new Set();
     if (roleIds.length > 0) {
         for (const roleId of roleIds) {
             const members = await businessService.getMembersByRoleId(projectId, roleId);
-            members.forEach((member) => targetMemberIds.add(member.user_num_id));
+            members.forEach((member) => {
+                targetMemberIds.add(member.user_num_id);
+                roleNames.add(member.role_name);
+            });
         }
-        console.log(`\n目标角色成员数: ${targetMemberIds.size} 人`);
-    }
-    else {
-        console.log(`\n角色过滤: 已禁用，将统计所有人`);
     }
-    // Step 2: 获取所有 Story
     const stories = await businessService.getStoriesByIterationTitles(projectId, iterationTitles);
     if (stories.length === 0) {
-        console.log('未找到任何 Story');
-        return;
+        return {
+            iterations: iterationTitles,
+            roleIds,
+            roleNames: Array.from(roleNames),
+            userStats: [],
+            summary: {
+                totalBugs: 0,
+                totalProductBugs: 0,
+                overallProductDefectRate: 0,
+                userCount: 0,
+            },
+        };
     }
-    // Step 3: 过滤出目标角色成员处理的 Story（如果启用了角色过滤）
     const filteredStories = roleIds.length > 0
         ? stories.filter((story) => {
             const assignedUserId = story.assigned_user?.id;
@@ -52,27 +54,27 @@ async function generateBugReport(businessService, projectId, roleIds, iterationT
         })
         : stories;
     if (filteredStories.length === 0) {
-        console.log(roleIds.length > 0 ? '未找到目标角色成员处理的 Story' : '未找到任何 Story');
-        return;
-    }
-    if (roleIds.length > 0) {
-        console.log(`\n找到 ${stories.length} 个 Story，其中 ${filteredStories.length} 个由目标角色成员处理，正在统计 Bug...`);
+        return {
+            iterations: iterationTitles,
+            roleIds,
+            roleNames: Array.from(roleNames),
+            userStats: [],
+            summary: {
+                totalBugs: 0,
+                totalProductBugs: 0,
+                overallProductDefectRate: 0,
+                userCount: 0,
+            },
+        };
     }
-    else {
-        console.log(`\n找到 ${filteredStories.length} 个 Story，正在统计 Bug...`);
-    }
-    // Step 4: 获取每个 Story 的子工作项（Bug）
     const bugStatsMap = new Map();
     for (const story of filteredStories) {
         const childIssues = await businessService.getChildIssues(projectId, String(story.id));
-        // 过滤出所有 Bug 类型的子工作项（tracker_id = 3）
         const allBugs = childIssues.filter((issue) => issue.tracker.id === 3);
         if (allBugs.length === 0) {
             continue;
         }
-        // 统计产品问题 Bug（需求变更 + 产品设计）
         const productBugs = allBugs.filter((bug) => isRequirementOrDesignBug(bug));
-        // Step 3: 按 Story 的处理人统计 Bug
         const assignedUserId = story.assigned_user?.id;
         const assignedUserName = story.assigned_user?.nick_name;
         if (!assignedUserId) {
@@ -98,61 +100,103 @@ async function generateBugReport(businessService, projectId, roleIds, iterationT
             productBugCount: productBugs.length,
         });
     }
-    // 计算每个人的产品缺陷率
     bugStatsMap.forEach((stats) => {
         stats.productDefectRate =
-            stats.totalBugCount > 0 ? (stats.productBugCount / stats.totalBugCount) * 100 : 0;
+            stats.totalBugCount > 0
+                ? Math.round((stats.productBugCount / stats.totalBugCount) * 100 * 100) / 100
+                : 0;
     });
-    // Step 4: 输出统计结果
-    console.log('\n');
-    console.log('='.repeat(80));
-    console.log(`Bug 统计报告 [${iterationTitles.join(', ')}]`);
-    console.log('='.repeat(80));
-    console.log('');
-    if (bugStatsMap.size === 0) {
-        console.log('未找到任何 Bug');
-        return;
-    }
-    // 按总 Bug 数量降序排列
     const sortedStats = Array.from(bugStatsMap.values()).sort((a, b) => b.totalBugCount - a.totalBugCount);
     let totalBugs = 0;
     let totalProductBugs = 0;
     sortedStats.forEach((stats) => {
-        console.log(`\x1b[31m${stats.assignedUser}: 总 Bug ${stats.totalBugCount} 个 | 产品问题 ${stats.productBugCount} 个 | 产品缺陷率 ${stats.productDefectRate.toFixed(1)}%\x1b[0m`);
-        // 输出该用户的 Story 及其 Bug 数量
-        stats.stories.forEach((story) => {
-            console.log(`  - ${story.storyName} (总 ${story.totalBugCount} 个 Bug，其中产品问题 ${story.productBugCount} 个)`);
-        });
         totalBugs += stats.totalBugCount;
         totalProductBugs += stats.productBugCount;
-        console.log('');
     });
-    const overallProductDefectRate = totalBugs > 0 ? (totalProductBugs / totalBugs) * 100 : 0;
-    console.log('='.repeat(80));
-    console.log(`总计: ${totalBugs} 个 Bug（产品问题 ${totalProductBugs} 个，产品缺陷率 ${overallProductDefectRate.toFixed(1)}%），涉及 ${sortedStats.length} 位处理人`);
-    console.log('='.repeat(80));
+    const overallProductDefectRate = totalBugs > 0 ? Math.round((totalProductBugs / totalBugs) * 100 * 100) / 100 : 0;
+    return {
+        iterations: iterationTitles,
+        roleIds,
+        roleNames: Array.from(roleNames),
+        userStats: sortedStats,
+        summary: {
+            totalBugs,
+            totalProductBugs,
+            overallProductDefectRate,
+            userCount: sortedStats.length,
+        },
+    };
+}
+/**
+ * 控制台输出产品缺陷率统计
+ */
+function outputConsole(data) {
+    logger_1.logger.info(`产品缺陷率统计 [${data.roleNames.join(', ')}]`);
+    logger_1.logger.info('='.repeat(80));
+    logger_1.logger.info(`产品缺陷率: ${data.summary.overallProductDefectRate.toFixed(2)}% `);
+    logger_1.logger.info(`总 Bug 数: ${data.summary.totalBugs}个`);
+    logger_1.logger.info(`产品问题: ${data.summary.totalProductBugs}个`);
+    logger_1.logger.info(`统计人数: ${data.summary.userCount}人`);
+    logger_1.logger.info(`统计迭代: ${data.iterations.join(', ')}`);
+    logger_1.logger.info('='.repeat(80));
+    data.userStats.forEach((stats) => {
+        logger_1.logger.info(`\x1b[31m${stats.assignedUser}: ${stats.productDefectRate.toFixed(2)}% (${stats.productBugCount}/${stats.totalBugCount})\x1b[0m`);
+        stats.stories.forEach((story) => {
+            logger_1.logger.info(`  ${story.storyName} (${story.productBugCount}/${story.totalBugCount})`);
+        });
+        logger_1.logger.info('');
+    });
+}
+/**
+ * CSV 文件输出
+ */
+function outputCsv(data, iterationTitles) {
+    const csvLines = [];
+    csvLines.push('迭代,处理人,Story名称,StoryID,总Bug数,产品问题Bug数,产品缺陷率');
+    data.userStats.forEach((userStat) => {
+        userStat.stories.forEach((story) => {
+            const defectRate = story.totalBugCount > 0
+                ? ((story.productBugCount / story.totalBugCount) * 100).toFixed(2)
+                : '0.00';
+            csvLines.push(`"${(0, csv_writer_1.escapeCsv)(data.iterations.join(', '))}",${userStat.assignedUser ?? ''},"${(0, csv_writer_1.escapeCsv)(story.storyName ?? '')}",${story.storyId ?? ''},${story.totalBugCount ?? ''},${story.productBugCount ?? ''},${defectRate}%`);
+        });
+    });
+    const filename = `bug-rate-${iterationTitles.join('-')}.csv`;
+    (0, csv_writer_1.writeCsvFile)(filename, csvLines, logger_1.logger);
+}
+/**
+ * JSON 输出（直接打印到控制台，供编程调用）
+ */
+function outputJson(data) {
+    logger_1.logger.json(data);
 }
 /**
  * bug 命令入口
- * @param iterationTitlesStr 迭代标题（支持逗号、分号、空格、竖线、顿号等分隔符）
- * @param cliOptions CLI 选项
  */
 async function bugCommand(iterationTitlesStr, cliOptions = {}) {
     try {
         if (!iterationTitlesStr || iterationTitlesStr.trim() === '') {
             throw new Error('请指定至少一个迭代标题');
         }
-        // 解析迭代标题（支持多种分隔符：逗号、分号、空格、竖线、顿号等）
         const iterationTitles = iterationTitlesStr
             .split(/[,，;；|\s、]+/)
             .map((title) => title.trim())
             .filter((title) => title.length > 0);
-        const { projectId, roleIds, config } = (0, config_loader_1.loadConfig)(cliOptions);
+        const { projectId, roleIds, config, outputFormat } = (0, config_loader_1.loadConfig)(cliOptions);
         const businessService = new business_service_1.BusinessService(config);
-        await generateBugReport(businessService, projectId, roleIds, iterationTitles);
+        const reportData = await queryBugReportData(businessService, projectId, roleIds, iterationTitles);
+        if (outputFormat === 'console') {
+            outputConsole(reportData);
+        }
+        else if (outputFormat === 'csv') {
+            outputCsv(reportData, iterationTitles);
+        }
+        else if (outputFormat === 'json') {
+            outputJson(reportData);
+        }
     }
     catch (error) {
-        console.error('执行过程中发生错误:', error);
+        logger_1.logger.error(`执行过程中发生错误: `, error);
         process.exit(1);
     }
 }