@nielspeter/eess-ts 0.1.0

package/dist/builders/cross-layer-builder.d.ts

@@ -0,0 +1,96 @@
+import type { SourceFile } from 'ts-morph';
+import type { ArchProject } from '../core/project.js';
+import type { PairCondition } from '../core/pair-condition.js';
+import type { Layer, LayerPair } from '../models/cross-layer.js';
+import { TerminalBuilder } from '@nielspeter/eess';
+/**
+ * Builder for cross-layer consistency rules.
+ *
+ * Unlike RuleBuilder<T>, this operates on pairs of elements from different layers.
+ * The chain is: `.layer()` -> `.mapping()` -> `.forEachPair()` -> `.should()` -> `.check()`
+ *
+ * @example
+ * crossLayer(project)
+ *   .layer('routes', 'src/routes/**')
+ *   .layer('schemas', 'src/schemas/**')
+ *   .mapping((a, b) => a.getBaseName().replace('Route', '') === b.getBaseName().replace('Schema', ''))
+ *   .forEachPair()
+ *   .should(haveMatchingCounterpart())
+ *   .check()
+ */
+export declare class CrossLayerBuilder {
+    private readonly project;
+    private readonly _layerDefs;
+    constructor(project: ArchProject);
+    /**
+     * Define a layer by name and glob pattern.
+     * At least two layers must be defined before calling `.mapping()`.
+     */
+    layer(name: string, pattern: string): this;
+    /**
+     * Provide a mapping function that determines which elements form pairs.
+     * The function receives one element from each layer and returns `true` if they should be paired.
+     *
+     * Requires at least 2 layers to have been defined.
+     */
+    mapping(fn: (a: SourceFile, b: SourceFile) => boolean): MappedCrossLayerBuilder;
+}
+/**
+ * Intermediate builder after `.mapping()` has been called.
+ * The layers are resolved and pairs computed.
+ */
+export declare class MappedCrossLayerBuilder {
+    private readonly layers;
+    private readonly pairs;
+    constructor(layers: Layer[], pairs: LayerPair[]);
+    /**
+     * Iterate over each matched pair. Returns a builder for attaching conditions.
+     */
+    forEachPair(): PairConditionBuilder;
+}
+/**
+ * Builder after `.forEachPair()` — attach a pair condition via `.should()`.
+ */
+export declare class PairConditionBuilder {
+    private readonly layers;
+    private readonly pairs;
+    constructor(layers: Layer[], pairs: LayerPair[]);
+    /**
+     * Attach a pair condition to evaluate against matched pairs.
+     */
+    should(condition: PairCondition): PairFinalBuilder;
+}
+/**
+ * Terminal builder — call `.check()`, `.warn()`, or `.because()`.
+ */
+export declare class PairFinalBuilder extends TerminalBuilder {
+    private readonly layers;
+    private readonly pairs;
+    private readonly condition;
+    constructor(layers: Layer[], pairs: LayerPair[], condition: PairCondition);
+    protected collectViolations(): import("@nielspeter/eess").ArchViolation[];
+}
+/**
+ * Entry point: create a cross-layer consistency rule builder.
+ *
+ * @param p - The loaded ArchProject
+ * @returns A CrossLayerBuilder — call `.layer()` at least twice, then `.mapping()`
+ *
+ * @example
+ * crossLayer(project)
+ *   .layer('routes', 'src/routes/**')
+ *   .layer('schemas', 'src/schemas/**')
+ *   .mapping((a, b) => a.getBaseName().replace('-route', '') === b.getBaseName().replace('-schema', ''))
+ *   .forEachPair()
+ *   .should(haveMatchingCounterpart())
+ *   .check()
+ *
+ * @deprecated Superseded by the kernel `correspondence()` primitive
+ * (`@nielspeter/eess`), which binds two element `Selection`s from *any* loaders
+ * (not just two globs within one project) and is the engine `crossLayer` should
+ * have been built on. `crossLayer` continues to work; new rules should prefer
+ * `correspondence({ left, right }).should().beComplete(...)`. Full internal
+ * delegation onto `correspondence()` is a follow-up (see plan 0059, Phase 3).
+ */
+export declare function crossLayer(p: ArchProject): CrossLayerBuilder;
+//# sourceMappingURL=cross-layer-builder.d.ts.map

