@nielspeter/eess-ts 0.1.1 → 0.2.1

package/dist/tsconfig/tsconfig-builder.d.ts

@@ -0,0 +1,32 @@
+import type { CompilerOptions } from 'ts-morph';
+import { TerminalBuilder } from '@nielspeter/eess';
+import type { ArchProject } from '../core/project.js';
+import type { ArchViolation } from '../core/violation.js';
+/**
+ * Asserts that a project's resolved TypeScript compiler options match a
+ * user-supplied spec. A non-iterating rule (one project → one options object),
+ * so it extends {@link TerminalBuilder} like the smell detectors rather than the
+ * element-builder DSL. One violation is emitted per mismatched flag; the flag
+ * name is the violation `element`, so `.excluding('strictNullChecks')` filters
+ * by flag.
+ */
+export declare class TsconfigBuilder extends TerminalBuilder {
+    private readonly project;
+    private _requirements;
+    constructor(project: ArchProject);
+    /**
+     * Merge a partial compiler-options spec into the requirements for this rule.
+     * Each present key must equal the project's resolved value (strict-family
+     * flags are resolved through `strict: true` the way tsc resolves them).
+     * Multiple `.requires()` calls merge additively; later keys win on conflict.
+     */
+    requires(spec: Partial<CompilerOptions>): this;
+    protected collectViolations(): ArchViolation[];
+}
+/**
+ * Entry point for a tsconfig config-assertion rule. Mirrors `project()` /
+ * `smells` — a flat top-level entry returning a builder that composes with
+ * `.because()` / `.excluding()` / `.check()` / `.warn()`.
+ */
+export declare function tsconfig(p: ArchProject): TsconfigBuilder;
+//# sourceMappingURL=tsconfig-builder.d.ts.map

package/dist/tsconfig/tsconfig-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsconfig-builder.d.ts","sourceRoot":"","sources":["../../src/tsconfig/tsconfig-builder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAKzD;;;;;;;GAOG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAGtC,OAAO,CAAC,QAAQ,CAAC,OAAO;IAFpC,OAAO,CAAC,aAAa,CAA+B;gBAEvB,OAAO,EAAE,WAAW;IAIjD;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI;IAK9C,SAAS,CAAC,iBAAiB,IAAI,aAAa,EAAE;CAyB/C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,WAAW,GAAG,eAAe,CAExD"}

package/dist/tsconfig/tsconfig-builder.js

