@gobing-ai/ts-rule-engine 0.2.6 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/README.md +563 -1
  2. package/dist/config/extensions.d.ts +48 -0
  3. package/dist/config/extensions.d.ts.map +1 -0
  4. package/dist/config/extensions.js +67 -0
  5. package/dist/config/loader.d.ts +20 -1
  6. package/dist/config/loader.d.ts.map +1 -1
  7. package/dist/config/loader.js +52 -26
  8. package/dist/engine.d.ts +26 -1
  9. package/dist/engine.d.ts.map +1 -1
  10. package/dist/engine.js +79 -0
  11. package/dist/evaluators/exit-code-evaluator.d.ts +1 -1
  12. package/dist/evaluators/exit-code-evaluator.d.ts.map +1 -1
  13. package/dist/evaluators/exit-code-evaluator.js +22 -9
  14. package/dist/evaluators/forbidden-import-evaluator.d.ts +16 -3
  15. package/dist/evaluators/forbidden-import-evaluator.d.ts.map +1 -1
  16. package/dist/evaluators/forbidden-import-evaluator.js +71 -6
  17. package/dist/evaluators/import-boundary-evaluator.d.ts +19 -0
  18. package/dist/evaluators/import-boundary-evaluator.d.ts.map +1 -0
  19. package/dist/evaluators/import-boundary-evaluator.js +85 -0
  20. package/dist/evaluators/path-evaluator.d.ts +15 -2
  21. package/dist/evaluators/path-evaluator.d.ts.map +1 -1
  22. package/dist/evaluators/path-evaluator.js +49 -3
  23. package/dist/evaluators/regex-evaluator.d.ts.map +1 -1
  24. package/dist/evaluators/regex-evaluator.js +43 -8
  25. package/dist/evaluators/schema-artifact-evaluator.d.ts +21 -0
  26. package/dist/evaluators/schema-artifact-evaluator.d.ts.map +1 -0
  27. package/dist/evaluators/schema-artifact-evaluator.js +102 -0
  28. package/dist/evaluators/secrets-scanner-evaluator.d.ts +13 -2
  29. package/dist/evaluators/secrets-scanner-evaluator.d.ts.map +1 -1
  30. package/dist/evaluators/secrets-scanner-evaluator.js +72 -9
  31. package/dist/evaluators/sg-evaluator.d.ts +19 -0
  32. package/dist/evaluators/sg-evaluator.d.ts.map +1 -0
  33. package/dist/evaluators/sg-evaluator.js +112 -0
  34. package/dist/evaluators/test-location-evaluator.d.ts +14 -1
  35. package/dist/evaluators/test-location-evaluator.d.ts.map +1 -1
  36. package/dist/evaluators/test-location-evaluator.js +42 -22
  37. package/dist/evaluators/tsdoc-export-evaluator.js +19 -5
  38. package/dist/fixers/fixers.d.ts +86 -0
  39. package/dist/fixers/fixers.d.ts.map +1 -0
  40. package/dist/fixers/fixers.js +230 -0
  41. package/dist/fixers/test-stub-fixer.d.ts +49 -0
  42. package/dist/fixers/test-stub-fixer.d.ts.map +1 -0
  43. package/dist/fixers/test-stub-fixer.js +91 -0
  44. package/dist/host/builtins.d.ts.map +1 -1
  45. package/dist/host/builtins.js +12 -1
  46. package/dist/host/rule-engine-host.d.ts +3 -0
  47. package/dist/host/rule-engine-host.d.ts.map +1 -1
  48. package/dist/host/rule-engine-host.js +3 -0
  49. package/dist/index.d.ts +4 -0
  50. package/dist/index.d.ts.map +1 -1
  51. package/dist/index.js +4 -0
  52. package/dist/resolvers/test-path-resolver.d.ts +72 -0
  53. package/dist/resolvers/test-path-resolver.d.ts.map +1 -0
  54. package/dist/resolvers/test-path-resolver.js +112 -0
  55. package/dist/types.d.ts +36 -0
  56. package/dist/types.d.ts.map +1 -1
  57. package/dist/types.js +10 -0
  58. package/package.json +4 -3
  59. package/schemas/preset.schema.json +40 -0
  60. package/schemas/rule-file.schema.json +49 -0
  61. package/src/config/extensions.ts +115 -0
  62. package/src/config/loader.ts +81 -25
  63. package/src/engine.ts +99 -2
  64. package/src/evaluators/exit-code-evaluator.ts +27 -9
  65. package/src/evaluators/forbidden-import-evaluator.ts +101 -7
  66. package/src/evaluators/import-boundary-evaluator.ts +135 -0
  67. package/src/evaluators/path-evaluator.ts +66 -3
  68. package/src/evaluators/regex-evaluator.ts +53 -12
  69. package/src/evaluators/schema-artifact-evaluator.ts +134 -0
  70. package/src/evaluators/secrets-scanner-evaluator.ts +89 -11
  71. package/src/evaluators/sg-evaluator.ts +133 -0
  72. package/src/evaluators/test-location-evaluator.ts +47 -35
  73. package/src/evaluators/tsdoc-export-evaluator.ts +19 -5
  74. package/src/fixers/fixers.ts +294 -0
  75. package/src/fixers/test-stub-fixer.ts +118 -0
  76. package/src/host/builtins.ts +17 -1
  77. package/src/host/rule-engine-host.ts +4 -0
  78. package/src/index.ts +4 -0
  79. package/src/resolvers/test-path-resolver.ts +133 -0
  80. package/src/types.ts +40 -0