package/dist/builders/cross-layer-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cross-layer-builder.d.ts","sourceRoot":"","sources":["../../src/builders/cross-layer-builder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAE9D,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAChE,OAAO,EAAE,eAAe,EAAmB,MAAM,kBAAkB,CAAA;AAqCnE;;;;;;;;;;;;;;GAcG;AACH,qBAAa,iBAAiB;IAGhB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAFpC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA+C;gBAE7C,OAAO,EAAE,WAAW;IAEjD;;;OAGG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAK1C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,KAAK,OAAO,GAAG,uBAAuB;CAkBhF;AAED;;;GAGG;AAEH,qBAAa,uBAAuB;IAEhC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK;gBADL,MAAM,EAAE,KAAK,EAAE,EACf,KAAK,EAAE,SAAS,EAAE;IAGrC;;OAEG;IACH,WAAW,IAAI,oBAAoB;CAGpC;AAED;;GAEG;AAEH,qBAAa,oBAAoB;IAE7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK;gBADL,MAAM,EAAE,KAAK,EAAE,EACf,KAAK,EAAE,SAAS,EAAE;IAGrC;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,aAAa,GAAG,gBAAgB;CAGnD;AAED;;GAEG;AAEH,qBAAa,gBAAiB,SAAQ,eAAe;IAEjD,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAFT,MAAM,EAAE,KAAK,EAAE,EACf,KAAK,EAAE,SAAS,EAAE,EAClB,SAAS,EAAE,aAAa;IAK3C,SAAS,CAAC,iBAAiB;CAY5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,WAAW,GAAG,iBAAiB,CAE5D"}

package/dist/builders/cross-layer-builder.js

