auto-cr-rules 2.0.17 → 2.0.19

package/README.md

@@ -112,7 +112,8 @@ module.exports = { rules: [ruleA, ruleB] }
 ### 4. Run It
 
 ```bash
-npx auto-cr-cmd --language en --rule-dir ./examples/custom-rules -- ./examples/src
+cd examples
+npx auto-cr-cmd --language en --rule-dir ./examples/custom-rules -- ./src
 ```
 
 ## Project Layout

package/README.zh-CN.md

@@ -112,8 +112,8 @@ module.exports = { rules: [ruleA, ruleB] }
 ### 4. 运行
 
 ```bash
-pnpm run build
-npx auto-cr-cmd --language zh --rule-dir ./examples/custom-rules -- ./examples/src
+cd examples
+npx auto-cr-cmd --language en --rule-dir ./examples/custom-rules -- ./src
 ```
 
 ## 项目结构

package/dist/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.noDeepRelativeImports = exports.builtinRules = exports.createRuleContext = exports.toRule = exports.isRule = exports.defineRule = void 0;
+exports.noDeepRelativeImports = exports.builtinRules = exports.createRuleContext = exports.toRule = exports.isRule = exports.defineRule = exports.RuleSeverity = void 0;
 var types_1 = require("./types");
-Object.defineProperty(exports, "defineRule", { enumerable: true, get: function () { return types_1.defineRule; } });
-Object.defineProperty(exports, "isRule", { enumerable: true, get: function () { return types_1.isRule; } });
-Object.defineProperty(exports, "toRule", { enumerable: true, get: function () { return types_1.toRule; } });
+Object.defineProperty(exports, "RuleSeverity", { enumerable: true, get: function () { return types_1.RuleSeverity; } });
+var types_2 = require("./types");
+Object.defineProperty(exports, "defineRule", { enumerable: true, get: function () { return types_2.defineRule; } });
+Object.defineProperty(exports, "isRule", { enumerable: true, get: function () { return types_2.isRule; } });
+Object.defineProperty(exports, "toRule", { enumerable: true, get: function () { return types_2.toRule; } });
 var runtime_1 = require("./runtime");
 Object.defineProperty(exports, "createRuleContext", { enumerable: true, get: function () { return runtime_1.createRuleContext; } });
 var rules_1 = require("./rules");

package/dist/rules/noDeepRelativeImports.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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' }, function (_a) {
+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;
     for (var _i = 0, _b = helpers.imports; _i < _b.length; _i++) {
         var reference = _b[_i];

package/dist/types/index.d.ts

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

package/dist/types/types.d.ts

@@ -5,6 +5,11 @@ export interface RuleReporter {
     errorAtSpan(span: Span | undefined, message: string): void;
     errorAtLine(line: number | undefined, message: string): void;
 }
+export declare enum RuleSeverity {
+    Error = "error",
+    Warning = "warning",
+    Optimizing = "optimizing"
+}
 export interface ImportReference {
     kind: 'static' | 'dynamic' | 'require';
     value: string;
@@ -33,10 +38,12 @@ export interface RuleContext {
 }
 export interface RuleMetadata {
     tag?: string;
+    severity?: RuleSeverity;
 }
 export interface Rule {
     name: string;
     tag?: string;
+    severity?: RuleSeverity;
     run(context: RuleContext): void | Promise<void>;
 }
 export declare function defineRule(name: string, runner: (context: RuleContext) => void | Promise<void>): Rule;

package/dist/types.js

@@ -11,15 +11,22 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toRule = exports.isRule = void 0;
+exports.toRule = exports.isRule = exports.RuleSeverity = void 0;
 exports.defineRule = defineRule;
+var RuleSeverity;
+(function (RuleSeverity) {
+    RuleSeverity["Error"] = "error";
+    RuleSeverity["Warning"] = "warning";
+    RuleSeverity["Optimizing"] = "optimizing";
+})(RuleSeverity || (exports.RuleSeverity = RuleSeverity = {}));
 function defineRule(name, metadataOrRunner, maybeRunner) {
+    var _a;
     var metadata = typeof metadataOrRunner === 'function' ? {} : metadataOrRunner;
     var runner = typeof metadataOrRunner === 'function' ? metadataOrRunner : maybeRunner;
     if (!runner) {
         throw new Error('defineRule requires a rule runner function');
     }
-    return __assign(__assign({ name: name }, metadata), { run: runner });
+    return __assign(__assign({ name: name }, metadata), { severity: (_a = metadata.severity) !== null && _a !== void 0 ? _a : RuleSeverity.Error, run: runner });
 }
 var isRule = function (value) {
     return (typeof value === 'object' &&
@@ -27,17 +34,22 @@ var isRule = function (value) {
         typeof value.name === 'string' &&
         typeof value.run === 'function' &&
         (typeof value.tag === 'undefined' ||
-            typeof value.tag === 'string'));
+            typeof value.tag === 'string') &&
+        (typeof value.severity === 'undefined' ||
+            (typeof value.severity === 'string' &&
+                Object.values(RuleSeverity).includes(value.severity))));
 };
 exports.isRule = isRule;
 var toRule = function (value, origin) {
+    var _a;
     if ((0, exports.isRule)(value)) {
-        return value;
+        return __assign({ severity: (_a = value.severity) !== null && _a !== void 0 ? _a : RuleSeverity.Error }, value);
     }
     if (typeof value === 'function') {
         var fn = value;
         return {
             name: fn.name || origin,
+            severity: RuleSeverity.Error,
             run: fn,
         };
     }

package/package.json

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