@@ -1,4 +1,5 @@
1
1
  import { type ConstraintRule } from '../types';
2
+ import { type ExtensionRef } from './extensions';
2
3
  /** Options for loading rule presets. */
3
4
  export interface RuleLoaderOptions {
4
5
  /**
@@ -9,6 +10,23 @@ export interface RuleLoaderOptions {
9
10
  * loader stays agnostic to any project layout convention.
10
11
  */
11
12
  roots: string[];
13
+ /** When true, honor top-level `$schema` refs in preset and rule files. Defaults to true. */
14
+ validateSchema?: boolean;
15
+ /** Optional fetch implementation for remote HTTP(S) schema refs. */
16
+ fetch?: (input: string) => Promise<Response>;
17
+ }
18
+ export interface RuleFileLoadOptions {
19
+ /** When true, honor top-level `$schema` refs. Defaults to true. */
20
+ validateSchema?: boolean;
21
+ /** Optional fetch implementation for remote HTTP(S) schema refs. */
22
+ fetch?: (input: string) => Promise<Response>;
23
+ }
24
+ /** Loaded preset rules plus extension module refs declared by composed presets. */
25
+ export interface LoadedPreset {
26
+ /** Normalized rules after preset disable/override handling. */
27
+ readonly rules: ConstraintRule[];
28
+ /** Extension modules declared by the preset graph, resolved to absolute paths. */
29
+ readonly extensions: ExtensionRef[];
12
30
  }
13
31
  /**
14
32
  * Load and normalize a preset by name, resolving across one or more rule roots.
@@ -17,7 +35,8 @@ export interface RuleLoaderOptions {
17
35
  * so a caller can layer project-local rules over shared/global rules and inherit
18
36
  * the rest of a preset's categories from the lower-priority roots.
19
37
  */
38
+ export declare function loadPreset(name: string, options: RuleLoaderOptions): Promise<LoadedPreset>;
20
39
  export declare function loadPresetRules(name: string, options: RuleLoaderOptions): Promise<ConstraintRule[]>;
21
40
  /** Load a direct rule file from disk. */
22
- export declare function loadRuleFile(filePath: string): Promise<ConstraintRule[]>;
41
+ export declare function loadRuleFile(filePath: string, options?: RuleFileLoadOptions): Promise<ConstraintRule[]>;
23
42
  //# sourceMappingURL=loader.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../../src/config/loader.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,KAAK,cAAc,EAMtB,MAAM,UAAU,CAAC;AAElB,wCAAwC;AACxC,MAAM,WAAW,iBAAiB;IAC9B;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB;AAUD;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAkBzG;AAED,yCAAyC;AACzC,wBAAsB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAE9E"}
1
+ {"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../../src/config/loader.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,cAAc,EAMtB,MAAM,UAAU,CAAC;AAClB,OAAO,EAA2B,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC;AAE1E,wCAAwC;AACxC,MAAM,WAAW,iBAAiB;IAC9B;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,4FAA4F;IAC5F,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oEAAoE;IACpE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,mBAAmB;IAChC,mEAAmE;IACnE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oEAAoE;IACpE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CAChD;AAED,mFAAmF;AACnF,MAAM,WAAW,YAAY;IACzB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,EAAE,cAAc,EAAE,CAAC;IACjC,kFAAkF;IAClF,QAAQ,CAAC,UAAU,EAAE,YAAY,EAAE,CAAC;CACvC;AAUD;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAqBhG;AAED,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAEzG;AAED,yCAAyC;AACzC,wBAAsB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAGjH"}
@@ -1,7 +1,7 @@
1
- import { basename, dirname, extname, join, relative, resolve, sep } from 'node:path';
2
- import { NodeFileSystem } from '@gobing-ai/ts-runtime';
3
- import { parse } from 'yaml';
1
+ import { basename, dirname, join, relative, resolve, sep } from 'node:path';
2
+ import { loadStructuredConfig, NodeFileSystem } from '@gobing-ai/ts-runtime';
4
3
  import { ConstraintRuleFileSchema, ConstraintRuleSchema, PresetDefinitionSchema, } from '../types.js';
4
+ import { collectPresetExtensions } from './extensions.js';
5
5
  /**
6
6
  * Load and normalize a preset by name, resolving across one or more rule roots.
7
7
  *
@@ -9,15 +9,18 @@ import { ConstraintRuleFileSchema, ConstraintRuleSchema, PresetDefinitionSchema,
9
9
  * so a caller can layer project-local rules over shared/global rules and inherit
10
10
  * the rest of a preset's categories from the lower-priority roots.
11
11
  */