@@ -0,0 +1,172 @@
+import picomatch from 'picomatch';
+import { TerminalBuilder, matchSelections } from '@nielspeter/eess';
+/**
+ * Resolve a layer by matching its glob against the project's source files.
+ */
+function resolveLayer(project, name, pattern) {
+    const isMatch = picomatch(pattern);
+    const files = [];
+    for (const sf of project.getSourceFiles()) {
+        if (isMatch(sf.getFilePath())) {
+            files.push(sf);
+        }
+    }
+    return { name, pattern, files };
+}
+/**
+ * Compute matched pairs between two layers using a mapping function.
+ *
+ * Delegates the matching to the kernel's shared `matchSelections()` engine (the
+ * same one `correspondence()` uses), then wraps each pair with its layer names.
+ * There is no separate cross-layer matching implementation.
+ */
+function computePairs(leftLayer, rightLayer, mappingFn) {
+    const { pairs } = matchSelections(leftLayer.files, rightLayer.files, { matchBy: mappingFn });
+    return pairs.map((p) => ({
+        left: p.left,
+        leftLayer: leftLayer.name,
+        right: p.right,
+        rightLayer: rightLayer.name,
+    }));
+}
+/**
+ * Builder for cross-layer consistency rules.
+ *
+ * Unlike RuleBuilder<T>, this operates on pairs of elements from different layers.
+ * The chain is: `.layer()` -> `.mapping()` -> `.forEachPair()` -> `.should()` -> `.check()`
+ *
+ * @example
+ * crossLayer(project)
+ *   .layer('routes', 'src/routes/**')
+ *   .layer('schemas', 'src/schemas/**')
+ *   .mapping((a, b) => a.getBaseName().replace('Route', '') === b.getBaseName().replace('Schema', ''))
+ *   .forEachPair()
+ *   .should(haveMatchingCounterpart())
+ *   .check()
+ */
+export class CrossLayerBuilder {
+    project;
+    _layerDefs = [];
+    constructor(project) {
+        this.project = project;
+    }
+    /**
+     * Define a layer by name and glob pattern.
+     * At least two layers must be defined before calling `.mapping()`.
+     */
+    layer(name, pattern) {
+        this._layerDefs.push({ name, pattern });
+        return this;
+    }
+    /**
+     * Provide a mapping function that determines which elements form pairs.
+     * The function receives one element from each layer and returns `true` if they should be paired.
+     *
+     * Requires at least 2 layers to have been defined.
+     */
+    mapping(fn) {
+        if (this._layerDefs.length < 2) {
+            throw new RangeError('CrossLayerBuilder requires at least 2 layers before calling .mapping()');
+        }
+        // Resolve all layers
+        const layers = this._layerDefs.map((def) => resolveLayer(this.project, def.name, def.pattern));
+        // Compute pairs between consecutive layers
+        const allPairs = [];
+        for (let i = 0; i < layers.length - 1; i++) {
+            const left = layers[i];
+            const right = layers[i + 1];
+            if (left && right)
+                allPairs.push(...computePairs(left, right, fn));
+        }
+        return new MappedCrossLayerBuilder(layers, allPairs);
+    }
+}
+/**
+ * Intermediate builder after `.mapping()` has been called.
+ * The layers are resolved and pairs computed.
+ */
+// eess-exclude eess/no-unused-exports: return type of the exported CrossLayerBuilder.mapping() fluent-chain method (must stay exported for declaration emit)
+export class MappedCrossLayerBuilder {
+    layers;
+    pairs;
+    constructor(layers, pairs) {
+        this.layers = layers;
+        this.pairs = pairs;
+    }
+    /**
+     * Iterate over each matched pair. Returns a builder for attaching conditions.
+     */
+    forEachPair() {
+        return new PairConditionBuilder(this.layers, this.pairs);
+    }
+}
+/**
+ * Builder after `.forEachPair()` — attach a pair condition via `.should()`.
+ */
+// eess-exclude eess/no-unused-exports: return type of the exported MappedCrossLayerBuilder.forEachPair() fluent-chain method (must stay exported for declaration emit)
+export class PairConditionBuilder {
+    layers;
+    pairs;
+    constructor(layers, pairs) {
+        this.layers = layers;
+        this.pairs = pairs;
+    }
+    /**
+     * Attach a pair condition to evaluate against matched pairs.
+     */
+    should(condition) {
+        return new PairFinalBuilder(this.layers, this.pairs, condition);
+    }
+}
+/**
+ * Terminal builder — call `.check()`, `.warn()`, or `.because()`.
+ */
+// eess-exclude eess/no-unused-exports: return type of the exported PairConditionBuilder.should() fluent-chain method (must stay exported for declaration emit)
+export class PairFinalBuilder extends TerminalBuilder {
+    layers;
+    pairs;
+    condition;
+    constructor(layers, pairs, condition) {
+        super();
+        this.layers = layers;
+        this.pairs = pairs;
+        this.condition = condition;
+    }
+    collectViolations() {
+        const layerNames = this.layers.map((l) => l.name);
+        const context = {
+            rule: `cross-layer [${layerNames.join(', ')}] should ${this.condition.description}`,
+            because: this._reason,
+            ruleId: this._metadata?.id,
+            suggestion: this._metadata?.suggestion,
+            docs: this._metadata?.docs,
+        };
+        return this.condition.evaluate(this.pairs, context);
+    }
+}
+/**
+ * Entry point: create a cross-layer consistency rule builder.
+ *
+ * @param p - The loaded ArchProject
+ * @returns A CrossLayerBuilder — call `.layer()` at least twice, then `.mapping()`
+ *
+ * @example
+ * crossLayer(project)
+ *   .layer('routes', 'src/routes/**')
+ *   .layer('schemas', 'src/schemas/**')
+ *   .mapping((a, b) => a.getBaseName().replace('-route', '') === b.getBaseName().replace('-schema', ''))
+ *   .forEachPair()
+ *   .should(haveMatchingCounterpart())
+ *   .check()
+ *
+ * @deprecated Superseded by the kernel `correspondence()` primitive
+ * (`@nielspeter/eess`), which binds two element `Selection`s from *any* loaders
+ * (not just two globs within one project) and is the engine `crossLayer` should
+ * have been built on. `crossLayer` continues to work; new rules should prefer
+ * `correspondence({ left, right }).should().beComplete(...)`. Full internal
+ * delegation onto `correspondence()` is a follow-up (see plan 0059, Phase 3).
+ */
+export function crossLayer(p) {
+    return new CrossLayerBuilder(p);
+}
+//# sourceMappingURL=cross-layer-builder.js.map

