@webpieces/rules-config 0.3.356 → 0.3.358

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webpieces/rules-config",
-  "version": "0.3.356",
+  "version": "0.3.358",
   "description": "Shared webpieces.config.json loader. Single source of truth for validation rule configuration consumed by @webpieces/ai-hook-rules, @webpieces/code-rules, and @webpieces/nx-webpieces-rules.",
   "type": "commonjs",
   "main": "./src/index.js",
@@ -14,8 +14,8 @@
     "README.md"
   ],
   "dependencies": {
-    "@webpieces/core-context": "0.3.356",
-    "@webpieces/core-util": "0.3.356",
+    "@webpieces/core-context": "0.3.358",
+    "@webpieces/core-util": "0.3.358",
     "@inversifyjs/binding-decorators": "1.1.5",
     "inversify": "7.10.4",
     "reflect-metadata": "0.2.2",

package/src/config-file.d.ts

@@ -9,6 +9,16 @@ export interface RawConfigFile {
     rulesDir?: string[];
     'pr-gate'?: unknown;
 }
+/**
+ * Locates + reads webpieces.config.json. `@provideSingleton` so it can be injected into the config
+ * loader and appear in the rules-config DI design.
+ */
+export declare class ConfigFile {
+    /** Walk up from `startDir` looking for webpieces.config.json. Returns its absolute path or null. */
+    findConfigFile(startDir: string): string | null;
+    /** Read + JSON.parse webpieces.config.json, surfacing parse failures as a readable InformAiError. */
+    readRawConfig(configPath: string): RawConfigFile;
+}
 /**
  * Walk up from `startDir` looking for webpieces.config.json. Returns its absolute path or null.
  */

package/src/config-file.js

@@ -1,43 +1,67 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CONFIG_FILENAME = void 0;
+exports.ConfigFile = exports.CONFIG_FILENAME = void 0;
 exports.findConfigFile = findConfigFile;
 exports.readRawConfig = readRawConfig;
 const tslib_1 = require("tslib");
 const fs = tslib_1.__importStar(require("fs"));
 const path = tslib_1.__importStar(require("path"));
+const core_context_1 = require("@webpieces/core-context");
+const inversify_1 = require("inversify");
 const inform_ai_error_1 = require("./inform-ai-error");
 const to_error_1 = require("./to-error");
 exports.CONFIG_FILENAME = 'webpieces.config.json';
+/**
+ * Locates + reads webpieces.config.json. `@provideSingleton` so it can be injected into the config
+ * loader and appear in the rules-config DI design.
+ */
+let ConfigFile = class ConfigFile {
+    /** Walk up from `startDir` looking for webpieces.config.json. Returns its absolute path or null. */
+    findConfigFile(startDir) {
+        let dir = startDir;
+        while (true) {
+            const primary = path.join(dir, exports.CONFIG_FILENAME);
+            if (fs.existsSync(primary))
+                return primary;
+            const parent = path.dirname(dir);
+            if (parent === dir)
+                return null;
+            dir = parent;
+        }
+    }
+    /** Read + JSON.parse webpieces.config.json, surfacing parse failures as a readable InformAiError. */
+    readRawConfig(configPath) {
+        const raw = fs.readFileSync(configPath, 'utf8');
+        // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
+        try {
+            return JSON.parse(raw);
+        }
+        catch (err) {
+            const error = (0, to_error_1.toError)(err);
+            throw new inform_ai_error_1.InformAiError(`webpieces.config.json has invalid JSON — fix the file, then retry.\n` +
+                `Parse error: ${error.message}\n` +
+                `File: ${configPath}`);
+        }
+    }
+};
+exports.ConfigFile = ConfigFile;
+exports.ConfigFile = ConfigFile = tslib_1.__decorate([
+    (0, core_context_1.provideSingleton)(),
+    (0, inversify_1.injectable)()
+], ConfigFile);
+// Temporary migration delegators — consumers migrate to injecting ConfigFile over follow-up PRs, then
+// these free functions are removed. Declarations kept identical to the originals (unchanged lines).
+const configFileSvc = new ConfigFile();
 /**
  * Walk up from `startDir` looking for webpieces.config.json. Returns its absolute path or null.
  */
 function findConfigFile(startDir) {
-    let dir = startDir;
-    while (true) {
-        const primary = path.join(dir, exports.CONFIG_FILENAME);
-        if (fs.existsSync(primary))
-            return primary;
-        const parent = path.dirname(dir);
-        if (parent === dir)
-            return null;
-        dir = parent;
-    }
+    return configFileSvc.findConfigFile(startDir);
 }
 /**
  * Read + JSON.parse webpieces.config.json, surfacing parse failures as a readable InformAiError.
  */
 function readRawConfig(configPath) {
-    const raw = fs.readFileSync(configPath, 'utf8');
-    // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
-    try {
-        return JSON.parse(raw);
-    }
-    catch (err) {
-        const error = (0, to_error_1.toError)(err);
-        throw new inform_ai_error_1.InformAiError(`webpieces.config.json has invalid JSON — fix the file, then retry.\n` +
-            `Parse error: ${error.message}\n` +
-            `File: ${configPath}`);
-    }
+    return configFileSvc.readRawConfig(configPath);
 }
 //# sourceMappingURL=config-file.js.map

package/src/config-file.js.map

@@ -1 +1 @@
-{"version":3,"file":"config-file.js","sourceRoot":"","sources":["../../../../../packages/tooling/rules-config/src/config-file.ts"],"names":[],"mappings":";;;AAuCA,wCASC;AAKD,sCAaC;;AAlED,+CAAyB;AACzB,mDAA6B;AAE7B,uDAAkD;AAClD,yCAAqC;AAExB,QAAA,eAAe,GAAG,uBAAuB,CAAC;AA8BvD;;GAEG;AACH,SAAgB,cAAc,CAAC,QAAgB;IAC3C,IAAI,GAAG,GAAG,QAAQ,CAAC;IACnB,OAAO,IAAI,EAAE,CAAC;QACV,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,uBAAe,CAAC,CAAC;QAChD,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;YAAE,OAAO,OAAO,CAAC;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,MAAM,KAAK,GAAG;YAAE,OAAO,IAAI,CAAC;QAChC,GAAG,GAAG,MAAM,CAAC;IACjB,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,aAAa,CAAC,UAAkB;IAC5C,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAChD,8DAA8D;IAC9D,IAAI,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAkB,CAAC;IAC5C,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACpB,MAAM,KAAK,GAAG,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC;QAC3B,MAAM,IAAI,+BAAa,CACnB,sEAAsE;YACtE,gBAAgB,KAAK,CAAC,OAAO,IAAI;YACjC,SAAS,UAAU,EAAE,CACxB,CAAC;IACN,CAAC;AACL,CAAC","sourcesContent":["import * as fs from 'fs';\nimport * as path from 'path';\n\nimport { InformAiError } from './inform-ai-error';\nimport { toError } from './to-error';\n\nexport const CONFIG_FILENAME = 'webpieces.config.json';\n\n// Raw shape of webpieces.config.json as parsed from JSON, before validation/typing.\n//  - `rules`      — code-style validators (scope edit/file).\n//  - `hookGuards` — git/PR/branch protection guards (scope bash).\n//  - `commands`   — gated command config the guards point at; `pr-gate` lives inside it. Carried as\n//                   opaque JSON because its nested `gates` array can't be expressed in the FieldDef\n//                   schema; validated structurally by validateCommandsSection.\n//  - `pr-gate`    — DEPRECATED top-level block (pre-migration layout). Read only as a back-compat\n//                   fallback / to emit a \"move it under commands\" migration error.\n// webpieces-disable no-any-unknown -- consumer JSON config has opaque rule option values\nexport interface RawConfigFile {\n    extends?: string;\n    rules?: Record<string, Record<string, unknown>>;\n    hookGuards?: Record<string, Record<string, unknown>>;\n    // webpieces-disable no-any-unknown -- opaque commands JSON, validated by validateCommandsSection\n    commands?: unknown;\n    // REQUIRED top-level block: two glob lists that suppress hook enforcement per file path.\n    // Opaque here (validated structurally by validateExcludePaths, then parsed into ExcludePaths).\n    // webpieces-disable no-any-unknown -- opaque excludePaths JSON, validated by validateExcludePaths\n    excludePaths?: unknown;\n    // REQUIRED top-level array of client-authored content guards (regex patterns + message + scoping).\n    // Opaque here; validated structurally by validateMatchRulesSection, then parsed into MatchRuleConfig[].\n    // webpieces-disable no-any-unknown -- opaque match-rules JSON, validated by validateMatchRulesSection\n    'match-rules'?: unknown;\n    rulesDir?: string[];\n    // webpieces-disable no-any-unknown -- DEPRECATED top-level pr-gate, migrated under `commands`\n    'pr-gate'?: unknown;\n}\n\n/**\n * Walk up from `startDir` looking for webpieces.config.json. Returns its absolute path or null.\n */\nexport function findConfigFile(startDir: string): string | null {\n    let dir = startDir;\n    while (true) {\n        const primary = path.join(dir, CONFIG_FILENAME);\n        if (fs.existsSync(primary)) return primary;\n        const parent = path.dirname(dir);\n        if (parent === dir) return null;\n        dir = parent;\n    }\n}\n\n/**\n * Read + JSON.parse webpieces.config.json, surfacing parse failures as a readable InformAiError.\n */\nexport function readRawConfig(configPath: string): RawConfigFile {\n    const raw = fs.readFileSync(configPath, 'utf8');\n    // eslint-disable-next-line @webpieces/no-unmanaged-exceptions\n    try {\n        return JSON.parse(raw) as RawConfigFile;\n    } catch (err: unknown) {\n        const error = toError(err);\n        throw new InformAiError(\n            `webpieces.config.json has invalid JSON — fix the file, then retry.\\n` +\n            `Parse error: ${error.message}\\n` +\n            `File: ${configPath}`,\n        );\n    }\n}\n"]}
+{"version":3,"file":"config-file.js","sourceRoot":"","sources":["../../../../../packages/tooling/rules-config/src/config-file.ts"],"names":[],"mappings":";;;AAiFA,wCAEC;AAKD,sCAEC;;AA1FD,+CAAyB;AACzB,mDAA6B;AAC7B,0DAA2D;AAC3D,yCAAuC;AAEvC,uDAAkD;AAClD,yCAAqC;AAExB,QAAA,eAAe,GAAG,uBAAuB,CAAC;AA8BvD;;;GAGG;AAGI,IAAM,UAAU,GAAhB,MAAM,UAAU;IACnB,oGAAoG;IACpG,cAAc,CAAC,QAAgB;QAC3B,IAAI,GAAG,GAAG,QAAQ,CAAC;QACnB,OAAO,IAAI,EAAE,CAAC;YACV,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,uBAAe,CAAC,CAAC;YAChD,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;gBAAE,OAAO,OAAO,CAAC;YAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,MAAM,KAAK,GAAG;gBAAE,OAAO,IAAI,CAAC;YAChC,GAAG,GAAG,MAAM,CAAC;QACjB,CAAC;IACL,CAAC;IAED,qGAAqG;IACrG,aAAa,CAAC,UAAkB;QAC5B,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAChD,8DAA8D;QAC9D,IAAI,CAAC;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAkB,CAAC;QAC5C,CAAC;QAAC,OAAO,GAAY,EAAE,CAAC;YACpB,MAAM,KAAK,GAAG,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC;YAC3B,MAAM,IAAI,+BAAa,CACnB,sEAAsE;gBACtE,gBAAgB,KAAK,CAAC,OAAO,IAAI;gBACjC,SAAS,UAAU,EAAE,CACxB,CAAC;QACN,CAAC;IACL,CAAC;CACJ,CAAA;AA5BY,gCAAU;qBAAV,UAAU;IAFtB,IAAA,+BAAgB,GAAE;IAClB,IAAA,sBAAU,GAAE;GACA,UAAU,CA4BtB;AAED,sGAAsG;AACtG,oGAAoG;AACpG,MAAM,aAAa,GAAG,IAAI,UAAU,EAAE,CAAC;AAEvC;;GAEG;AACH,SAAgB,cAAc,CAAC,QAAgB;IAC3C,OAAO,aAAa,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,SAAgB,aAAa,CAAC,UAAkB;IAC5C,OAAO,aAAa,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AACnD,CAAC","sourcesContent":["import * as fs from 'fs';\nimport * as path from 'path';\nimport { provideSingleton } from '@webpieces/core-context';\nimport { injectable } from 'inversify';\n\nimport { InformAiError } from './inform-ai-error';\nimport { toError } from './to-error';\n\nexport const CONFIG_FILENAME = 'webpieces.config.json';\n\n// Raw shape of webpieces.config.json as parsed from JSON, before validation/typing.\n//  - `rules`      — code-style validators (scope edit/file).\n//  - `hookGuards` — git/PR/branch protection guards (scope bash).\n//  - `commands`   — gated command config the guards point at; `pr-gate` lives inside it. Carried as\n//                   opaque JSON because its nested `gates` array can't be expressed in the FieldDef\n//                   schema; validated structurally by validateCommandsSection.\n//  - `pr-gate`    — DEPRECATED top-level block (pre-migration layout). Read only as a back-compat\n//                   fallback / to emit a \"move it under commands\" migration error.\n// webpieces-disable no-any-unknown -- consumer JSON config has opaque rule option values\nexport interface RawConfigFile {\n    extends?: string;\n    rules?: Record<string, Record<string, unknown>>;\n    hookGuards?: Record<string, Record<string, unknown>>;\n    // webpieces-disable no-any-unknown -- opaque commands JSON, validated by validateCommandsSection\n    commands?: unknown;\n    // REQUIRED top-level block: two glob lists that suppress hook enforcement per file path.\n    // Opaque here (validated structurally by validateExcludePaths, then parsed into ExcludePaths).\n    // webpieces-disable no-any-unknown -- opaque excludePaths JSON, validated by validateExcludePaths\n    excludePaths?: unknown;\n    // REQUIRED top-level array of client-authored content guards (regex patterns + message + scoping).\n    // Opaque here; validated structurally by validateMatchRulesSection, then parsed into MatchRuleConfig[].\n    // webpieces-disable no-any-unknown -- opaque match-rules JSON, validated by validateMatchRulesSection\n    'match-rules'?: unknown;\n    rulesDir?: string[];\n    // webpieces-disable no-any-unknown -- DEPRECATED top-level pr-gate, migrated under `commands`\n    'pr-gate'?: unknown;\n}\n\n/**\n * Locates + reads webpieces.config.json. `@provideSingleton` so it can be injected into the config\n * loader and appear in the rules-config DI design.\n */\n@provideSingleton()\n@injectable()\nexport class ConfigFile {\n    /** Walk up from `startDir` looking for webpieces.config.json. Returns its absolute path or null. */\n    findConfigFile(startDir: string): string | null {\n        let dir = startDir;\n        while (true) {\n            const primary = path.join(dir, CONFIG_FILENAME);\n            if (fs.existsSync(primary)) return primary;\n            const parent = path.dirname(dir);\n            if (parent === dir) return null;\n            dir = parent;\n        }\n    }\n\n    /** Read + JSON.parse webpieces.config.json, surfacing parse failures as a readable InformAiError. */\n    readRawConfig(configPath: string): RawConfigFile {\n        const raw = fs.readFileSync(configPath, 'utf8');\n        // eslint-disable-next-line @webpieces/no-unmanaged-exceptions\n        try {\n            return JSON.parse(raw) as RawConfigFile;\n        } catch (err: unknown) {\n            const error = toError(err);\n            throw new InformAiError(\n                `webpieces.config.json has invalid JSON — fix the file, then retry.\\n` +\n                `Parse error: ${error.message}\\n` +\n                `File: ${configPath}`,\n            );\n        }\n    }\n}\n\n// Temporary migration delegators — consumers migrate to injecting ConfigFile over follow-up PRs, then\n// these free functions are removed. Declarations kept identical to the originals (unchanged lines).\nconst configFileSvc = new ConfigFile();\n\n/**\n * Walk up from `startDir` looking for webpieces.config.json. Returns its absolute path or null.\n */\nexport function findConfigFile(startDir: string): string | null {\n    return configFileSvc.findConfigFile(startDir);\n}\n\n/**\n * Read + JSON.parse webpieces.config.json, surfacing parse failures as a readable InformAiError.\n */\nexport function readRawConfig(configPath: string): RawConfigFile {\n    return configFileSvc.readRawConfig(configPath);\n}\n"]}

package/src/diff-scope.d.ts

@@ -1,13 +1,10 @@
 /**
- * Shared git-diff + diff-scoping helpers for ALL rule validators (code-rules) and nx executors
- * (nx-webpieces-rules). Centralized here in rules-config because it is the one package both of
- * those depend on, and it already shells out to git (see skip-rule.ts).
+ * Shared git-diff + diff-scoping service for ALL rule validators (code-rules) and nx executors
+ * (nx-webpieces-rules). Centralized here in rules-config because it is the one package both depend on.
  *
- * Before this module these functions were copy-pasted ~15× (one private copy per validator + the
- * validate-ts-in-src executor). They are now defined once; every consumer imports from
- * `@webpieces/rules-config`. The two historical variants are preserved as parameters:
- *   - `getChangedFiles(..., { tsOnly: false })` reproduces validate-dtos' all-files diff.
- *   - `detectBase` replaces both the nested-try and the ref-loop spellings (identical behavior).
+ * `@provideSingleton` so it can be injected and appear in the rules-config DI design. Free-function
+ * delegators are kept temporarily so the many existing consumers stay green; they migrate to injecting
+ * {@link DiffScope} over follow-up PRs, then the delegators are removed.
  */
 /** A git diff range: the base ref to compare against and an optional head (else the working tree). */
 export declare class DiffRange {
@@ -18,48 +15,34 @@ export declare class DiffRange {
 export declare class ChangedFilesOptions {
     tsOnly?: boolean;
 }
-/**
- * Auto-detect the diff base: the merge-base of HEAD with origin/main, falling back to local main.
- * Returns null when neither ref resolves (e.g. shallow clone with no main) — callers treat null as
- * "no base detected" and typically skip.
- */
+export declare class DiffScope {
+    /** Auto-detect the diff base: merge-base of HEAD with origin/main, falling back to local main. */
+    detectBase(workspaceRoot: string): string | null;
+    /** Resolve the diff range a rule should compare against (honors nx's NX_BASE / NX_HEAD). */
+    resolveBase(workspaceRoot: string): DiffRange;
+    /**
+     * Changed files between base and head (or base→working-tree when head is omitted). Untracked files
+     * are unioned in for the working-tree case. `tsOnly` (default true) restricts to *.ts/*.tsx and
+     * drops test files. Deletions are excluded (`--diff-filter=d`).
+     */
+    getChangedFiles(workspaceRoot: string, base: string, head?: string, opts?: ChangedFilesOptions): string[];
+    /** Diff content for a single file (synthetic all-added diff for an untracked file with no head). */
+    getFileDiff(workspaceRoot: string, file: string, base: string, head?: string): string;
+    /** Added/changed line numbers (the `+` lines per hunk) — basis of NEW_AND_MODIFIED_CODE scoping. */
+    getChangedLineNumbers(diffContent: string): Set<number>;
+    /** Method names whose signature line is a `+` addition in the diff — the basis of "NEW" methods. */
+    findNewMethodSignaturesInDiff(diffContent: string): Set<string>;
+    /** True if any line in [startLine, endLine] is in the changedLines set. */
+    hasChangesInRange(startLine: number, endLine: number, changedLines: Set<number>): boolean;
+    /** True if a node (method/function) is newly added or has any changed line in its range. */
+    isNewOrModified(name: string, startLine: number, endLine: number, changedLines: Set<number>, newMethodNames: Set<string>): boolean;
+    private isTestFile;
+}
 export declare function detectBase(workspaceRoot: string): string | null;
-/**
- * Resolve the diff range a rule should compare against. Honors nx's NX_BASE / NX_HEAD (set by
- * `nx affected --base=.. --head=..`); when NX_BASE is unset, auto-detects via detectBase. A returned
- * `base` of undefined means "could not determine a base" (caller should skip).
- */
 export declare function resolveBase(workspaceRoot: string): DiffRange;
-/**
- * Changed files between base and head (or base→working-tree when head is omitted). When head is
- * omitted, untracked files are unioned in too (matching `nx affected`). `tsOnly` (default true)
- * restricts to *.ts/*.tsx and drops test files; pass false for an all-files diff.
- *
- * Deletions are excluded (`--diff-filter=d`): every consumer reasons about a file's current
- * content or location, and a path that no longer exists can't violate anything. This also fixes
- * renames — without rename detection git reports a rename as delete+add, so filtering the delete
- * side leaves only the file's NEW path in the list.
- */
 export declare function getChangedFiles(workspaceRoot: string, base: string, head?: string, opts?: ChangedFilesOptions): string[];
-/**
- * Diff content for a single file. When the file is untracked (and no head is given) a synthetic
- * all-added diff is produced so new files count as fully-changed.
- */
 export declare function getFileDiff(workspaceRoot: string, file: string, base: string, head?: string): string;
-/**
- * Parse a unified diff and return the set of added/changed line numbers (the `+` lines per hunk).
- * This is the basis of NEW_AND_MODIFIED_CODE (line-level) scoping.
- */
 export declare function getChangedLineNumbers(diffContent: string): Set<number>;
-/**
- * Method names whose signature line is a `+` addition in the diff — the basis of "NEW" methods.
- */
 export declare function findNewMethodSignaturesInDiff(diffContent: string): Set<string>;
-/**
- * True if any line in [startLine, endLine] is in the changedLines set.
- */
 export declare function hasChangesInRange(startLine: number, endLine: number, changedLines: Set<number>): boolean;
-/**
- * True if a node (method/function) is newly added or has any changed line in its range.
- */
 export declare function isNewOrModified(name: string, startLine: number, endLine: number, changedLines: Set<number>, newMethodNames: Set<string>): boolean;