@ttsc/lint 0.24.0 → 0.26.0

package/lib/internal/configEvaluatorFailure.d.ts

@@ -1,33 +1,37 @@
-export declare const CONFIG_EVALUATOR_MAX_BUFFER: number;
-export declare const CONFIG_EVALUATOR_TIMEOUT_MS = 60000;
-export declare const CONFIG_EVALUATOR_TEARDOWN_GRACE_MS = 5000;
-export declare const CONFIG_EVALUATOR_STATUS_FD = 3;
-export declare const CONFIG_EVALUATOR_PROCESS_OPTIONS: Readonly<{
-    killSignal: "SIGKILL";
-    maxBuffer: number;
-    timeout: number;
-}>;
 interface ConfigEvaluatorProcessResult {
     error?: Error;
-    output?: readonly (string | null)[] | null;
     signal: NodeJS.Signals | null;
     status: number | null;
-    stderr: string | null | undefined;
 }
 /**
  * Classify the ways the isolated lint-config evaluator can stop.
  *
- * Node reports both timeout and max-buffer termination with the configured
- * signal, so the process error code must take precedence over the signal. The
- * evaluator uses `SIGKILL`: Node's synchronous process API otherwise keeps
- * waiting when a POSIX child handles the default `SIGTERM` without exiting. A
- * bare signal is an external termination and a non-zero status is an evaluator
- * failure whose stderr tail contains the useful user-config diagnostic.
+ * The evaluator writes the child's own output straight to this process's
+ * stderr, so a diagnostic has already reached the user by the time anything
+ * here runs. What is left to say is only how the process ended: it never
+ * launched, something outside killed it, or it exited non-zero after printing
+ * its own reason.
+ *
+ * Nothing is bounded here — not time, not output. Both were the compiler
+ * deciding, on numbers nobody chose for this machine, that a user's own config
+ * had run too long or said too much. A slow config is a slow build the user can
+ * watch and interrupt; a loud one is output they asked for. Neither is this
+ * process's memory to spend either, because the child's streams are no longer
+ * collected into it.
  */
 export declare function configEvaluatorProcessFailure(result: ConfigEvaluatorProcessResult, configPath: string): Error | undefined;
 /**
- * Pass the semantic deadline and private status pipe through the `ttsx` wrapper
- * to the runtime child that actually executes the config.
+ * Read the failure envelope the evaluator writes to its result file when it
+ * stops on an error it can name.
+ *
+ * This is the other half of classifying how the evaluation ended, which is why
+ * it lives beside {@link configEvaluatorProcessFailure} rather than at the call
+ * site: the status says that it failed, and this says why.
+ *
+ * Only a well-formed envelope is honoured. A real evaluation payload never
+ * carries this key, and every other shape — an absent file, a build that failed
+ * before the loader ran, a half-written result, a payload written before a
+ * later non-zero exit — leaves the process status to speak for itself.
  */
-export declare function configEvaluatorBoundaryEnvironment(now?: number): NodeJS.ProcessEnv;
+export declare function configEvaluatorFailureReason(outputPath: string): string;
 export {};

package/lib/internal/configEvaluatorFailure.js

@@ -1,40 +1,28 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CONFIG_EVALUATOR_PROCESS_OPTIONS = exports.CONFIG_EVALUATOR_STATUS_FD = exports.CONFIG_EVALUATOR_TEARDOWN_GRACE_MS = exports.CONFIG_EVALUATOR_TIMEOUT_MS = exports.CONFIG_EVALUATOR_MAX_BUFFER = void 0;
 exports.configEvaluatorProcessFailure = configEvaluatorProcessFailure;