package/dist/builders/cross-layer-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cross-layer-builder.js","sourceRoot":"","sources":["../../src/builders/cross-layer-builder.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAA;AAMjC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAEnE;;GAEG;AACH,SAAS,YAAY,CAAC,OAAoB,EAAE,IAAY,EAAE,OAAe;IACvE,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAA;IAClC,MAAM,KAAK,GAAiB,EAAE,CAAA;IAC9B,KAAK,MAAM,EAAE,IAAI,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAChB,CAAC;IACH,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;AACjC,CAAC;AAED;;;;;;GAMG;AACH,SAAS,YAAY,CACnB,SAAgB,EAChB,UAAiB,EACjB,SAAoD;IAEpD,MAAM,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAA;IAC5F,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,SAAS,EAAE,SAAS,CAAC,IAAI;QACzB,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,UAAU,EAAE,UAAU,CAAC,IAAI;KAC5B,CAAC,CAAC,CAAA;AACL,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,iBAAiB;IAGC;IAFZ,UAAU,GAA6C,EAAE,CAAA;IAE1E,YAA6B,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;IAAG,CAAC;IAErD;;;OAGG;IACH,KAAK,CAAC,IAAY,EAAE,OAAe;QACjC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;QACvC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,EAA6C;QACnD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,UAAU,CAAC,wEAAwE,CAAC,CAAA;QAChG,CAAC;QAED,qBAAqB;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAA;QAE9F,2CAA2C;QAC3C,MAAM,QAAQ,GAAgB,EAAE,CAAA;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;YACtB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YAC3B,IAAI,IAAI,IAAI,KAAK;gBAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAA;QACpE,CAAC;QAED,OAAO,IAAI,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACtD,CAAC;CACF;AAED;;;GAGG;AACH,6JAA6J;AAC7J,MAAM,OAAO,uBAAuB;IAEf;IACA;IAFnB,YACmB,MAAe,EACf,KAAkB;QADlB,WAAM,GAAN,MAAM,CAAS;QACf,UAAK,GAAL,KAAK,CAAa;IAClC,CAAC;IAEJ;;OAEG;IACH,WAAW;QACT,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IAC1D,CAAC;CACF;AAED;;GAEG;AACH,uKAAuK;AACvK,MAAM,OAAO,oBAAoB;IAEZ;IACA;IAFnB,YACmB,MAAe,EACf,KAAkB;QADlB,WAAM,GAAN,MAAM,CAAS;QACf,UAAK,GAAL,KAAK,CAAa;IAClC,CAAC;IAEJ;;OAEG;IACH,MAAM,CAAC,SAAwB;QAC7B,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;IACjE,CAAC;CACF;AAED;;GAEG;AACH,+JAA+J;AAC/J,MAAM,OAAO,gBAAiB,SAAQ,eAAe;IAEhC;IACA;IACA;IAHnB,YACmB,MAAe,EACf,KAAkB,EAClB,SAAwB;QAEzC,KAAK,EAAE,CAAA;QAJU,WAAM,GAAN,MAAM,CAAS;QACf,UAAK,GAAL,KAAK,CAAa;QAClB,cAAS,GAAT,SAAS,CAAe;IAG3C,CAAC;IAES,iBAAiB;QACzB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QACjD,MAAM,OAAO,GAAqB;YAChC,IAAI,EAAE,gBAAgB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE;YACnF,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE;YAC1B,UAAU,EAAE,IAAI,CAAC,SAAS,EAAE,UAAU;YACtC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI;SAC3B,CAAA;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACrD,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,UAAU,CAAC,CAAc;IACvC,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAA;AACjC,CAAC"}

package/dist/builders/function-rule-builder.d.ts

