auto-cr-rules 2.0.19 → 2.0.21

package/dist/messages.js

@@ -5,7 +5,7 @@ var ruleTranslations = {
     zh: {
         noDeepRelativeImports: function (_a) {
             var value = _a.value, maxDepth = _a.maxDepth;
-            return "\u5BFC\u5165\u8DEF\u5F84 \"".concat(value, "\" \u4E0D\u80FD\u8D85\u8FC7\u6700\u5927\u5C42\u7EA7").concat(maxDepth);
+            return "\u5BFC\u5165\u8DEF\u5F84 \"".concat(value, "\"\uFF0C\u4E0D\u80FD\u8D85\u8FC7\u6700\u5927\u5C42\u7EA7").concat(maxDepth);
         },
     },
     en: {

package/dist/rules/noDeepRelativeImports.js

@@ -4,7 +4,7 @@ exports.noDeepRelativeImports = void 0;
 var types_1 = require("../types");
 var MAX_DEPTH = 2;
 exports.noDeepRelativeImports = (0, types_1.defineRule)('no-deep-relative-imports', { tag: 'base', severity: types_1.RuleSeverity.Warning }, function (_a) {
-    var helpers = _a.helpers, messages = _a.messages;
+    var helpers = _a.helpers, messages = _a.messages, language = _a.language;
     for (var _i = 0, _b = helpers.imports; _i < _b.length; _i++) {
         var reference = _b[_i];
         if (!helpers.isRelativePath(reference.value)) {
@@ -12,7 +12,22 @@ exports.noDeepRelativeImports = (0, types_1.defineRule)('no-deep-relative-import
         }
         var depth = helpers.relativeDepth(reference.value);
         if (depth > MAX_DEPTH) {
-            helpers.reportViolation(messages.noDeepRelativeImports({ value: reference.value, maxDepth: MAX_DEPTH }), reference.span);
+            var description = messages.noDeepRelativeImports({ value: reference.value, maxDepth: MAX_DEPTH });
+            var suggestions = language === 'zh'
+                ? [
+                    { text: '使用别名路径（如 @shared/deep/utils）' },
+                    { text: '或在上层聚合导出，避免过深相对路径。' },
+                ]
+                : [
+                    { text: 'Use a path alias (for example: @shared/deep/utils).' },
+                    { text: 'Create an index file at a higher level to re-export the module and shorten the import.' },
+                ];
+            helpers.reportViolation({
+                description: description,
+                code: reference.value,
+                suggestions: suggestions,
+                span: reference.span,
+            });
         }
     }
 });

package/dist/runtime.js

@@ -24,12 +24,22 @@ var createRuleHelpers = function (reporter, imports) {
     var relativeDepth = function (value) {
         return (value.match(/\.\.\//g) || []).length;
     };
-    var reportViolation = function (message, span) {
-        if (span) {
-            reporter.errorAtSpan(span, message);
+    var reportViolation = function (input, spanArg) {
+        var normalized = normalizeViolationInput(input, spanArg);
+        if (typeof reporter.record === 'function') {
+            reporter.record(normalized);
             return;
         }
-        reporter.error(message);
+        var targetSpan = normalized.span;
+        if (targetSpan) {
+            reporter.errorAtSpan(targetSpan, normalized.description);
+            return;
+        }
+        if (typeof normalized.line === 'number') {
+            reporter.errorAtLine(normalized.line, normalized.description);
+            return;
+        }
+        reporter.error(normalized.description);
     };
     return {
         imports: imports,
@@ -38,3 +48,20 @@ var createRuleHelpers = function (reporter, imports) {
         reportViolation: reportViolation,
     };
 };
+function normalizeViolationInput(input, fallbackSpan) {
+    var _a, _b;
+    if (typeof input === 'string') {
+        return {
+            description: input,
+            span: fallbackSpan,
+        };
+    }
+    var description = (_a = input.description) !== null && _a !== void 0 ? _a : input.message;
+    return {
+        description: description !== null && description !== void 0 ? description : 'Rule violation detected.',
+        code: input.code,
+        suggestions: input.suggestions,
+        span: (_b = input.span) !== null && _b !== void 0 ? _b : fallbackSpan,
+        line: input.line,
+    };
+}

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export type { ImportReference, Language, Rule, RuleMetadata, RuleContext, RuleHelpers, RuleMessages, RuleReporter, } from './types';
+export type { ImportReference, Language, Rule, RuleMetadata, RuleContext, RuleHelpers, RuleMessages, RuleReporter, RuleReporterRecord, RuleSuggestion, RuleViolationInput, } from './types';
 export { RuleSeverity } from './types';
 export { defineRule, isRule, toRule } from './types';
 export { createRuleContext } from './runtime';

package/dist/types/types.d.ts

@@ -4,12 +4,33 @@ export interface RuleReporter {
     error(message: string): void;
     errorAtSpan(span: Span | undefined, message: string): void;
     errorAtLine(line: number | undefined, message: string): void;
+    record?(record: RuleReporterRecord): void;
 }
 export declare enum RuleSeverity {
     Error = "error",
     Warning = "warning",
     Optimizing = "optimizing"
 }
+export interface RuleSuggestion {
+    text: string;
+    link?: string;
+}
+export interface RuleReporterRecord {
+    description: string;
+    code?: string;
+    suggestions?: ReadonlyArray<RuleSuggestion>;
+    span?: Span;
+    line?: number;
+}
+export interface RuleViolationInit {
+    description?: string;
+    message?: string;
+    code?: string;
+    suggestions?: ReadonlyArray<RuleSuggestion>;
+    span?: Span;
+    line?: number;
+}
+export type RuleViolationInput = string | RuleViolationInit;
 export interface ImportReference {
     kind: 'static' | 'dynamic' | 'require';
     value: string;
@@ -25,7 +46,7 @@ export interface RuleHelpers {
     readonly imports: ReadonlyArray<ImportReference>;
     isRelativePath(value: string): boolean;
     relativeDepth(value: string): number;
-    reportViolation(message: string, span?: Span): void;
+    reportViolation(input: RuleViolationInput, span?: Span): void;
 }
 export interface RuleContext {
     readonly filePath: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-cr-rules",
-  "version": "2.0.19",
+  "version": "2.0.21",
   "description": "Extensible static analysis rule set for the auto-cr automated code review toolkit",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",