-exports.configEvaluatorBoundaryEnvironment = configEvaluatorBoundaryEnvironment;
-exports.CONFIG_EVALUATOR_MAX_BUFFER = 16 * 1024 * 1024;
-exports.CONFIG_EVALUATOR_TIMEOUT_MS = 60_000;
-exports.CONFIG_EVALUATOR_TEARDOWN_GRACE_MS = 5_000;
-exports.CONFIG_EVALUATOR_STATUS_FD = 3;
-exports.CONFIG_EVALUATOR_PROCESS_OPTIONS = Object.freeze({
-    killSignal: "SIGKILL",
-    maxBuffer: exports.CONFIG_EVALUATOR_MAX_BUFFER,
-    timeout: exports.CONFIG_EVALUATOR_TIMEOUT_MS + exports.CONFIG_EVALUATOR_TEARDOWN_GRACE_MS,
-});
+exports.configEvaluatorFailureReason = configEvaluatorFailureReason;
+const node_fs_1 = __importDefault(require("node:fs"));
 /**
  * Classify the ways the isolated lint-config evaluator can stop.
  *
- * Node reports both timeout and max-buffer termination with the configured
- * signal, so the process error code must take precedence over the signal. The
- * evaluator uses `SIGKILL`: Node's synchronous process API otherwise keeps
- * waiting when a POSIX child handles the default `SIGTERM` without exiting. A
- * bare signal is an external termination and a non-zero status is an evaluator
- * failure whose stderr tail contains the useful user-config diagnostic.
+ * The evaluator writes the child's own output straight to this process's
+ * stderr, so a diagnostic has already reached the user by the time anything
+ * here runs. What is left to say is only how the process ended: it never
+ * launched, something outside killed it, or it exited non-zero after printing
+ * its own reason.
+ *
+ * Nothing is bounded here — not time, not output. Both were the compiler
+ * deciding, on numbers nobody chose for this machine, that a user's own config
+ * had run too long or said too much. A slow config is a slow build the user can
+ * watch and interrupt; a loud one is output they asked for. Neither is this
+ * process's memory to spend either, because the child's streams are no longer
+ * collected into it.
  */
 function configEvaluatorProcessFailure(result, configPath) {
-    const code = result.error?.code;
-    const nestedCode = result.output?.[exports.CONFIG_EVALUATOR_STATUS_FD]?.trim() ?? "";
-    if (code === "ETIMEDOUT" || nestedCode === "ETIMEDOUT") {
-        return new Error(`@ttsc/lint: ttsx evaluation of ${configPath} timed out after ` +
-            `${exports.CONFIG_EVALUATOR_TIMEOUT_MS / 1_000} seconds. ` +
-            "Simplify the config or move heavy work out of top-level.");
-    }
-    if (code === "ENOBUFS" || nestedCode === "ENOBUFS") {
-        return new Error(`@ttsc/lint: ttsx evaluation of ${configPath} exceeded the ` +
-            `${exports.CONFIG_EVALUATOR_MAX_BUFFER / (1024 * 1024)} MiB output limit. ` +
-            "Reduce console output from the config and its dependencies.");
-    }
     if (result.error) {
         return new Error(`@ttsc/lint: failed to spawn ttsx for ${configPath}: ${result.error.message}`);
     }
@@ -42,35 +30,34 @@ function configEvaluatorProcessFailure(result, configPath) {
         return new Error(`@ttsc/lint: ttsx evaluation of ${configPath} was killed by signal ${result.signal}.`);
     }
     if (result.status !== 0) {
-        const reason = configEvaluatorFailureReason(result.stderr);
-        return new Error(`@ttsc/lint: lint config ${configPath} evaluation failed with exit code ${String(result.status)}` +
-            (reason === "" ? "" : "\n" + reason));
+        return new Error(`@ttsc/lint: lint config ${configPath} evaluation failed with exit code ${String(result.status)}`);
     }
     return undefined;
 }
 /**
- * Pass the semantic deadline and private status pipe through the `ttsx` wrapper
- * to the runtime child that actually executes the config.
- */
-function configEvaluatorBoundaryEnvironment(now = Date.now()) {
-    return {
-        TTSC_TTSX_EVALUATOR_DEADLINE_MS: String(now + exports.CONFIG_EVALUATOR_TIMEOUT_MS),
-        TTSC_TTSX_EVALUATOR_MAX_BUFFER_BYTES: String(exports.CONFIG_EVALUATOR_MAX_BUFFER),
-        TTSC_TTSX_EVALUATOR_STATUS_FD: String(exports.CONFIG_EVALUATOR_STATUS_FD),
-    };
-}
-/**
- * Return the useful tail of evaluator stderr without turning an exception into
- * an unbounded duplicate of the already-forwarded child stream.
+ * Read the failure envelope the evaluator writes to its result file when it
+ * stops on an error it can name.
+ *
+ * This is the other half of classifying how the evaluation ended, which is why
+ * it lives beside {@link configEvaluatorProcessFailure} rather than at the call
+ * site: the status says that it failed, and this says why.
+ *
+ * Only a well-formed envelope is honoured. A real evaluation payload never
+ * carries this key, and every other shape — an absent file, a build that failed
+ * before the loader ran, a half-written result, a payload written before a
+ * later non-zero exit — leaves the process status to speak for itself.
  */