@@ -0,0 +1,198 @@
+import type { ArchProject } from '../core/project.js';
+import type { Condition } from '@nielspeter/eess';
+import { RuleBuilder } from '@nielspeter/eess';
+import type { ExpressionMatcher } from '../helpers/matchers.js';
+import type { ArchFunction } from '../models/arch-function.js';
+import type { ArchPattern } from '../helpers/pattern.js';
+import type { TypeMatcher } from '../helpers/type-matchers.js';
+/**
+ * Rule builder for function-level architecture rules.
+ *
+ * Operates on both FunctionDeclarations and const arrow functions,
+ * unified through the ArchFunction model.
+ *
+ * @example
+ * ```typescript
+ * // All parseXxxOrder functions should not exist
+ * functions(project)
+ *   .that().haveNameMatching(/^parse\w+Order$/)
+ *   .should(notExist())
+ *   .because('use shared parseOrder() utility instead')
+ *   .check()
+ *
+ * // No function should have more than 5 parameters
+ * functions(project)
+ *   .that().haveParameterCountGreaterThan(5)
+ *   .should(notExist())
+ *   .because('functions with many parameters are hard to use')
+ *   .check()
+ *
+ * // All exported async functions should have names starting with a verb
+ * functions(project)
+ *   .that().areExported().and().areAsync()
+ *   .should().haveNameMatching(/^(get|find|create|update|delete|fetch|load|save)/)
+ *   .because('async functions should use verb prefixes')
+ *   .check()
+ * ```
+ */
+export declare class FunctionRuleBuilder extends RuleBuilder<ArchFunction, ArchProject> {
+    protected getElements(): ArchFunction[];
+    /**
+     * After `.that()`: filter functions whose name matches the pattern.
+     * After `.should()`: assert matched functions have names matching the pattern.
+     */
+    haveNameMatching(pattern: RegExp | string): this;
+    /** Filter to functions whose name starts with the given prefix. */
+    haveNameStartingWith(prefix: string): this;
+    /** Filter to functions whose name ends with the given suffix. */
+    haveNameEndingWith(suffix: string): this;
+    /**
+     * After `.that()`: filter functions in a file matching the glob.
+     * After `.should()`: assert functions reside in a file matching the glob.
+     */
+    resideInFile(glob: string): this;
+    /**
+     * After `.that()`: filter functions in a folder matching the glob.
+     * After `.should()`: assert functions reside in a folder matching the glob.
+     */
+    resideInFolder(glob: string): this;
+    /** Filter to functions that are exported from their module. */
+    areExported(): this;
+    /** Filter to functions that are NOT exported from their module. */
+    areNotExported(): this;
+    /**
+     * Filter to public functions. Class methods match when `public` or
+     * unmarked; standalone and arrow functions are always public.
+     */
+    arePublic(): this;
+    /** Filter to `protected` class methods (standalone functions never match). */
+    areProtected(): this;
+    /** Filter to `private` class methods (standalone functions never match). */
+    arePrivate(): this;
+    /** Filter to functions declared with the `async` keyword. */
+    areAsync(): this;
+    /** Filter to functions NOT declared `async`. */
+    areNotAsync(): this;
+    /** Filter to functions that declare exactly `n` parameters. */
+    haveParameterCount(n: number): this;
+    /** Filter to functions that declare more than `n` parameters. */
+    haveParameterCountGreaterThan(n: number): this;
+    /** Filter to functions that declare fewer than `n` parameters. */
+    haveParameterCountLessThan(n: number): this;
+    /** Filter to functions that declare a parameter with the given exact name. */
+    haveParameterNamed(name: string): this;
+    /**
+     * Filter to functions whose return type text matches the pattern
+     * (e.g. `/Promise</`, `'void'`). A string is compiled to a RegExp.
+     */
+    haveReturnType(pattern: RegExp | string): this;
+    /** Filter to functions that declare a rest parameter (`...args`). */
+    haveRestParameter(): this;
+    /** Filter to functions with at least one optional (`x?`) or default-valued parameter. */
+    haveOptionalParameter(): this;
+    /**
+     * Filter to functions whose parameter at `index` has a type satisfying
+     * the matcher. Out-of-bounds indices never match; for a rest parameter
+     * the type is the array type (e.g. `string[]`).
+     */
+    haveParameterOfType(index: number, matcher: TypeMatcher): this;
+    /** Filter to functions with at least one parameter whose name matches the regex. */
+    haveParameterNameMatching(pattern: RegExp): this;
+    /**
+     * Register a condition. Public API for passing standalone conditions
+     * (like notExist(), beExported()) into the builder chain.
+     */
+    withCondition(condition: Condition<ArchFunction>): this;
+    /**
+     * The filtered function set must be empty.
+     */
+    notExist(): this;
+    /**
+     * Functions must be exported from their module.
+     */
+    beExported(): this;
+    /**
+     * Functions must be async.
+     */
+    beAsync(): this;
+    /** @deprecated Use `haveNameMatching()` after `.should()` instead. */
+    conditionHaveNameMatching(pattern: RegExp): this;
+    /**
+     * Assert that at least one parameter has a type matching the given matcher.
+     *
+     * **Scope note:** Scans only the function's own parameter list.
+     * Unlike the class-level counterpart, does NOT scan set accessors
+     * because `collectFunctions()` excludes them.
+     */
+    acceptParameterOfType(matcher: TypeMatcher): this;
+    /**
+     * Assert that NO parameter has a type matching the given matcher.
+     * Reports one violation per matching parameter.
+     *
+     * **Scope note:** Scans only the function's own parameter list.
+     * Unlike the class-level counterpart, does NOT scan set accessors
+     * because `collectFunctions()` excludes them.
+     */
+    notAcceptParameterOfType(matcher: TypeMatcher): this;
+    /**
+     * Assert that the function's return type satisfies the given TypeMatcher.
+     *
+     * Uses TypeMatcher for composability with `isString()`, `matching()`,
+     * `not()`, `exactly()`, etc.
+     *
+     * @example
+     * functions(project)
+     *   .that().haveNameMatching(/^list/)
+     *   .should().haveReturnTypeMatching(matching(/Collection/))
+     *   .check()
+     */
+    haveReturnTypeMatching(matcher: TypeMatcher): this;
+    /**
+     * Assert that the function body contains at least one match.
+     */
+    contain(matcher: ExpressionMatcher): this;
+    /**
+     * Assert that the function body does NOT contain any match.
+     * Produces one violation per matching node found.
+     */
+    notContain(matcher: ExpressionMatcher): this;
+    /**
+     * Assert: must NOT contain 'bad' AND must contain 'good'.
+     * Better violation messages than combining notContain + contain separately.
+     */
+    useInsteadOf(bad: ExpressionMatcher, good: ExpressionMatcher): this;
+    /**
+     * Assert that matched functions do not have empty bodies.
+     * Expression-bodied arrows always pass (no block body).
+     */
+    notHaveEmptyBody(): this;
+    /**
+     * Assert that matched functions follow an architectural pattern.
+     *
+     * Checks that return types contain all properties defined in
+     * the pattern's returnShape with matching types.
+     */
+    followPattern(pattern: ArchPattern): this;
+}
+/**
+ * Entry point for function-level architecture rules.
+ *
+ * Scans all source files in the project for both FunctionDeclarations
+ * and const arrow functions (VariableDeclaration with ArrowFunction initializer).
+ *
+ * @example
+ * ```typescript
+ * import { project, functions } from '@nielspeter/eess-ts'
+ *
+ * const p = project('tsconfig.json')
+ *
+ * // All parseXxxOrder functions should not exist
+ * functions(p)
+ *   .that().haveNameMatching(/^parse\w+Order$/)
+ *   .should(notExist())
+ *   .because('use shared parseOrder() utility instead')
+ *   .check()
+ * ```
+ */
+export declare function functions(p: ArchProject): FunctionRuleBuilder;
+//# sourceMappingURL=function-rule-builder.d.ts.map

