auto-cr-cmd 2.0.27 → 2.0.29

package/README.md

@@ -42,15 +42,70 @@ Common flags:
 
 - `--language <zh|en>`: Switch CLI output language (defaults to auto-detection).
 - `--rule-dir <directory>`: Load additional custom rules from a directory or package.
+- `--output <text|json>`: Choose between human-friendly text logs or structured JSON results (defaults to `text`).
 - `--help`: Display the full command reference.
 
 Sample output:
 
 ```text
-ℹ️ Scanning directory: ./src
-ℹ️ Scanning file: ./src/main.ts
-ℹ️ [Base Rules]
-✔ auto-cr scan complete
+ WARN  [12:56:18] ⚠️ [Base Rules]: no-deep-relative-imports
+
+    File: /Volumes/Wei/Codes/github/auto-cr/examples/src/app/features/admin/pages/dashboard.ts:2 
+    Description: Import path "../../../../shared/deep/utils" must not exceed max depth 2 
+    Code: ../../../../shared/deep/utils
+    Suggestion: Use a path alias (for example: @shared/deep/utils). | Create an index file at a higher level to re-export the module and shorten the import.
+
+ WARN  [12:56:18] ⚠️ [untagged]: no-index-import
+
+    File: /Volumes/Wei/Codes/github/auto-cr/examples/src/app/features/admin/pages/dashboard.ts:3
+    Description: Import ../../consts/index is not allowed. Import the concrete file instead.
+
+✔  Code scan complete, scanned 3 files: 0 with errors, 1 with warnings, 0 with optimizing hints! 
+```
+
+JSON output sample:
+
+```bash
+npx auto-cr-cmd --output json -- ./src | jq
+```
+
+```json
+{
+  "summary": {
+    "scannedFiles": 2,
+    "filesWithErrors": 1,
+    "filesWithWarnings": 0,
+    "filesWithOptimizing": 1,
+    "violationTotals": {
+      "total": 3,
+      "error": 2,
+      "warning": 0,
+      "optimizing": 1
+    }
+  },
+  "files": [
+    {
+      "filePath": "/workspace/src/example.ts",
+      "severityCounts": {
+        "error": 2,
+        "warning": 0,
+        "optimizing": 1
+      },
+      "totalViolations": 3,
+      "errorViolations": 2,
+      "violations": [
+        {
+          "tag": "imports",
+          "ruleName": "no-deep-relative-imports",
+          "severity": "error",
+          "message": "Avoid deep relative imports from src/components/button",
+          "line": 13
+        }
+      ]
+    }
+  ],
+  "notifications": []
+}
 ```
 
 ## Writing Custom Rules

package/README.zh-CN.md

@@ -42,15 +42,70 @@ npx auto-cr-cmd --language zh [需要扫描的代码目录]
 
 - `--language <zh|en>`：切换 CLI 输出语言（默认为自动检测）。
 - `--rule-dir <directory>`：加载额外的自定义规则目录或包。
+- `--output <text|json>`：选择输出格式，`text` 为友好的终端日志，`json` 用于集成脚本（默认为 `text`）。
 - `--help`：查看完整命令说明。
 
 示例输出：
 
 ```text
-ℹ️ 扫描目录: ./src
-ℹ️ 扫描文件: ./src/main.ts
-ℹ️ [基础规则]   
-✔ auto-cr 代码扫描完成
+ WARN  [12:52:48] ⚠️ [基础规则]：no-deep-relative-imports 
+  
+    文件位置: .../dashboard.ts:2
+    错误描述: 导入路径 "../../../../shared/deep/utils"，不能超过最大层级2
+    错误代码: ../../../../shared/deep/utils
+    优化建议: 使用别名路径（如 @shared/deep/utils）； 或在上层聚合导出，避免过深相对路径。
+
+ WARN  [12:52:48] ⚠️ [未定义]：no-index-import
+
+    文件位置: .../dashboard.ts:3
+    错误描述: 禁止直接导入 ../../consts/index，请改用具体文件
+
+✔  代码扫描完成，本次共扫描3个文件，其中0个文件存在错误，1个文件存在警告，0个文件存在优化建议！
+```
+
+JSON 输出示例：
+
+```bash
+npx auto-cr-cmd --output json -- ./src | jq
+```
+
+```json
+{
+  "summary": {
+    "scannedFiles": 2,
+    "filesWithErrors": 1,
+    "filesWithWarnings": 0,
+    "filesWithOptimizing": 1,
+    "violationTotals": {
+      "total": 3,
+      "error": 2,
+      "warning": 0,
+      "optimizing": 1
+    }
+  },
+  "files": [
+    {
+      "filePath": "/workspace/src/example.ts",
+      "severityCounts": {
+        "error": 2,
+        "warning": 0,
+        "optimizing": 1
+      },
+      "totalViolations": 3,
+      "errorViolations": 2,
+      "violations": [
+        {
+          "tag": "imports",
+          "ruleName": "no-deep-relative-imports",
+          "severity": "error",
+          "message": "避免从 src/components/button 进行深层相对导入",
+          "line": 13
+        }
+      ]
+    }
+  ],
+  "notifications": []
+}
 ```
 
 ## 编写自定义规则