@@ -0,0 +1,149 @@
+import { ScriptTarget, ModuleKind, ModuleResolutionKind } from 'ts-morph';
+import { TerminalBuilder } from '@nielspeter/eess';
+import { isStrictFamily, resolveFlag } from './strict-family.js';
+const RULE_DESCRIPTION = 'tsconfig compiler options must satisfy requirements';
+/**
+ * Asserts that a project's resolved TypeScript compiler options match a
+ * user-supplied spec. A non-iterating rule (one project → one options object),
+ * so it extends {@link TerminalBuilder} like the smell detectors rather than the
+ * element-builder DSL. One violation is emitted per mismatched flag; the flag
+ * name is the violation `element`, so `.excluding('strictNullChecks')` filters
+ * by flag.
+ */
+export class TsconfigBuilder extends TerminalBuilder {
+    project;
+    _requirements = {};
+    constructor(project) {
+        super();
+        this.project = project;
+    }
+    /**
+     * Merge a partial compiler-options spec into the requirements for this rule.
+     * Each present key must equal the project's resolved value (strict-family
+     * flags are resolved through `strict: true` the way tsc resolves them).
+     * Multiple `.requires()` calls merge additively; later keys win on conflict.
+     */
+    requires(spec) {
+        this._requirements = { ...this._requirements, ...spec };
+        return this;
+    }
+    collectViolations() {
+        const opts = this.project._project.getCompilerOptions();
+        const file = this.project.tsConfigPath;
+        const violations = [];
+        for (const key of Object.keys(this._requirements)) {
+            const expected = this._requirements[key];
+            const strictFamily = isStrictFamily(key);
+            const actual = strictFamily ? resolveFlag(opts, key) : opts[key];
+            if (valuesEqual(key, expected, actual))
+                continue;
+            const expectedText = displayValue(key, expected);
+            const actualText = displayValue(key, actual);
+            violations.push({
+                rule: RULE_DESCRIPTION,
+                element: key,
+                file,
+                line: 1,
+                message: `compiler option "${key}": required ${expectedText}, actual ${actualText}`,
+                suggestion: fixSuggestion(key, expected, strictFamily, opts),
+            });
+        }
+        return violations;
+    }
+}
+/**
+ * Entry point for a tsconfig config-assertion rule. Mirrors `project()` /
+ * `smells` — a flat top-level entry returning a builder that composes with
+ * `.because()` / `.excluding()` / `.check()` / `.warn()`.
+ */
+export function tsconfig(p) {
+    return new TsconfigBuilder(p);
+}
+/**
+ * Human-readable fix hint for a mismatched flag. Enum-backed values are rendered
+ * by name (`"ES2022"`, never the raw number `9`, which isn't valid tsconfig JSON).
+ */
+function fixSuggestion(key, expected, strictFamily, opts) {
+    const base = `Set "${key}": ${suggestionLiteral(key, expected)} in compilerOptions.`;
+    if (strictFamily && expected === true) {
+        // strict is on but the sub-flag is explicitly disabled → drop the override,
+        // not "enable strict" (it already is).
+        if (Boolean(opts.strict) && opts[key] === false) {
+            return `Remove the explicit "${key}": false override — it disables a flag "strict" turns on.`;
+        }
+        return `${base} Or enable "strict".`;
+    }
+    return base;
+}
+/** A tsconfig-writable literal for a suggestion — enum names quoted, else JSON. */
+function suggestionLiteral(key, value) {
+    if (typeof value === 'number') {
+        const name = enumName(key, value);
+        if (name !== undefined)
+            return `"${name}"`;
+    }
+    return JSON.stringify(value);
+}
+/**
+ * Render a compiler-option value for a message. Numeric enum fields
+ * (`target`, `module`, `moduleResolution`) are shown by name, not their raw
+ * numeric value; unset shows `(unset)`.
+ */
+function displayValue(key, value) {
+    if (value === undefined)
+        return '(unset)';
+    if (typeof value === 'number')
+        return enumName(key, value) ?? String(value);
+    if (typeof value === 'boolean' || typeof value === 'bigint')
+        return String(value);
+    if (typeof value === 'string')
+        return value;
+    return JSON.stringify(value); // arrays, objects, null
+}
+function enumName(key, value) {
+    if (key === 'target')
+        return ScriptTarget[value];
+    if (key === 'module')
+        return ModuleKind[value];
+    if (key === 'moduleResolution')
+        return ModuleResolutionKind[value];
+    return undefined;
+}
+/** Options tsc treats as a set (order-insensitive), not an ordered list. */
+const SET_VALUED_KEYS = new Set(['lib', 'types']);
+/**
+ * Equality for a required-vs-actual option value. `lib` / `types` are compared
+ * order-insensitively (tsc treats them as sets); everything else is deep-compared
+ * structurally (primitives, ordered arrays like `paths` entries, plain objects).
+ */
+function valuesEqual(key, a, b) {
+    if (SET_VALUED_KEYS.has(key) && Array.isArray(a) && Array.isArray(b)) {
+        return setEqual(a, b);
+    }
+    return deepEqual(a, b);
+}
+function setEqual(a, b) {
+    if (a.length !== b.length)
+        return false;
+    const norm = (arr) => arr.map((x) => JSON.stringify(x)).sort();
+    const na = norm(a);
+    const nb = norm(b);
+    return na.every((x, i) => x === nb[i]);
+}
+function deepEqual(a, b) {
+    if (a === b)
+        return true;
+    if (Array.isArray(a) && Array.isArray(b)) {
+        return a.length === b.length && a.every((x, i) => deepEqual(x, b[i]));
+    }
+    if (isRecord(a) && isRecord(b)) {
+        const ak = Object.keys(a);
+        const bk = Object.keys(b);
+        return ak.length === bk.length && ak.every((k) => deepEqual(a[k], b[k]));
+    }
+    return false;
+}
+function isRecord(value) {
+    return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+//# sourceMappingURL=tsconfig-builder.js.map

package/dist/tsconfig/tsconfig-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsconfig-builder.js","sourceRoot":"","sources":["../../src/tsconfig/tsconfig-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAEzE,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAGlD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAEhE,MAAM,gBAAgB,GAAG,qDAAqD,CAAA;AAE9E;;;;;;;GAOG;AACH,MAAM,OAAO,eAAgB,SAAQ,eAAe;IAGrB;IAFrB,aAAa,GAA6B,EAAE,CAAA;IAEpD,YAA6B,OAAoB;QAC/C,KAAK,EAAE,CAAA;QADoB,YAAO,GAAP,OAAO,CAAa;IAEjD,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,IAA8B;QACrC,IAAI,CAAC,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,IAAI,EAAE,CAAA;QACvD,OAAO,IAAI,CAAA;IACb,CAAC;IAES,iBAAiB;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAA;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAA;QACtC,MAAM,UAAU,GAAoB,EAAE,CAAA;QAEtC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;YACxC,MAAM,YAAY,GAAG,cAAc,CAAC,GAAG,CAAC,CAAA;YACxC,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAChE,IAAI,WAAW,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC;gBAAE,SAAQ;YAEhD,MAAM,YAAY,GAAG,YAAY,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;YAChD,MAAM,UAAU,GAAG,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;YAC5C,UAAU,CAAC,IAAI,CAAC;gBACd,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,GAAG;gBACZ,IAAI;gBACJ,IAAI,EAAE,CAAC;gBACP,OAAO,EAAE,oBAAoB,GAAG,eAAe,YAAY,YAAY,UAAU,EAAE;gBACnF,UAAU,EAAE,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,CAAC;aAC7D,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,CAAc;IACrC,OAAO,IAAI,eAAe,CAAC,CAAC,CAAC,CAAA;AAC/B,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CACpB,GAAW,EACX,QAAiB,EACjB,YAAqB,EACrB,IAAqB;IAErB,MAAM,IAAI,GAAG,QAAQ,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,sBAAsB,CAAA;IACpF,IAAI,YAAY,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtC,4EAA4E;QAC5E,uCAAuC;QACvC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC;YAChD,OAAO,wBAAwB,GAAG,2DAA2D,CAAA;QAC/F,CAAC;QACD,OAAO,GAAG,IAAI,sBAAsB,CAAA;IACtC,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,mFAAmF;AACnF,SAAS,iBAAiB,CAAC,GAAW,EAAE,KAAc;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACjC,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,IAAI,IAAI,GAAG,CAAA;IAC5C,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;AAC9B,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAC,GAAW,EAAE,KAAc;IAC/C,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAA;IACzC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAA;IAC3E,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IACjF,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA,CAAC,wBAAwB;AACvD,CAAC;AAED,SAAS,QAAQ,CAAC,GAAW,EAAE,KAAa;IAC1C,IAAI,GAAG,KAAK,QAAQ;QAAE,OAAO,YAAY,CAAC,KAAK,CAAC,CAAA;IAChD,IAAI,GAAG,KAAK,QAAQ;QAAE,OAAO,UAAU,CAAC,KAAK,CAAC,CAAA;IAC9C,IAAI,GAAG,KAAK,kBAAkB;QAAE,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAA;IAClE,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,4EAA4E;AAC5E,MAAM,eAAe,GAAwB,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AAEtE;;;;GAIG;AACH,SAAS,WAAW,CAAC,GAAW,EAAE,CAAU,EAAE,CAAU;IACtD,IAAI,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACrE,OAAO,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACvB,CAAC;IACD,OAAO,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AACxB,CAAC;AAED,SAAS,QAAQ,CAAC,CAAY,EAAE,CAAY;IAC1C,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAA;IACvC,MAAM,IAAI,GAAG,CAAC,GAAc,EAAY,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IACnF,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;IAClB,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;IAClB,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;AACxC,CAAC;AAED,SAAS,SAAS,CAAC,CAAU,EAAE,CAAU;IACvC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IACxB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACvE,CAAC;IACD,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/B,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACzB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACzB,OAAO,EAAE,CAAC,MAAM,KAAK,EAAE,CAAC,MAAM,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAC1E,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC7E,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nielspeter/eess-ts",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Architecture testing for TypeScript — the TS dialect of the eess family (formerly ts-archunit)",
   "type": "module",
   "exports": {
@@ -113,7 +113,7 @@
     }
   },
   "dependencies": {
-    "@nielspeter/eess": "^0.1.1",
+    "@nielspeter/eess": "^0.2.1",
     "jiti": "^2.6.1",
     "picomatch": "^4.0.4",
     "ts-morph": "^27.0.2"