12
- export async function loadPresetRules(name, options) {
12
+ export async function loadPreset(name, options) {
13
13
  const merged = await buildMergedRoots(options.roots.map((root) => resolve(root)));
14
14
  const presetPath = findMergedPreset(merged, name);
15
15
  if (presetPath === null)
16
- return [];
17
- const preset = PresetDefinitionSchema.parse(await readStructuredFile(presetPath));
16
+ return { rules: [], extensions: [] };
17
+ const preset = PresetDefinitionSchema.parse(await readStructuredFile(presetPath, options));
18
18
  const rules = [];
19
+ const extensions = collectPresetExtensions(preset.name, dirname(presetPath), preset.extensions);
19
20
  for (const entry of preset.extends) {
20
- rules.push(...(await loadPresetEntry(merged, entry, new Set([name]))));
21
+ const loaded = await loadPresetEntry(merged, entry, new Set([name]), options);
22
+ rules.push(...loaded.rules);
23
+ extensions.push(...loaded.extensions);
21
24
  }
22
25
  const disabled = new Set(preset.disable ?? []);
23
26
  const normalized = rules.filter((rule) => !disabled.has(rule.id));
@@ -27,38 +30,52 @@ export async function loadPresetRules(name, options) {
27
30
  rule.fix = { ...(rule.fix ?? { mode: 'none' }), ...override.fix };
28
31
  }
29
32
  }
30
- return normalized;
33
+ return { rules: normalized, extensions };
34
+ }
35
+ export async function loadPresetRules(name, options) {
36
+ return (await loadPreset(name, options)).rules;
31
37
  }
32
38
  /** Load a direct rule file from disk. */