-function configEvaluatorFailureReason(stderr) {
-    const bounded = (stderr ?? "").slice(-CONFIG_EVALUATOR_REASON_MAX_CHARS);
-    const lines = bounded
-        .split(/\r?\n/)
-        .map((line) => line.trimEnd())
-        .filter((line) => line.trim() !== "");
-    return lines.slice(-CONFIG_EVALUATOR_REASON_LINES).join("\n");
+function configEvaluatorFailureReason(outputPath) {
+    try {
+        const parsed = JSON.parse(node_fs_1.default.readFileSync(outputPath, "utf8"));
+        if (typeof parsed !== "object" || parsed === null)
+            return "";
+        const message = parsed
+            .__ttscLoaderError;
+        return typeof message === "string" ? message.trim() : "";
+    }
+    catch {
+        return "";
+    }
 }
-const CONFIG_EVALUATOR_REASON_LINES = 5;
-const CONFIG_EVALUATOR_REASON_MAX_CHARS = 8 * 1024;
 //# sourceMappingURL=configEvaluatorFailure.js.map

package/lib/internal/configEvaluatorFailure.js.map

@@ -1 +1 @@
-{"version":3,"file":"configEvaluatorFailure.js","sourceRoot":"","sources":["../../src/internal/configEvaluatorFailure.ts"],"names":[],"mappings":";;;;;AAAa,QAAA,2BAA2B,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAC/C,QAAA,2BAA2B,GAAG,MAAM,CAAC;AACrC,QAAA,kCAAkC,GAAG,KAAK,CAAC;AAC3C,QAAA,0BAA0B,GAAG,CAAC,CAAC;AAC/B,QAAA,gCAAgC,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5D,UAAU,EAAE,SAAkB;IAC9B,SAAS,EAAE,QAAA,2BAA2B;IACtC,OAAO,EAAE,QAAA,2BAA2B,GAAG,QAAA,kCAAkC;CAC1E,CAAC,CAAC;AAUH;;;;;;;;;GASG;AACH,uCACE,MAAoC,EACpC,UAAkB;IAElB,MAAM,IAAI,GAAI,MAAM,CAAC,KAA2C,EAAE,IAAI,CAAC;IACvE,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,QAAA,0BAA0B,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC7E,IAAI,IAAI,KAAK,WAAW,IAAI,UAAU,KAAK,WAAW,EAAE,CAAC;QACvD,OAAO,IAAI,KAAK,CACd,kCAAkC,UAAU,mBAAmB;YAC7D,GAAG,QAAA,2BAA2B,GAAG,KAAK,YAAY;YAClD,0DAA0D,CAC7D,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QACnD,OAAO,IAAI,KAAK,CACd,kCAAkC,UAAU,gBAAgB;YAC1D,GAAG,QAAA,2BAA2B,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,qBAAqB;YACnE,6DAA6D,CAChE,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,IAAI,KAAK,CACd,wCAAwC,UAAU,KAAK,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAC9E,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,IAAI,KAAK,CACd,kCAAkC,UAAU,yBAAyB,MAAM,CAAC,MAAM,GAAG,CACtF,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,4BAA4B,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3D,OAAO,IAAI,KAAK,CACd,2BAA2B,UAAU,qCAAqC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC/F,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC,CACvC,CAAC;IACJ,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,4CACE,GAAG,GAAW,IAAI,CAAC,GAAG,EAAE;IAExB,OAAO;QACL,+BAA+B,EAAE,MAAM,CAAC,GAAG,GAAG,QAAA,2BAA2B,CAAC;QAC1E,oCAAoC,EAAE,MAAM,CAAC,QAAA,2BAA2B,CAAC;QACzE,6BAA6B,EAAE,MAAM,CAAC,QAAA,0BAA0B,CAAC;KAClE,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,4BAA4B,CACnC,MAAiC;IAEjC,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,iCAAiC,CAAC,CAAC;IACzE,MAAM,KAAK,GAAG,OAAO;SAClB,KAAK,CAAC,OAAO,CAAC;SACd,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;SAC7B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACxC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,6BAA6B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,6BAA6B,GAAG,CAAC,CAAC;AACxC,MAAM,iCAAiC,GAAG,CAAC,GAAG,IAAI,CAAC"}
+{"version":3,"file":"configEvaluatorFailure.js","sourceRoot":"","sources":["../../src/internal/configEvaluatorFailure.ts"],"names":[],"mappings":";;;;;;;AAAA,sDAAyB;AAQzB;;;;;;;;;;;;;;;GAeG;AACH,uCACE,MAAoC,EACpC,UAAkB;IAElB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,IAAI,KAAK,CACd,wCAAwC,UAAU,KAAK,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAC9E,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,IAAI,KAAK,CACd,kCAAkC,UAAU,yBAAyB,MAAM,CAAC,MAAM,GAAG,CACtF,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,KAAK,CACd,2BAA2B,UAAU,qCAAqC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAClG,CAAC;IACJ,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,sCAA6C,UAAkB;IAC7D,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,iBAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;QACxE,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI;YAAE,OAAO,EAAE,CAAC;QAC7D,MAAM,OAAO,GAAI,MAA0C;aACxD,iBAAiB,CAAC;QACrB,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}

package/lib/structures/rules/ITtscLintFunctionalRuleOptions.d.ts

@@ -67,52 +67,105 @@ export interface ITtscLintFunctionalNoThrowStatementsRuleOptions {
 }
 /** `functional/no-mixed-types` rule options. */
 export interface ITtscLintFunctionalNoMixedTypesRuleOptions {
-    /** Check interface member kinds. */
+    /**
+     * Check interface member kinds.
+     *
+     * @default true
+     */
     checkInterfaces?: boolean;
-    /** Check type-literal member kinds. */
+    /**
+     * Check type-literal member kinds.
+     *
+     * @default true
+     */
     checkTypeLiterals?: boolean;
 }
 /** `functional/no-return-void` rule options. */
 export interface ITtscLintFunctionalNoReturnVoidRuleOptions {
-    /** Permit a function that returns `null` to satisfy the rule. */
+    /**
+     * Permit a function whose declared return type is `null`. Set `false` to
+     * reject it the way a declared `void` is rejected.
+     *
+     * @default true
+     */
     allowNull?: boolean;
-    /** Permit a function that returns `undefined` to satisfy the rule. */
+    /**
+     * Permit a function whose declared return type is `undefined`. Set `false` to
+     * reject it the way a declared `void` is rejected.
+     *
+     * @default true
+     */
     allowUndefined?: boolean;
     /**
-     * Skip functions whose return type is inferred to be `void` rather than
-     * declared explicitly.
+     * Skip a bare `return;` inside a function that declares no return type. That
+     * statement is the one place the rule rejects a void-ness it inferred rather
+     * than read from an annotation.
+     *
+     * @default false
      */
     ignoreInferredTypes?: boolean;
 }
 /** `functional/prefer-immutable-types` rule options. */
 export interface ITtscLintFunctionalPreferImmutableTypesRuleOptions extends ITtscLintFunctionalPatternOptions {
     /**
-     * Minimum accepted immutability. The native subset treats any configured
+     * Minimum accepted immutability. Reserved for upstream-compatible configs;
+     * the native subset computes no immutability level and treats any configured
      * value as readonly-required.
      */
     enforcement?: "ReadonlyShallow" | "ReadonlyDeep" | "Immutable" | "None" | false;
 }
 /** `functional/prefer-readonly-type` rule options. */
 export interface ITtscLintFunctionalPreferReadonlyTypeRuleOptions extends ITtscLintFunctionalPatternOptions {
-    /** Permit mutation of locals while still policing exported types. */
+    /**
+     * Permit mutation of locals while still policing exported types. Reserved for
+     * upstream-compatible configs; the native subset reads type annotations and
+     * models no local-versus-exported distinction.
+     */
     allowLocalMutation?: boolean;
-    /** Permit a mutable return type even when parameters must be readonly. */
+    /**
+     * Permit a mutable return type even when parameters must be readonly. Covers
+     * every signature that can declare one, including call and construct
+     * signatures, constructor types, and a get accessor.
+     *
+     * @default false
+     */
     allowMutableReturnType?: boolean;
-    /** Also check property positions that have no explicit type annotation. */
+    /**
+     * Also check property positions that have no explicit type annotation.
+     * Reserved for upstream-compatible configs; judging an unannotated position
+     * needs the type checker, which this rule does not use.
+     */
     checkImplicit?: boolean;
-    /** Skip array / tuple / `Map` / `Set` types. */
+    /**
+     * Skip array / tuple / `Map` / `Set` types.
+     *
+     * @default false
+     */
     ignoreCollections?: boolean;
     /**
-     * Skip class fields. `"fieldsOnly"` keeps the rule active for non-field class
-     * members.
+     * Skip class members. `true` skips anything under a class, its heritage
+     * clause and type parameters included; `"fieldsOnly"` narrows that to field
+     * declarations and keeps methods, accessors, and constructor parameters
+     * checked.
+     *
+     * @default false
      */
     ignoreClass?: boolean | "fieldsOnly";
-    /** Skip interface members entirely. */
+    /**
+     * Skip interface members entirely.
+     *
+     * @default false
+     */
     ignoreInterface?: boolean;
 }
 /** `functional/prefer-tacit` rule options. */
 export interface ITtscLintFunctionalPreferTacitRuleOptions {
-    /** Check member expressions such as `x => service.map(x)`. */
+    /**
+     * Check member expressions such as `x => service.map(x)`. Set `false` to keep
+     * the rule on bare-identifier callees only.
+     *
+     * @default true
+     */
     checkMemberExpressions?: boolean;
 }
 /** `functional/readonly-type` rule options. */
@@ -133,7 +186,11 @@ export interface ITtscLintFunctionalTypeDeclarationImmutabilityRule {
      * every value as readonly-required.
      */
     immutability?: "ReadonlyShallow" | "ReadonlyDeep" | "Immutable" | "Mutable";
-    /** Comparator applied to the immutability level above. */
+    /**
+     * Comparator applied to the immutability level above. Reserved for
+     * upstream-compatible configs alongside `immutability`: the native subset
+     * computes no immutability level, so there is nothing to compare.
+     */
     comparator?: "Less" | "AtMost" | "Exactly" | "AtLeast" | "More" | -2 | -1 | 0 | 1 | 2;
 }
 /** `functional/type-declaration-immutability` rule options. */