package/dist/index.js

@@ -59,6 +59,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 var consola_1 = require("consola");
 var fs_1 = __importDefault(require("fs"));
@@ -71,25 +72,77 @@ var i18n_1 = require("./i18n");
 var file_1 = require("./utils/file");
 var auto_cr_rules_1 = require("auto-cr-rules");
 var loader_1 = require("./rules/loader");
+consola_1.consola.options.formatOptions = __assign(__assign({}, consola_1.consola.options.formatOptions), { date: false });
+var consolaLoggers = {
+    info: consola_1.consola.info.bind(consola_1.consola),
+    warn: consola_1.consola.warn.bind(consola_1.consola),
+    error: consola_1.consola.error.bind(consola_1.consola),
+};
 function run() {
-    return __awaiter(this, arguments, void 0, function (filePaths, ruleDir) {
-        var t, validPaths, allFiles, _i, validPaths_1, targetPath, stat, directoryFiles, scannableFiles, customRules, rules, filesWithErrors, filesWithWarnings, filesWithOptimizing, _a, scannableFiles_1, file, summary, error_1;
+    return __awaiter(this, arguments, void 0, function (filePaths, ruleDir, format) {
+        var t, notifications, log, validPaths, allFiles, _i, validPaths_1, targetPath, stat, directoryFiles, scannableFiles, customRules, rules, filesWithErrors, filesWithWarnings, filesWithOptimizing, totalViolations, totalErrorViolations, totalWarningViolations, totalOptimizingViolations, fileSummaries, _a, scannableFiles_1, file, summary, error_1;
         if (filePaths === void 0) { filePaths = []; }
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
                     t = (0, i18n_1.getTranslator)();
+                    notifications = [];
+                    log = function (level, message, detail) {
+                        var detailText;
+                        if (detail !== undefined) {
+                            if (detail instanceof Error) {
+                                detailText = detail.message;
+                            }
+                            else if (typeof detail === 'string') {
+                                detailText = detail;
+                            }
+                            else {
+                                try {
+                                    detailText = JSON.stringify(detail);
+                                }
+                                catch (_a) {
+                                    detailText = String(detail);
+                                }
+                            }
+                        }
+                        notifications.push({ level: level, message: message, detail: detailText });
+                        if (format === 'text') {
+                            var logger = consolaLoggers[level];
+                            if (detail === undefined) {
+                                logger(message);
+                            }
+                            else {
+                                logger(message, detail);
+                            }
+                        }
+                    };
                     _b.label = 1;
                 case 1:
                     _b.trys.push([1, 6, , 7]);
                     if (filePaths.length === 0) {
-                        consola_1.consola.info(t.noPathsProvided());
-                        return [2 /*return*/, { scannedFiles: 0, filesWithErrors: 0, filesWithWarnings: 0, filesWithOptimizing: 0 }];
+                        log('info', t.noPathsProvided());
+                        return [2 /*return*/, {
+                                scannedFiles: 0,
+                                filesWithErrors: 0,
+                                filesWithWarnings: 0,
+                                filesWithOptimizing: 0,
+                                violationTotals: { total: 0, error: 0, warning: 0, optimizing: 0 },
+                                files: [],
+                                notifications: notifications,
+                            }];
                     }
                     validPaths = filePaths.filter(function (candidate) { return (0, file_1.checkPathExists)(candidate); });
                     if (validPaths.length === 0) {
-                        consola_1.consola.error(t.allPathsMissing());
-                        return [2 /*return*/, { scannedFiles: 0, filesWithErrors: 0, filesWithWarnings: 0, filesWithOptimizing: 0 }];
+                        log('error', t.allPathsMissing());
+                        return [2 /*return*/, {
+                                scannedFiles: 0,
+                                filesWithErrors: 0,
+                                filesWithWarnings: 0,
+                                filesWithOptimizing: 0,
+                                violationTotals: { total: 0, error: 0, warning: 0, optimizing: 0 },
+                                files: [],
+                                notifications: notifications,
+                            }];
                     }
                     allFiles = [];
                     for (_i = 0, validPaths_1 = validPaths; _i < validPaths_1.length; _i++) {
@@ -104,30 +157,46 @@ function run() {
                         }
                     }
                     if (allFiles.length === 0) {
-                        consola_1.consola.info(t.noFilesFound());
-                        return [2 /*return*/, { scannedFiles: 0, filesWithErrors: 0, filesWithWarnings: 0, filesWithOptimizing: 0 }];
+                        log('info', t.noFilesFound());
+                        return [2 /*return*/, {
+                                scannedFiles: 0,
+                                filesWithErrors: 0,
+                                filesWithWarnings: 0,
+                                filesWithOptimizing: 0,
+                                violationTotals: { total: 0, error: 0, warning: 0, optimizing: 0 },
+                                files: [],
+                                notifications: notifications,
+                            }];
                     }
                     scannableFiles = allFiles.filter(function (candidate) { return !candidate.endsWith('.d.ts'); });
                     customRules = (0, loader_1.loadCustomRules)(ruleDir);
                     rules = __spreadArray(__spreadArray([], auto_cr_rules_1.builtinRules, true), customRules, true);
                     if (rules.length === 0) {
-                        consola_1.consola.warn(t.noRulesLoaded());
+                        log('warn', t.noRulesLoaded());
                         return [2 /*return*/, {
                                 scannedFiles: 0,
                                 filesWithErrors: 0,
                                 filesWithWarnings: 0,
                                 filesWithOptimizing: 0,
+                                violationTotals: { total: 0, error: 0, warning: 0, optimizing: 0 },
+                                files: [],
+                                notifications: notifications,
                             }];
                     }
                     filesWithErrors = 0;
                     filesWithWarnings = 0;
                     filesWithOptimizing = 0;
+                    totalViolations = 0;
+                    totalErrorViolations = 0;
+                    totalWarningViolations = 0;
+                    totalOptimizingViolations = 0;
+                    fileSummaries = [];
                     _a = 0, scannableFiles_1 = scannableFiles;
                     _b.label = 2;
                 case 2:
                     if (!(_a < scannableFiles_1.length)) return [3 /*break*/, 5];
                     file = scannableFiles_1[_a];
-                    return [4 /*yield*/, analyzeFile(file, rules)];
+                    return [4 /*yield*/, analyzeFile(file, rules, format, log)];
                 case 3:
                     summary = _b.sent();
                     if (summary.severityCounts.error > 0) {
@@ -139,6 +208,17 @@ function run() {
                     if (summary.severityCounts.optimizing > 0) {
                         filesWithOptimizing += 1;
                     }
+                    totalViolations += summary.totalViolations;
+                    totalErrorViolations += summary.errorViolations;
+                    totalWarningViolations += summary.severityCounts.warning;
+                    totalOptimizingViolations += summary.severityCounts.optimizing;
+                    fileSummaries.push({
+                        filePath: file,
+                        severityCounts: summary.severityCounts,
+                        totalViolations: summary.totalViolations,
+                        errorViolations: summary.errorViolations,
+                        violations: summary.violations,
+                    });
                     _b.label = 4;
                 case 4:
                     _a++;
@@ -148,6 +228,14 @@ function run() {
                         filesWithErrors: filesWithErrors,
                         filesWithWarnings: filesWithWarnings,
                         filesWithOptimizing: filesWithOptimizing,
+                        violationTotals: {
+                            total: totalViolations,
+                            error: totalErrorViolations,
+                            warning: totalWarningViolations,
+                            optimizing: totalOptimizingViolations,
+                        },
+                        files: fileSummaries,
+                        notifications: notifications,
                     }];
                 case 6:
                     error_1 = _b.sent();
@@ -157,27 +245,30 @@ function run() {
         });
     });
 }
-function analyzeFile(file, rules) {
+function analyzeFile(file, rules, format, log) {
     return __awaiter(this, void 0, void 0, function () {
         var source, reporter, t, ast, parseOptions, language, baseContext, sharedHelpers, _loop_1, _i, rules_1, rule, summary;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
                     source = (0, file_1.readFile)(file);
-                    reporter = (0, report_1.createReporter)(file, source);
+                    reporter = (0, report_1.createReporter)(file, source, { format: format });
                     t = (0, i18n_1.getTranslator)();
                     try {
                         parseOptions = (0, config_1.loadParseOptions)(file);
                         ast = (0, wasm_1.parseSync)(source, parseOptions);
                     }
                     catch (error) {
-                        consola_1.consola.error(t.parseFileFailed({ file: file }), error instanceof Error ? error.message : error);
+                        log('error', t.parseFileFailed({ file: file }), error);
                         return [2 /*return*/, {
                                 severityCounts: {
                                     error: 1,
                                     warning: 0,
                                     optimizing: 0,
                                 },
+                                totalViolations: 1,
+                                errorViolations: 1,
+                                violations: [],
                             }];
                     }
                     language = (0, i18n_1.getLanguage)();
@@ -226,7 +317,7 @@ function analyzeFile(file, rules) {
                                     return [3 /*break*/, 3];
                                 case 2:
                                     error_2 = _b.sent();
-                                    consola_1.consola.error(t.ruleExecutionFailed({ ruleName: rule.name, file: file }), error_2 instanceof Error ? error_2.message : error_2);
+                                    log('error', t.ruleExecutionFailed({ ruleName: rule.name, file: file }), error_2);
                                     return [3 /*break*/, 3];
                                 case 3: return [2 /*return*/];
                             }
@@ -248,6 +339,9 @@ function analyzeFile(file, rules) {
                     summary = reporter.flush();
                     return [2 /*return*/, {
                             severityCounts: summary.severityCounts,
+                            totalViolations: summary.totalViolations,
+                            errorViolations: summary.errorViolations,
+                            violations: summary.violations,
                         }];
             }
         });
@@ -305,48 +399,130 @@ function normalizeViolationInput(input, spanArg) {
         span: spanArg,
     };
 }
+function parseOutputFormat(value) {
+    if (!value) {
+        return 'text';
+    }
+    var normalized = value.toLowerCase();
+    if (normalized === 'json' || normalized === 'text') {
+        return normalized;
+    }
+    throw new Error("Unsupported output format: ".concat(value, ". Use \"text\" or \"json\"."));
+}
+function severityToLabel(severity) {
+    switch (severity) {
+        case auto_cr_rules_1.RuleSeverity.Warning:
+            return 'warning';
+        case auto_cr_rules_1.RuleSeverity.Optimizing:
+            return 'optimizing';
+        case auto_cr_rules_1.RuleSeverity.Error:
+        default:
+            return 'error';
+    }
+}
+function formatViolationForJson(violation) {
+    var suggestions = violation.suggestions
+        ? violation.suggestions.map(function (suggestion) { return (__assign({}, suggestion)); })
+        : [];
+    var payload = {
+        tag: violation.tag,
+        ruleName: violation.ruleName,
+        severity: severityToLabel(violation.severity),
+        message: violation.message,
+        suggestions: suggestions,
+    };
+    if (typeof violation.line === 'number') {
+        payload.line = violation.line;
+    }
+    if (violation.code) {
+        payload.code = violation.code;
+    }
+    return payload;
+}
+function formatJsonOutput(result) {
+    return {
+        summary: {
+            scannedFiles: result.scannedFiles,
+            filesWithErrors: result.filesWithErrors,
+            filesWithWarnings: result.filesWithWarnings,
+            filesWithOptimizing: result.filesWithOptimizing,
+            violationTotals: result.violationTotals,
+        },
+        files: result.files.map(function (file) { return ({
+            filePath: file.filePath,
+            severityCounts: file.severityCounts,
+            totalViolations: file.totalViolations,
+            errorViolations: file.errorViolations,
+            violations: file.violations.map(formatViolationForJson),
+        }); }),
+        notifications: result.notifications,
+    };
+}
 commander_1.program
     .argument('[paths...]', '需要扫描的文件或目录路径列表 / Paths to scan')
     .option('-r, --rule-dir <directory>', '自定义规则目录路径 / Custom rule directory')
     .option('-l, --language <language>', '设置 CLI 语言 (zh/en) / Set CLI language (zh/en)')
+    .option('-o, --output <format>', '设置输出格式 (text/json) / Output format (text/json)', 'text')
     .parse(process.argv);
 var options = commander_1.program.opts();
 var filePaths = commander_1.program.args.map(function (target) { return path_1.default.resolve(process.cwd(), target); });
+(0, i18n_1.setLanguage)((_a = options.language) !== null && _a !== void 0 ? _a : process.env.LANG);
+var outputFormat;
+try {
+    outputFormat = parseOutputFormat(options.output);
+}
+catch (error) {
+    var message = error instanceof Error ? error.message : String(error);
+    consola_1.consola.error(message);
+    process.exit(1);
+}
+;
 (function () { return __awaiter(void 0, void 0, void 0, function () {
-    var summary, t, language, resultMessage, error_3, t;
-    var _a;
-    return __generator(this, function (_b) {
-        switch (_b.label) {
+    var result, t, payload, exitCode, language, resultMessage, exitCode, error_3, t, detail, payload;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
             case 0:
-                _b.trys.push([0, 2, , 3]);
-                (0, i18n_1.setLanguage)((_a = options.language) !== null && _a !== void 0 ? _a : process.env.LANG);
-                return [4 /*yield*/, run(filePaths, options.ruleDir)];
+                _a.trys.push([0, 2, , 3]);
+                return [4 /*yield*/, run(filePaths, options.ruleDir, outputFormat)];
             case 1:
-                summary = _b.sent();
+                result = _a.sent();
                 t = (0, i18n_1.getTranslator)();
-                if (summary.scannedFiles > 0) {
+                if (outputFormat === 'json') {
+                    payload = formatJsonOutput(result);
+                    exitCode = result.filesWithErrors > 0 ? 1 : 0;
+                    process.stdout.write("".concat(JSON.stringify(payload, null, 2), "\n"));
+                    process.exit(exitCode);
+                }
+                if (result.scannedFiles > 0) {
                     consola_1.consola.log(' ');
                     language = (0, i18n_1.getLanguage)();
                     resultMessage = language.startsWith('zh')
-                        ? " ".concat(t.scanComplete(), "\uFF0C\u672C\u6B21\u5171\u626B\u63CF").concat(summary.scannedFiles, "\u4E2A\u6587\u4EF6\uFF0C\u5176\u4E2D").concat(summary.filesWithErrors, "\u4E2A\u6587\u4EF6\u5B58\u5728\u9519\u8BEF\uFF0C").concat(summary.filesWithWarnings, "\u4E2A\u6587\u4EF6\u5B58\u5728\u8B66\u544A\uFF0C").concat(summary.filesWithOptimizing, "\u4E2A\u6587\u4EF6\u5B58\u5728\u4F18\u5316\u5EFA\u8BAE\uFF01")
-                        : " ".concat(t.scanComplete(), ", scanned ").concat(summary.scannedFiles, " files: ").concat(summary.filesWithErrors, " with errors, ").concat(summary.filesWithWarnings, " with warnings, ").concat(summary.filesWithOptimizing, " with optimizing hints!");
-                    if (summary.filesWithErrors > 0) {
-                        consola_1.consola.success(resultMessage);
-                        process.exit(1);
-                    }
-                    else {
-                        consola_1.consola.success(resultMessage);
-                        process.exit(0);
-                    }
+                        ? " ".concat(t.scanComplete(), "\uFF0C\u672C\u6B21\u5171\u626B\u63CF").concat(result.scannedFiles, "\u4E2A\u6587\u4EF6\uFF0C\u5176\u4E2D").concat(result.filesWithErrors, "\u4E2A\u6587\u4EF6\u5B58\u5728\u9519\u8BEF\uFF0C").concat(result.filesWithWarnings, "\u4E2A\u6587\u4EF6\u5B58\u5728\u8B66\u544A\uFF0C").concat(result.filesWithOptimizing, "\u4E2A\u6587\u4EF6\u5B58\u5728\u4F18\u5316\u5EFA\u8BAE\uFF01")
+                        : " ".concat(t.scanComplete(), ", scanned ").concat(result.scannedFiles, " files: ").concat(result.filesWithErrors, " with errors, ").concat(result.filesWithWarnings, " with warnings, ").concat(result.filesWithOptimizing, " with optimizing hints!");
+                    consola_1.consola.success(resultMessage);
+                    exitCode = result.filesWithErrors > 0 ? 1 : 0;
+                    process.exit(exitCode);
                 }
                 else {
                     process.exit(0);
                 }
                 return [3 /*break*/, 3];
             case 2:
-                error_3 = _b.sent();
+                error_3 = _a.sent();
                 t = (0, i18n_1.getTranslator)();
-                consola_1.consola.error(t.scanError(), error_3 instanceof Error ? error_3.message : error_3);
+                detail = error_3 instanceof Error ? error_3.message : String(error_3);
+                if (outputFormat === 'json') {
+                    payload = {
+                        error: {
+                            message: t.scanError(),
+                            detail: detail,
+                        },
+                    };
+                    process.stdout.write("".concat(JSON.stringify(payload, null, 2), "\n"));
+                }
+                else {
+                    consola_1.consola.error(t.scanError(), detail);
+                }
                 process.exit(1);
                 return [3 /*break*/, 3];
             case 3: return [2 /*return*/];

package/dist/report/index.js

@@ -1,4 +1,24 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -9,16 +29,20 @@ var auto_cr_rules_1 = require("auto-cr-rules");
 var consola_1 = __importDefault(require("consola"));
 var i18n_1 = require("../i18n");
 var UNTAGGED_TAG = 'untagged';
+var DEFAULT_FORMAT = 'text';
 var severityLoggers = (_a = {},
     _a[auto_cr_rules_1.RuleSeverity.Error] = consola_1.default.error,
     _a[auto_cr_rules_1.RuleSeverity.Warning] = consola_1.default.warn,
     _a[auto_cr_rules_1.RuleSeverity.Optimizing] = consola_1.default.info,
     _a);
-function createReporter(filePath, source) {
+function createReporter(filePath, source, options) {
+    var _a;
+    if (options === void 0) { options = {}; }
     var offsets = buildLineOffsets(source);
     var t = (0, i18n_1.getTranslator)();
     var language = (0, i18n_1.getLanguage)();
     var records = [];
+    var format = (_a = options.format) !== null && _a !== void 0 ? _a : DEFAULT_FORMAT;
     var totalViolations = 0;
     var errorViolations = 0;
     var severityCounts = {
@@ -114,6 +138,7 @@ function createReporter(filePath, source) {
         return reporterWithRecord;
     };
     var flush = function () {
+        var violationSnapshot = records.map(function (record) { return (__assign(__assign({}, record), { suggestions: record.suggestions ? __spreadArray([], record.suggestions, true) : undefined })); });
         var summary = {
             totalViolations: totalViolations,
             errorViolations: errorViolations,
@@ -122,42 +147,41 @@ function createReporter(filePath, source) {
                 warning: severityCounts.warning,
                 optimizing: severityCounts.optimizing,
             },
+            violations: violationSnapshot,
         };
-        if (records.length === 0) {
-            resetCounters();
-            return summary;
+        if (violationSnapshot.length > 0 && format === 'text') {
+            var locale = language === 'zh' ? 'zh-CN' : 'en-US';
+            var formatter_1 = new Intl.DateTimeFormat(locale, {
+                hour: '2-digit',
+                minute: '2-digit',
+                second: '2-digit',
+                hour12: false,
+            });
+            var indent_1 = '    ';
+            var colon_1 = language === 'zh' ? '：' : ':';
+            var headerGap_1 = language === 'zh' ? '' : ' ';
+            violationSnapshot.forEach(function (violation) {
+                var timestamp = formatter_1.format(new Date());
+                var tagLabel = t.ruleTagLabel({ tag: violation.tag });
+                var severityIcon = t.reporterSeverityIcon({ severity: violation.severity });
+                var logger = getLoggerForSeverity(violation.severity);
+                var header = "[".concat(timestamp, "] ").concat(severityIcon, " [").concat(tagLabel, "]").concat(colon_1).concat(headerGap_1).concat(violation.ruleName);
+                logger(header);
+                var location = typeof violation.line === 'number' ? "".concat(filePath, ":").concat(violation.line) : filePath;
+                consola_1.default.log("".concat(indent_1).concat(t.reporterFileLabel(), ": ").concat(location));
+                consola_1.default.log("".concat(indent_1).concat(t.reporterDescriptionLabel(), ": ").concat(violation.message));
+                if (violation.code) {
+                    consola_1.default.log("".concat(indent_1).concat(t.reporterCodeLabel(), ": ").concat(violation.code));
+                }
+                if (violation.suggestions && violation.suggestions.length > 0) {
+                    var suggestionSeparator = language === 'zh' ? '； ' : ' | ';
+                    var suggestionLine = violation.suggestions
+                        .map(function (suggestion) { return t.reporterFormatSuggestion(suggestion); })
+                        .join(suggestionSeparator);
+                    consola_1.default.log("".concat(indent_1).concat(t.reporterSuggestionLabel(), ": ").concat(suggestionLine));
+                }
+            });
         }
-        var locale = language === 'zh' ? 'zh-CN' : 'en-US';
-        var formatter = new Intl.DateTimeFormat(locale, {
-            hour: '2-digit',
-            minute: '2-digit',
-            second: '2-digit',
-            hour12: false,
-        });
-        var indent = '    ';
-        var colon = language === 'zh' ? '：' : ':';
-        var headerGap = language === 'zh' ? '' : ' ';
-        records.forEach(function (violation) {
-            var timestamp = formatter.format(new Date());
-            var tagLabel = t.ruleTagLabel({ tag: violation.tag });
-            var severityIcon = t.reporterSeverityIcon({ severity: violation.severity });
-            var logger = getLoggerForSeverity(violation.severity);
-            var header = "[".concat(timestamp, "] ").concat(severityIcon, " [").concat(tagLabel, "]").concat(colon).concat(headerGap).concat(violation.ruleName);
-            logger(header);
-            var location = typeof violation.line === 'number' ? "".concat(filePath, ":").concat(violation.line) : filePath;
-            consola_1.default.log("".concat(indent).concat(t.reporterFileLabel(), ": ").concat(location));
-            consola_1.default.log("".concat(indent).concat(t.reporterDescriptionLabel(), ": ").concat(violation.message));
-            if (violation.code) {
-                consola_1.default.log("".concat(indent).concat(t.reporterCodeLabel(), ": ").concat(violation.code));
-            }
-            if (violation.suggestions && violation.suggestions.length > 0) {
-                var suggestionSeparator = language === 'zh' ? '； ' : ' | ';
-                var suggestionLine = violation.suggestions
-                    .map(function (suggestion) { return t.reporterFormatSuggestion(suggestion); })
-                    .join(suggestionSeparator);
-                consola_1.default.log("".concat(indent).concat(t.reporterSuggestionLabel(), ": ").concat(suggestionLine));
-            }
-        });
         records.length = 0;
         resetCounters();
         return summary;

package/dist/types/report/index.d.ts

@@ -1,9 +1,14 @@
+import { RuleSeverity } from 'auto-cr-rules';
 import type { Rule, RuleReporter } from 'auto-cr-rules';
+export type ReporterFormat = 'text' | 'json';
+interface ReporterOptions {
+    format?: ReporterFormat;
+}
 export interface Reporter extends RuleReporter {
     forRule(rule: Pick<Rule, 'name' | 'tag' | 'severity'>): RuleReporter;
     flush(): ReporterSummary;
 }
-interface ReporterSummary {
+export interface ReporterSummary {
     totalViolations: number;
     errorViolations: number;
     severityCounts: {
@@ -11,6 +16,21 @@ interface ReporterSummary {
         warning: number;
         optimizing: number;
     };
+    violations: ReadonlyArray<ViolationRecord>;
+}
+type Severity = RuleSeverity;
+type SuggestionEntry = {
+    text: string;
+    link?: string;
+};
+export interface ViolationRecord {
+    tag: string;
+    ruleName: string;
+    severity: Severity;
+    message: string;
+    line?: number;
+    code?: string;
+    suggestions?: ReadonlyArray<SuggestionEntry>;
 }
-export declare function createReporter(filePath: string, source: string): Reporter;
+export declare function createReporter(filePath: string, source: string, options?: ReporterOptions): Reporter;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-cr-cmd",
-  "version": "2.0.27",
+  "version": "2.0.29",
   "description": "Fast automated code review CLI powered by SWC-based static analysis",
   "main": "./dist/index.js",
   "types": "./dist/types/index.d.ts",
@@ -48,7 +48,7 @@
   "dependencies": {
     "@swc/core": "^1.13.20",
     "@swc/wasm": "^1.13.20",
-    "auto-cr-rules": "^2.0.27",
+    "auto-cr-rules": "^2.0.29",
     "commander": "^14.0.0",
     "consola": "^3.4.2"
   },