package/dist/builders/function-rule-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-rule-builder.d.ts","sourceRoot":"","sources":["../../src/builders/function-rule-builder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAO/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAG9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAqBxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAkB9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,mBAAoB,SAAQ,WAAW,CAAC,YAAY,EAAE,WAAW,CAAC;IAC7E,SAAS,CAAC,WAAW,IAAI,YAAY,EAAE;IAMvC;;;OAGG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAQhD,mEAAmE;IACnE,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI1C,iEAAiE;IACjE,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIxC;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAOhC;;;OAGG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAOlC,+DAA+D;IAC/D,WAAW,IAAI,IAAI;IAInB,mEAAmE;IACnE,cAAc,IAAI,IAAI;IAMtB;;;OAGG;IACH,SAAS,IAAI,IAAI;IAIjB,8EAA8E;IAC9E,YAAY,IAAI,IAAI;IAIpB,4EAA4E;IAC5E,UAAU,IAAI,IAAI;IAMlB,6DAA6D;IAC7D,QAAQ,IAAI,IAAI;IAIhB,gDAAgD;IAChD,WAAW,IAAI,IAAI;IAInB,+DAA+D;IAC/D,kBAAkB,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAInC,iEAAiE;IACjE,6BAA6B,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAI9C,kEAAkE;IAClE,0BAA0B,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAI3C,8EAA8E;IAC9E,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAItC;;;OAGG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAI9C,qEAAqE;IACrE,iBAAiB,IAAI,IAAI;IAIzB,yFAAyF;IACzF,qBAAqB,IAAI,IAAI;IAI7B;;;;OAIG;IACH,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,IAAI;IAI9D,oFAAoF;IACpF,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAMhD;;;OAGG;IACH,aAAa,CAAC,SAAS,EAAE,SAAS,CAAC,YAAY,CAAC,GAAG,IAAI;IAIvD;;OAEG;IACH,QAAQ,IAAI,IAAI;IAIhB;;OAEG;IACH,UAAU,IAAI,IAAI;IAIlB;;OAEG;IACH,OAAO,IAAI,IAAI;IAIf,sEAAsE;IACtE,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAMhD;;;;;;OAMG;IACH,qBAAqB,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAIjD;;;;;;;OAOG;IACH,wBAAwB,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAMpD;;;;;;;;;;;OAWG;IACH,sBAAsB,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAMlD;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAIzC;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAI5C;;;OAGG;IACH,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,iBAAiB,GAAG,IAAI;IAInE;;;OAGG;IACH,gBAAgB,IAAI,IAAI;IAIxB;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;CAG1C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,WAAW,GAAG,mBAAmB,CAE7D"}