33
- export async function loadRuleFile(filePath) {
34
- return normalizeRuleFile(await readStructuredFile(resolve(filePath)), dirname(resolve(filePath)));
39
+ export async function loadRuleFile(filePath, options = {}) {
40
+ const resolved = resolve(filePath);
41
+ return normalizeRuleFile(await readStructuredFile(resolved, options), dirname(resolved));
35
42
  }
36
- async function loadPresetEntry(merged, entry, seen) {
37
- // Sub-preset reference — recurse (cycle-guarded).
43
+ async function loadPresetEntry(merged, entry, seen, options) {
44
+ // Sub-preset reference — recurse, erroring on a genuine cycle.
38
45
  const presetPath = findMergedPreset(merged, entry);
39
- if (presetPath !== null && !seen.has(entry)) {
40
- seen.add(entry);
41
- const preset = PresetDefinitionSchema.safeParse(await readStructuredFile(presetPath));
46
+ if (presetPath !== null) {
47
+ if (seen.has(entry)) {
48
+ throw new Error(`Circular preset dependency detected: ${[...seen, entry].join(' → ')}`);
49
+ }
50
+ const nextSeen = new Set([...seen, entry]);
51
+ const preset = PresetDefinitionSchema.safeParse(await readStructuredFile(presetPath, options));
42
52
  if (preset.success) {
43
53
  const rules = [];
44
- for (const child of preset.data.extends)
45
- rules.push(...(await loadPresetEntry(merged, child, seen)));
46
- return rules.filter((rule) => !(preset.data.disable ?? []).includes(rule.id));
54
+ const extensions = collectPresetExtensions(preset.data.name, dirname(presetPath), preset.data.extensions);
55
+ for (const child of preset.data.extends) {
56
+ const loaded = await loadPresetEntry(merged, child, nextSeen, options);
57
+ rules.push(...loaded.rules);
58
+ extensions.push(...loaded.extensions);
59
+ }
60
+ return { rules: rules.filter((rule) => !(preset.data.disable ?? []).includes(rule.id)), extensions };
47
61
  }
48
62
  }
49
63
  // Category folder reference — load every winning file under that prefix.
50
64
  if (merged.categories.has(entry)) {
51
65
  const rules = [];
52
66
  for (const absPath of mergedFilesInCategory(merged, entry)) {
53
- rules.push(...(await loadRuleFile(absPath)));
67
+ rules.push(...normalizeRuleFile(await readStructuredFile(absPath, options), dirname(absPath)));
54
68
  }
55
- return rules;
69
+ return { rules, extensions: [] };
56
70
  }
57
71
  // Sub-path reference — a single winning rule file within a category.
58
72
  const subPath = findMergedFile(merged, entry);
59
73
  if (subPath !== null)
60
- return loadRuleFile(subPath);
61
- return [];
74
+ return {
75
+ rules: normalizeRuleFile(await readStructuredFile(subPath, options), dirname(subPath)),
76
+ extensions: [],
77
+ };
78
+ return { rules: [], extensions: [] };
62
79
  }
63
80
  /**
64
81
  * Build the merged view across ordered roots.
@@ -152,9 +169,11 @@ async function listImmediateDirs(fs, dir) {
152
169
  }
153
170
  return dirs;
154
171
  }
155
- async function readStructuredFile(path) {
156
- const content = await new NodeFileSystem().readFile(path);
157
- return extname(path) === '.json' ? JSON.parse(content) : parse(content);
172
+ async function readStructuredFile(path, options = {}) {
173
+ return await loadStructuredConfig(path, {
174
+ validateSchema: options.validateSchema,
175
+ fetch: options.fetch,
176
+ });
158
177
  }
159
178
  function normalizeRuleFile(raw, sourceDir) {
160
179
  const maybeFile = ConstraintRuleFileSchema.safeParse(raw);
@@ -170,9 +189,16 @@ function normalizeFileRules(file, sourceDir) {
170
189
  ...rule,
171
190
  severity: rule.severity ?? file.severity ?? 'error',
172
191
  include: rule.include ?? file.include,
173
- exclude: rule.exclude ?? file.exclude,
192
+ // File-level excludes always apply; a rule's own excludes add to (not replace) them.
193
+ exclude: mergeExcludes(file.exclude, rule.exclude),
174
194
  }, {}, sourceDir));
175
195
  }
196
+ /** Union of file-level and rule-level excludes, de-duplicated. Returns undefined when both empty. */
197
+ function mergeExcludes(fileExclude, ruleExclude) {
198
+ if (fileExclude === undefined && ruleExclude === undefined)
199
+ return undefined;
200
+ return [...new Set([...(fileExclude ?? []), ...(ruleExclude ?? [])])];
201
+ }
176
202
  function normalizeRule(rule, _defaults, _sourceDir) {
177
203
  return {
178
204
  ...rule,
package/dist/engine.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import type { ProcessExecutor } from '@gobing-ai/ts-runtime';
2
+ import { type FixApplicationResult } from './fixers/fixers';
2
3
  import { RuleEngineHost } from './host/rule-engine-host';
3
- import type { ConstraintRule, RuleEngineResult, RuleEvaluator } from './types';
4
+ import type { ConstraintRule, Fix, FixMode, RuleEngineResult, RuleEvaluator } from './types';
4
5
  /** Options for constructing a RuleEngine. */
5
6
  export interface RuleEngineOptions {
6
7
  /** Optional executor supplied to process-backed evaluators. */
@@ -12,10 +13,34 @@ export interface RuleEngineOptions {
12
13
  export declare class RuleEngine {
13
14
  /** Capability host used by this engine. */
14
15
  readonly host: RuleEngineHost;
16
+ /** Fixer providers keyed by evaluator type. */
17
+ private readonly fixers;
15
18
  constructor(options?: RuleEngineOptions);
16
19
  /** Register or replace an evaluator. */
17
20
  registerEvaluator(type: string, evaluator: RuleEvaluator): void;
18
21
  /** Evaluate all enabled rules against a working directory. */
19
22
  evaluate(rules: ConstraintRule[], workdir: string): Promise<RuleEngineResult>;
23
+ /**
24
+ * Evaluate all enabled rules and collect candidate fixes.
25
+ *
26
+ * For each rule with findings and a non-none fix mode, looks up the fixer
27
+ * provider by evaluator type and calls `createFixes`. The effective fix mode
28
+ * is the minimum of the rule's configured mode and `maxFixMode`.
29
+ *
30
+ * @param rules - Normalized rule definitions to evaluate.
31
+ * @param workdir - Working directory to scan.
32
+ * @param maxFixMode - Highest fix authority requested by the caller.
33
+ * @returns Findings plus fixes allowed by the requested authority.
34
+ */
35
+ evaluateWithFixes(rules: ConstraintRule[], workdir: string, maxFixMode?: FixMode): Promise<RuleEngineResult>;
36
+ /**
37
+ * Apply or preview candidate byte-range fixes.
38
+ *
39
+ * @param workdir - Working directory that fix file paths are relative to.
40
+ * @param fixes - Fixes to apply.
41
+ * @param dryRun - When true, return a diff without writing files.
42
+ * @returns Application details and optional diff.
43
+ */
44
+ applyFixes(workdir: string, fixes: readonly Fix[], dryRun?: boolean): Promise<FixApplicationResult>;
20
45
  }
21
46
  //# sourceMappingURL=engine.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAqB,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAGlG,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IAC9B,+DAA+D;IAC/D,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,mCAAmC;IACnC,IAAI,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,4EAA4E;AAC5E,qBAAa,UAAU;IACnB,2CAA2C;IAC3C,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;gBAElB,OAAO,GAAE,iBAAsB;IAK3C,wCAAwC;IACxC,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,IAAI;IAI/D,8DAA8D;IACxD,QAAQ,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAmBtF"}
1
+ {"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAKH,KAAK,oBAAoB,EAE5B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAqB,cAAc,EAAE,GAAG,EAAE,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAGhH,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IAC9B,+DAA+D;IAC/D,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,mCAAmC;IACnC,IAAI,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,4EAA4E;AAC5E,qBAAa,UAAU;IACnB,2CAA2C;IAC3C,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAE9B,+CAA+C;IAC/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiC;gBAE5C,OAAO,GAAE,iBAAsB;IAM3C,wCAAwC;IACxC,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,IAAI;IAI/D,8DAA8D;IACxD,QAAQ,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAqBnF;;;;;;;;;;;OAWG;IACG,iBAAiB,CACnB,KAAK,EAAE,cAAc,EAAE,EACvB,OAAO,EAAE,MAAM,EACf,UAAU,GAAE,OAAgB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAkD5B;;;;;;;OAOG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,EAAE,EAAE,MAAM,UAAQ,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAG1G"}
package/dist/engine.js CHANGED
@@ -1,3 +1,4 @@
1
+ import { applyFixes as applyFixesImpl, builtInFixers, FIX_MODE_RANK, } from './fixers/fixers.js';
1
2
  import { registerBuiltins } from './host/builtins.js';
2
3
  import { RuleEngineHost } from './host/rule-engine-host.js';
3
4
  import { createFinding } from './types.js';
@@ -5,9 +6,12 @@ import { createFinding } from './types.js';
5
6
  export class RuleEngine {
6
7
  /** Capability host used by this engine. */
7
8
  host;
9
+ /** Fixer providers keyed by evaluator type. */
10
+ fixers;
8
11
  constructor(options = {}) {
9
12
  this.host = options.host ?? new RuleEngineHost();
10
13
  registerBuiltins(this.host, options.processExecutor);
14
+ this.fixers = builtInFixers(this.host, options.processExecutor);
11
15
  }
12
16
  /** Register or replace an evaluator. */
13
17
  registerEvaluator(type, evaluator) {
@@ -28,9 +32,84 @@ export class RuleEngine {
28
32
  catch (error) {
29
33
  findings.push(createFinding(rule, error instanceof Error ? error.message : String(error), null, {
30
34
  code: `evaluator:${rule.evaluator.type}`,
35
+ kind: 'error',
31
36
  }));
32
37
  }
33
38
  }
34
39
  return { findings, fixes };
35
40
  }
41
+ /**
42
+ * Evaluate all enabled rules and collect candidate fixes.
43
+ *
44
+ * For each rule with findings and a non-none fix mode, looks up the fixer
45
+ * provider by evaluator type and calls `createFixes`. The effective fix mode
46
+ * is the minimum of the rule's configured mode and `maxFixMode`.
47
+ *
48
+ * @param rules - Normalized rule definitions to evaluate.
49
+ * @param workdir - Working directory to scan.
50
+ * @param maxFixMode - Highest fix authority requested by the caller.
51
+ * @returns Findings plus fixes allowed by the requested authority.
52
+ */
53
+ async evaluateWithFixes(rules, workdir, maxFixMode = 'auto') {
54
+ const findings = [];
55
+ const fixes = [];
56
+ for (const rule of rules) {
57
+ if (rule.enabled === false)
58
+ continue;
59
+ let ruleFindings = [];
60
+ let ruleEvalFixes = [];
61
+ try {
62
+ const result = await this.host.evaluators.get(rule.evaluator.type).evaluate(rule, { rule, workdir });
63
+ ruleFindings = result.findings;
64
+ ruleEvalFixes = result.fixes;
65
+ }
66
+ catch (error) {
67
+ ruleFindings = [
68
+ createFinding(rule, error instanceof Error ? error.message : String(error), null, {
69
+ code: `evaluator:${rule.evaluator.type}`,
70
+ kind: 'error',
71
+ }),
72
+ ];
73
+ }
74
+ findings.push(...ruleFindings);
75
+ fixes.push(...ruleEvalFixes);
76
+ const ruleMode = rule.fix?.mode ?? 'none';
77
+ const effectiveMode = effectiveFixMode(ruleMode, maxFixMode);
78
+ if (effectiveMode !== 'none' && ruleFindings.length > 0) {
79
+ const provider = this.fixers.get(rule.evaluator.type);
80
+ if (provider) {
81
+ const effectiveFix = {
82
+ mode: effectiveMode,
83
+ ...(rule.fix?.replacement !== undefined ? { replacement: rule.fix.replacement } : {}),
84
+ ...(rule.fix?.params !== undefined ? { params: rule.fix.params } : {}),
85
+ };
86
+ const providerFixes = await provider.createFixes({
87
+ rule,
88
+ context: { rule, workdir },
89
+ findings: ruleFindings,
90
+ fix: effectiveFix,
91
+ });
92
+ fixes.push(...providerFixes);
93
+ }
94
+ }
95
+ }
96
+ return { findings, fixes };
97
+ }
98
+ /**
99
+ * Apply or preview candidate byte-range fixes.
100
+ *
101
+ * @param workdir - Working directory that fix file paths are relative to.
102
+ * @param fixes - Fixes to apply.
103
+ * @param dryRun - When true, return a diff without writing files.
104
+ * @returns Application details and optional diff.
105
+ */
106
+ async applyFixes(workdir, fixes, dryRun = false) {
107
+ return applyFixesImpl(workdir, fixes, dryRun);
108
+ }
109
+ }
110
+ /** Return the lower-authority mode between what the rule requests and what the caller allows. */
111
+ function effectiveFixMode(ruleMode, requestedMode) {
112
+ if (requestedMode === 'none' || ruleMode === 'none')
113
+ return 'none';
114
+ return FIX_MODE_RANK[ruleMode] <= FIX_MODE_RANK[requestedMode] ? ruleMode : requestedMode;
36
115
  }
@@ -4,7 +4,7 @@ import { type ConstraintRule, type RuleContext, type RuleEvaluationResult, type
4
4
  export declare class ExitCodeEvaluator implements RuleEvaluator {
5
5
  private readonly executor;
6
6
  constructor(executor?: ProcessExecutor);
7
- /** Run configured command and emit a finding on non-zero exit. */
7
+ /** Run configured command and emit a finding unless the exit code matches `successCode`. */
8
8
  evaluate(rule: ConstraintRule, context: RuleContext): Promise<RuleEvaluationResult>;
9
9
  }
10
10
  //# sourceMappingURL=exit-code-evaluator.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"exit-code-evaluator.d.ts","sourceRoot":"","sources":["../../src/evaluators/exit-code-evaluator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,EACH,KAAK,cAAc,EAEnB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EACrB,MAAM,UAAU,CAAC;AAElB,2EAA2E;AAC3E,qBAAa,iBAAkB,YAAW,aAAa;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ;gBAAR,QAAQ,GAAE,eAA2C;IAElF,kEAAkE;IAC5D,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAe5F"}
1
+ {"version":3,"file":"exit-code-evaluator.d.ts","sourceRoot":"","sources":["../../src/evaluators/exit-code-evaluator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,EACH,KAAK,cAAc,EAEnB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EACrB,MAAM,UAAU,CAAC;AAElB,2EAA2E;AAC3E,qBAAa,iBAAkB,YAAW,aAAa;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ;gBAAR,QAAQ,GAAE,eAA2C;IAElF,4FAA4F;IACtF,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;CA2B5F"}
@@ -6,28 +6,41 @@ export class ExitCodeEvaluator {
6
6
  constructor(executor = new NodeProcessExecutor()) {
7
7
  this.executor = executor;
8
8
  }
9
- /** Run configured command and emit a finding on non-zero exit. */
9
+ /** Run configured command and emit a finding unless the exit code matches `successCode`. */
10
10
  async evaluate(rule, context) {
11
11
  const config = rule.evaluator.config ?? {};
12
12
  const command = stringConfig(config, 'command');
13
13
  const args = arrayConfig(config, 'args', []);
14
- const result = await this.executor.run({ command, args, cwd: context.workdir, rejectOnError: false });
15
- if (result.exitCode === 0)
14
+ const successCode = numberConfig(config, 'successCode', 0);
15
+ const timeout = numberConfig(config, 'timeout', 60_000);
16
+ const result = await this.executor.run({
17
+ command,
18
+ args,
19
+ cwd: context.workdir,
20
+ timeout,
21
+ rejectOnError: false,
22
+ label: 'exit-code',
23
+ });
24
+ if (result.exitCode === successCode)
16
25
  return { findings: [], fixes: [] };
26
+ const template = stringConfig(config, 'message', `Command failed (exit {code}): ${command} ${args.join(' ')}`.trim());
27
+ const message = template.replaceAll('{code}', String(result.exitCode));
17
28
  return {
18
- findings: [
19
- createFinding(rule, `Command failed: ${command} ${args.join(' ')}`.trim(), null, {
20
- code: 'exit-code:failed',
21
- }),
22
- ],
29
+ findings: [createFinding(rule, message, null, { code: 'exit-code:failed' })],
23
30
  fixes: [],
24
31
  };
25
32
  }
26
33
  }
27
- function stringConfig(config, key) {
34
+ function numberConfig(config, key, fallback) {
35
+ const value = config[key];
36
+ return typeof value === 'number' && Number.isFinite(value) ? value : fallback;
37
+ }
38
+ function stringConfig(config, key, fallback) {
28
39
  const value = config[key];
29
40
  if (typeof value === 'string')
30
41
  return value;
42
+ if (fallback !== undefined)
43
+ return fallback;
31
44
  throw new Error(`exit-code evaluator requires string config "${key}"`);
32
45
  }
33
46
  function arrayConfig(config, key, fallback) {
@@ -1,8 +1,21 @@
1
1
  import { type ConstraintRule, type RuleContext, type RuleEvaluationResult, type RuleEvaluator } from '../types';
2
- /** Detects imports matching forbidden package or path prefixes. */
2
+ /**
3
+ * Detects forbidden imports / API usage.
4
+ *
5
+ * Two config shapes are supported:
6
+ * - Simple: `{ patterns: string[] }` — substring match against any import specifier,
7
+ * scoped by the rule's own `include` / `exclude`.
8
+ * - Structured: `{ forbidden: [...], scope: { include, exclude } }` — each forbidden
9
+ * entry is an exact `specifier` (also matching require/dynamic forms unless
10
+ * `includeRequire:false`) or a raw `pattern`, scoped by `scope.include` /
11
+ * `scope.exclude` globs.
12
+ */
3
13
  export declare class ForbiddenImportEvaluator implements RuleEvaluator {
4
- constructor();
5
- /** Evaluate import declarations against configured forbidden prefixes. */
14
+ /** Evaluate import/usage against the configured forbidden set. */
6
15
  evaluate(rule: ConstraintRule, context: RuleContext): Promise<RuleEvaluationResult>;
16
+ /** Legacy path: `{ patterns: string[] }`, substring-matched against import specifiers. */
17
+ private evaluateSimple;
18
+ /** Structured path: `{ forbidden: [...], scope: { include, exclude } }`. */
19
+ private evaluateStructured;
7
20
  }
8
21
  //# sourceMappingURL=forbidden-import-evaluator.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"forbidden-import-evaluator.d.ts","sourceRoot":"","sources":["../../src/evaluators/forbidden-import-evaluator.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,cAAc,EAEnB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EACrB,MAAM,UAAU,CAAC;AAGlB,mEAAmE;AACnE,qBAAa,wBAAyB,YAAW,aAAa;;IAG1D,0EAA0E;IACpE,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;CA4B5F"}
1
+ {"version":3,"file":"forbidden-import-evaluator.d.ts","sourceRoot":"","sources":["../../src/evaluators/forbidden-import-evaluator.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,cAAc,EAEnB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EACrB,MAAM,UAAU,CAAC;AAclB;;;;;;;;;;GAUG;AACH,qBAAa,wBAAyB,YAAW,aAAa;IAC1D,kEAAkE;IAC5D,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAOzF,0FAA0F;YAC5E,cAAc;IA+B5B,4EAA4E;YAC9D,kBAAkB;CAoCnC"}
@@ -1,11 +1,26 @@
1
1
  import { createFinding, } from '../types.js';
2
- import { discoverFiles, readWorkdirFile } from './file-utils.js';
3
- /** Detects imports matching forbidden package or path prefixes. */
2
+ import { discoverFiles, matchesGlob, readWorkdirFile } from './file-utils.js';
3
+ /**
4
+ * Detects forbidden imports / API usage.
5
+ *
6
+ * Two config shapes are supported:
7
+ * - Simple: `{ patterns: string[] }` — substring match against any import specifier,
8
+ * scoped by the rule's own `include` / `exclude`.
9
+ * - Structured: `{ forbidden: [...], scope: { include, exclude } }` — each forbidden
10
+ * entry is an exact `specifier` (also matching require/dynamic forms unless
11
+ * `includeRequire:false`) or a raw `pattern`, scoped by `scope.include` /
12
+ * `scope.exclude` globs.
13
+ */
4
14
  export class ForbiddenImportEvaluator {
5
- constructor() { }
6
- /** Evaluate import declarations against configured forbidden prefixes. */
15
+ /** Evaluate import/usage against the configured forbidden set. */
7
16
  async evaluate(rule, context) {
8
17
  const config = rule.evaluator.config ?? {};
18
+ return Array.isArray(config.forbidden)
19
+ ? this.evaluateStructured(rule, context, config)
20
+ : this.evaluateSimple(rule, context, config);
21
+ }
22
+ /** Legacy path: `{ patterns: string[] }`, substring-matched against import specifiers. */
23
+ async evaluateSimple(rule, context, config) {
9
24
  const forbidden = arrayConfig(config, 'patterns');
10
25
  const files = await discoverFiles({
11
26
  workdir: context.workdir,
@@ -16,8 +31,7 @@ export class ForbiddenImportEvaluator {
16
31
  for (const file of files) {
17
32
  const lines = (await readWorkdirFile(context.workdir, file)).split('\n');
18
33
  for (const [index, line] of lines.entries()) {
19
- const imported = /(?:from\s+|import\s*\(|^\s*import\s*)['"](?<specifier>[^'"]+)['"]/.exec(line)?.groups
20
- ?.specifier;
34
+ const imported = importSpecifier(line);
21
35
  if (imported === undefined)
22
36
  continue;
23
37
  const matched = forbidden.find((pattern) => imported.includes(pattern));
@@ -31,6 +45,54 @@ export class ForbiddenImportEvaluator {
31
45
  }
32
46
  return { findings, fixes: [] };
33
47
  }
48
+ /** Structured path: `{ forbidden: [...], scope: { include, exclude } }`. */
49
+ async evaluateStructured(rule, context, config) {
50
+ const scope = config.scope;
51
+ const include = stringArray(scope?.include);
52
+ if (include === undefined) {
53
+ throw new Error('forbidden-import evaluator requires string[] config "scope.include"');
54
+ }
55
+ const exclude = stringArray(scope?.exclude) ?? [];
56
+ const entries = config.forbidden.map(compileEntry);
57
+ // Discover all source files, then apply scope globs precisely (discoverFiles'
58
+ // include matching is intentionally loose, so it cannot do `**`-anchored scoping).
59
+ const files = (await discoverFiles({ workdir: context.workdir }))
60
+ .filter((file) => include.some((glob) => matchesGlob(file, glob)))
61
+ .filter((file) => !exclude.some((glob) => matchesGlob(file, glob)));
62
+ const findings = [];
63
+ for (const file of files) {
64
+ const lines = (await readWorkdirFile(context.workdir, file)).split('\n');
65
+ for (const [index, line] of lines.entries()) {
66
+ const hit = entries.find((entry) => entry.regex.test(line));
67
+ if (hit !== undefined) {
68
+ findings.push(createFinding(rule, `Forbidden import/usage of "${hit.label}"`, file, {
69
+ line: index + 1,
70
+ code: 'import:forbidden',
71
+ }));
72
+ }
73
+ }
74
+ }
75
+ return { findings, fixes: [] };
76
+ }
77
+ }
78
+ /** Extract the specifier from an import/require/dynamic-import line, if any. */
79
+ function importSpecifier(line) {
80
+ return /(?:from\s+|import\s*\(|^\s*import\s*)['"](?<specifier>[^'"]+)['"]/.exec(line)?.groups?.specifier;
81
+ }
82
+ /** Compile a forbidden entry into a line-matching regex. */
83
+ function compileEntry(entry) {
84
+ if ('specifier' in entry) {
85
+ const spec = escapeRegExp(entry.specifier);
86
+ const boundary = `(?:/|['"])`;
87
+ const source = entry.includeRequire === false
88
+ ? `from\\s+['"]${spec}${boundary}`
89
+ : `(?:from\\s+|require\\(\\s*|import\\(\\s*)['"]${spec}${boundary}`;
90
+ return { regex: new RegExp(source), label: entry.specifier };
91
+ }
92
+ return { regex: new RegExp(entry.pattern), label: entry.pattern };
93
+ }
94
+ function escapeRegExp(value) {
95
+ return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
34
96
  }
35
97
  function arrayConfig(config, key) {
36
98
  const value = config[key];
@@ -40,3 +102,6 @@ function arrayConfig(config, key) {
40
102
  return [value];
41
103
  throw new Error(`forbidden-import evaluator requires string[] config "${key}"`);
42
104
  }
105
+ function stringArray(value) {
106
+ return Array.isArray(value) && value.every((item) => typeof item === 'string') ? value : undefined;
107
+ }
@@ -0,0 +1,19 @@
1
+ import { type ConstraintRule, type RuleContext, type RuleEvaluationResult, type RuleEvaluator } from '../types';
2
+ /**
3
+ * Enforces architectural import boundaries without spawning a subprocess.
4
+ *
5
+ * Files matching a boundary's `scope` glob are scanned in-memory. Each forbidden
6
+ * entry is either a string (matched as an import-specifier substring) or an object
7
+ * with a `pattern` regex and an optional `mode` (`import` | `usage`).
8
+ *
9
+ * ## Options (in `evaluator.config`)
10
+ * - `boundaries` — non-empty array of boundary declarations:
11
+ * - `scope` — glob pattern selecting files this boundary applies to.
12
+ * - `forbidden` — array of strings or `{ pattern, mode?, syntax? }` objects.
13
+ * - `exclude` — optional globs within the scope to ignore.
14
+ */
15
+ export declare class ImportBoundaryEvaluator implements RuleEvaluator {
16
+ /** Evaluate import boundaries across all in-scope files. */
17
+ evaluate(rule: ConstraintRule, context: RuleContext): Promise<RuleEvaluationResult>;
18
+ }
19
+ //# sourceMappingURL=import-boundary-evaluator.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"import-boundary-evaluator.d.ts","sourceRoot":"","sources":["../../src/evaluators/import-boundary-evaluator.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,cAAc,EAEnB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EACrB,MAAM,UAAU,CAAC;AA4BlB;;;;;;;;;;;;GAYG;AACH,qBAAa,uBAAwB,YAAW,aAAa;IACzD,4DAA4D;IACtD,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAuC5F"}
@@ -0,0 +1,85 @@
1
+ import { createFinding, } from '../types.js';
2
+ import { discoverFiles, matchesGlob, readWorkdirFile } from './file-utils.js';
3
+ /**
4
+ * Enforces architectural import boundaries without spawning a subprocess.
5
+ *
6
+ * Files matching a boundary's `scope` glob are scanned in-memory. Each forbidden
7
+ * entry is either a string (matched as an import-specifier substring) or an object
8
+ * with a `pattern` regex and an optional `mode` (`import` | `usage`).
9
+ *
10
+ * ## Options (in `evaluator.config`)
11
+ * - `boundaries` — non-empty array of boundary declarations:
12
+ * - `scope` — glob pattern selecting files this boundary applies to.
13
+ * - `forbidden` — array of strings or `{ pattern, mode?, syntax? }` objects.
14
+ * - `exclude` — optional globs within the scope to ignore.
15
+ */
16
+ export class ImportBoundaryEvaluator {
17
+ /** Evaluate import boundaries across all in-scope files. */
18
+ async evaluate(rule, context) {
19
+ const config = rule.evaluator.config ?? {};
20
+ const boundaries = config.boundaries;
21
+ if (!Array.isArray(boundaries) || boundaries.length === 0) {
22
+ throw new Error('import-boundary evaluator requires non-empty array config "boundaries"');
23
+ }
24
+ const compiled = boundaries.map((b) => compileBoundary(b));
25
+ // Discover all files once; filter per boundary below.
26
+ const allFiles = await discoverFiles({ workdir: context.workdir });
27
+ const findings = [];
28
+ for (const boundary of compiled) {
29
+ const inScope = allFiles
30
+ .filter((file) => matchesGlob(file, boundary.scope))
31
+ .filter((file) => !boundary.excludePatterns.some((ex) => matchesGlob(file, ex)));
32
+ for (const file of inScope) {
33
+ const content = await readWorkdirFile(context.workdir, file);
34
+ const lines = content.split('\n');
35
+ for (const [index, line] of lines.entries()) {
36
+ for (const entry of boundary.forbidden) {
37
+ if (entry.importOnly && !isImportLine(line))
38
+ continue;
39
+ if (entry.regex.test(line)) {
40
+ findings.push(createFinding(rule, `forbidden in boundary "${boundary.scope}": ${entry.label}`, file, {
41
+ line: index + 1,
42
+ code: 'import-boundary:violation',
43
+ }));
44
+ }
45
+ }
46
+ }
47
+ }
48
+ }
49
+ return { findings, fixes: [] };
50
+ }
51
+ }
52
+ /** Compile a raw boundary declaration into a scan-ready form. */
53
+ function compileBoundary(decl) {
54
+ return {
55
+ scope: decl.scope,
56
+ excludePatterns: decl.exclude ?? [],
57
+ forbidden: decl.forbidden.map((entry) => compileEntry(entry)),
58
+ };
59
+ }
60
+ /** Compile one forbidden entry into a regex + metadata. */
61
+ function compileEntry(entry) {
62
+ if (typeof entry === 'string') {
63
+ // String form: match as an import specifier substring.
64
+ const escaped = escapeRegExp(entry);
65
+ return {
66
+ regex: new RegExp(`(?:from\\s+|require\\(\\s*|import\\(\\s*)['"](?:[^'"]*)?${escaped}(?:[^'"]*)?['"]`),
67
+ label: entry,
68
+ importOnly: true,
69
+ };
70
+ }
71
+ // Object form with `pattern`.
72
+ const importOnly = (entry.mode ?? 'import') !== 'usage';
73
+ return {
74
+ regex: new RegExp(entry.pattern),
75
+ label: entry.pattern,
76
+ importOnly,
77
+ };
78
+ }
79
+ /** Return true when a source line is an import/export/require/dynamic-import statement. */
80
+ function isImportLine(line) {
81
+ return /(?:^\s*import\b|^\s*export\b.*\bfrom\b|(?:from|require|import)\s*\(?\s*['"])/.test(line);
82
+ }
83
+ function escapeRegExp(value) {
84
+ return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
85
+ }