eslint-plugin-typefest 1.0.1

package/dist/_internal/typed-member-call-rule.js

@@ -0,0 +1,50 @@
+import { createMethodToFunctionCallFix, } from "./imported-value-symbols.js";
+import { getIdentifierPropertyMemberCall } from "./member-call.js";
+import { TS_EXTRAS_MODULE_SOURCE } from "./module-source.js";
+import { reportResolvedAutofixOrSuggestionOutcome, resolveAutofixOrSuggestionOutcome, } from "./rule-reporting.js";
+/**
+ * Match `<expr>.<memberName>(...)` and report a standardized ts-extras helper
+ * replacement when the receiver expression satisfies a caller-provided type
+ * predicate.
+ */
+export const reportTsExtrasTypedMemberCall = ({ canAutofix, context, importedName, imports, isMatchingObjectExpression, memberName, messageId, node, reportSuggestion, suggestionMessageId, }) => {
+    const memberCall = getIdentifierPropertyMemberCall({
+        memberName,
+        node,
+    });
+    if (memberCall === null) {
+        return;
+    }
+    if (!isMatchingObjectExpression(memberCall.callee.object)) {
+        return;
+    }
+    const fix = createMethodToFunctionCallFix({
+        callNode: node,
+        context,
+        importedName,
+        imports,
+        sourceModuleName: TS_EXTRAS_MODULE_SOURCE,
+    });
+    const shouldAutofix = canAutofix?.(node) ?? true;
+    const outcome = resolveAutofixOrSuggestionOutcome({
+        canAutofix: shouldAutofix,
+        fix,
+    });
+    if (outcome.kind === "suggestion" && reportSuggestion !== undefined) {
+        reportSuggestion({
+            fix: outcome.fix,
+            messageId,
+            node,
+            suggestionMessageId: suggestionMessageId ?? messageId,
+        });
+        return;
+    }
+    reportResolvedAutofixOrSuggestionOutcome({
+        context,
+        messageId,
+        node,
+        outcome,
+        suggestionMessageId: suggestionMessageId ?? messageId,
+    });
+};
+//# sourceMappingURL=typed-member-call-rule.js.map

package/dist/_internal/typed-member-call-rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-member-call-rule.js","sourceRoot":"","sources":["../../src/_internal/typed-member-call-rule.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,6BAA6B,GAEhC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,+BAA+B,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EACH,wCAAwC,EACxC,iCAAiC,GACpC,MAAM,qBAAqB,CAAC;AAU7B;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAA2B,EACpE,UAAU,EACV,OAAO,EACP,YAAY,EACZ,OAAO,EACP,0BAA0B,EAC1B,UAAU,EACV,SAAS,EACT,IAAI,EACJ,gBAAgB,EAChB,mBAAmB,GAqBrB,EAAQ,EAAE;IACR,MAAM,UAAU,GAAG,+BAA+B,CAAC;QAC/C,UAAU;QACV,IAAI;KACP,CAAC,CAAC;IAEH,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO;IACX,CAAC;IAED,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,OAAO;IACX,CAAC;IAED,MAAM,GAAG,GAAG,6BAA6B,CAAC;QACtC,QAAQ,EAAE,IAAI;QACd,OAAO;QACP,YAAY;QACZ,OAAO;QACP,gBAAgB,EAAE,uBAAuB;KAC5C,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,UAAU,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IAEjD,MAAM,OAAO,GAAG,iCAAiC,CAAC;QAC9C,UAAU,EAAE,aAAa;QACzB,GAAG;KACN,CAAC,CAAC;IAEH,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QAClE,gBAAgB,CAAC;YACb,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,SAAS;YACT,IAAI;YACJ,mBAAmB,EAAE,mBAAmB,IAAI,SAAS;SACxD,CAAC,CAAC;QAEH,OAAO;IACX,CAAC;IAED,wCAAwC,CAAC;QACrC,OAAO;QACP,SAAS;QACT,IAAI;QACJ,OAAO;QACP,mBAAmB,EAAE,mBAAmB,IAAI,SAAS;KACxD,CAAC,CAAC;AACP,CAAC,CAAC"}

package/dist/_internal/typed-path-telemetry.d.ts

@@ -0,0 +1,58 @@
+/** Immutable typed-path counter view exposed to consumers. */
+export type TypedPathCounters = Readonly<{
+    expensiveTypeCalls: number;
+    fallbackInvocations: number;
+    prefilterChecks: number;
+    prefilterHits: number;
+}>;
+/**
+ * Point-in-time telemetry snapshot grouped by file path.
+ */
+export type TypedPathTelemetrySnapshot = Readonly<{
+    files: readonly Readonly<{
+        counters: TypedPathCounters;
+        filePath: string;
+    }>[];
+    totals: Readonly<TypedPathCounters & {
+        averageExpensiveCallsPerFileInput: Readonly<{
+            expensiveTypeCalls: number;
+            fileCount: number;
+        }>;
+        fallbackInvocationRateInput: Readonly<{
+            expensiveTypeCalls: number;
+            fallbackInvocations: number;
+        }>;
+        fileCount: number;
+        prefilterHitRateInput: Readonly<{
+            prefilterChecks: number;
+            prefilterHits: number;
+        }>;
+    }>;
+}>;
+/**
+ * Record one prefilter evaluation.
+ *
+ * @param options - Telemetry file key plus whether prefilter short-circuited.
+ */
+export declare const recordTypedPathPrefilterEvaluation: ({ filePath, prefilterHit, }: Readonly<{
+    filePath: null | string | undefined;
+    prefilterHit: boolean;
+}>) => void;
+/**
+ * Record one expensive type-resolution invocation.
+ */
+export declare const recordTypedPathExpensiveTypeCall: (filePath: null | string | undefined) => void;
+/**
+ * Record one fallback invocation after constrained resolution was unavailable
+ * or failed.
+ */
+export declare const recordTypedPathFallbackInvocation: (filePath: null | string | undefined) => void;
+/**
+ * Read a deterministic telemetry snapshot for assertions and profiling.
+ */
+export declare const getTypedPathTelemetrySnapshot: () => TypedPathTelemetrySnapshot;
+/**
+ * Clear all process-local telemetry counters.
+ */
+export declare const resetTypedPathTelemetry: () => void;
+//# sourceMappingURL=typed-path-telemetry.d.ts.map

package/dist/_internal/typed-path-telemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-path-telemetry.d.ts","sourceRoot":"","sources":["../../src/_internal/typed-path-telemetry.ts"],"names":[],"mappings":"AAUA,8DAA8D;AAC9D,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACrC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;CACzB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAAC;IAC9C,KAAK,EAAE,SAAS,QAAQ,CAAC;QACrB,QAAQ,EAAE,iBAAiB,CAAC;QAC5B,QAAQ,EAAE,MAAM,CAAC;KACpB,CAAC,EAAE,CAAC;IACL,MAAM,EAAE,QAAQ,CACZ,iBAAiB,GAAG;QAChB,iCAAiC,EAAE,QAAQ,CAAC;YACxC,kBAAkB,EAAE,MAAM,CAAC;YAC3B,SAAS,EAAE,MAAM,CAAC;SACrB,CAAC,CAAC;QACH,2BAA2B,EAAE,QAAQ,CAAC;YAClC,kBAAkB,EAAE,MAAM,CAAC;YAC3B,mBAAmB,EAAE,MAAM,CAAC;SAC/B,CAAC,CAAC;QACH,SAAS,EAAE,MAAM,CAAC;QAClB,qBAAqB,EAAE,QAAQ,CAAC;YAC5B,eAAe,EAAE,MAAM,CAAC;YACxB,aAAa,EAAE,MAAM,CAAC;SACzB,CAAC,CAAC;KACN,CACJ,CAAC;CACL,CAAC,CAAC;AAkDH;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,GAAI,6BAGhD,QAAQ,CAAC;IACR,QAAQ,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;IACpC,YAAY,EAAE,OAAO,CAAC;CACzB,CAAC,KAAG,IAQJ,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,GACzC,UAAU,IAAI,GAAG,MAAM,GAAG,SAAS,KACpC,IAIF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iCAAiC,GAC1C,UAAU,IAAI,GAAG,MAAM,GAAG,SAAS,KACpC,IAIF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,QAAO,0BAwDhD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,QAAO,IAE1C,CAAC"}

package/dist/_internal/typed-path-telemetry.js

@@ -0,0 +1,114 @@
+/**
+ * @remarks
+ * Counters are intentionally process-local and best-effort. They are designed
+ * for benchmarks/tests, not for user-facing diagnostics.
+ *
+ * @packageDocumentation
+ * Lightweight runtime telemetry for typed-rule hot paths.
+ */
+import { isDefined } from "ts-extras";
+const UNKNOWN_FILE_PATH = "<unknown>";
+const typedPathCountersByFilePath = new Map();
+const createEmptyCounters = () => ({
+    expensiveTypeCalls: 0,
+    fallbackInvocations: 0,
+    prefilterChecks: 0,
+    prefilterHits: 0,
+});
+const normalizeTelemetryFilePath = (filePath) => {
+    if (typeof filePath !== "string") {
+        return UNKNOWN_FILE_PATH;
+    }
+    const trimmedPath = filePath.trim();
+    return trimmedPath.length > 0 ? trimmedPath : UNKNOWN_FILE_PATH;
+};
+const getCountersForFilePath = (filePath) => {
+    const normalizedFilePath = normalizeTelemetryFilePath(filePath);
+    const existingCounters = typedPathCountersByFilePath.get(normalizedFilePath);
+    if (isDefined(existingCounters)) {
+        return existingCounters;
+    }
+    const createdCounters = createEmptyCounters();
+    typedPathCountersByFilePath.set(normalizedFilePath, createdCounters);
+    return createdCounters;
+};
+/**
+ * Record one prefilter evaluation.
+ *
+ * @param options - Telemetry file key plus whether prefilter short-circuited.
+ */
+export const recordTypedPathPrefilterEvaluation = ({ filePath, prefilterHit, }) => {
+    const counters = getCountersForFilePath(filePath);
+    counters.prefilterChecks += 1;
+    if (prefilterHit) {
+        counters.prefilterHits += 1;
+    }
+};
+/**
+ * Record one expensive type-resolution invocation.
+ */
+export const recordTypedPathExpensiveTypeCall = (filePath) => {
+    const counters = getCountersForFilePath(filePath);
+    counters.expensiveTypeCalls += 1;
+};
+/**
+ * Record one fallback invocation after constrained resolution was unavailable
+ * or failed.
+ */
+export const recordTypedPathFallbackInvocation = (filePath) => {
+    const counters = getCountersForFilePath(filePath);
+    counters.fallbackInvocations += 1;
+};
+/**
+ * Read a deterministic telemetry snapshot for assertions and profiling.
+ */
+export const getTypedPathTelemetrySnapshot = () => {
+    const sortedEntries = [...typedPathCountersByFilePath.entries()];
+    sortedEntries.sort(([leftPath], [rightPath]) => leftPath.localeCompare(rightPath));
+    const files = [];
+    const totals = createEmptyCounters();
+    for (const [filePath, counters] of sortedEntries) {
+        const immutableCounters = Object.freeze({
+            expensiveTypeCalls: counters.expensiveTypeCalls,
+            fallbackInvocations: counters.fallbackInvocations,
+            prefilterChecks: counters.prefilterChecks,
+            prefilterHits: counters.prefilterHits,
+        });
+        files.push(Object.freeze({
+            counters: immutableCounters,
+            filePath,
+        }));
+        totals.expensiveTypeCalls += immutableCounters.expensiveTypeCalls;
+        totals.fallbackInvocations += immutableCounters.fallbackInvocations;
+        totals.prefilterChecks += immutableCounters.prefilterChecks;
+        totals.prefilterHits += immutableCounters.prefilterHits;
+    }
+    const frozenFiles = Object.freeze([...files]);
+    const fileCount = frozenFiles.length;
+    return {
+        files: frozenFiles,
+        totals: Object.freeze({
+            ...totals,
+            averageExpensiveCallsPerFileInput: Object.freeze({
+                expensiveTypeCalls: totals.expensiveTypeCalls,
+                fileCount,
+            }),
+            fallbackInvocationRateInput: Object.freeze({
+                expensiveTypeCalls: totals.expensiveTypeCalls,
+                fallbackInvocations: totals.fallbackInvocations,
+            }),
+            fileCount,
+            prefilterHitRateInput: Object.freeze({
+                prefilterChecks: totals.prefilterChecks,
+                prefilterHits: totals.prefilterHits,
+            }),
+        }),
+    };
+};
+/**
+ * Clear all process-local telemetry counters.
+ */
+export const resetTypedPathTelemetry = () => {
+    typedPathCountersByFilePath.clear();
+};
+//# sourceMappingURL=typed-path-telemetry.js.map

package/dist/_internal/typed-path-telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-path-telemetry.js","sourceRoot":"","sources":["../../src/_internal/typed-path-telemetry.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AA4CtC,MAAM,iBAAiB,GAAG,WAAoB,CAAC;AAE/C,MAAM,2BAA2B,GAAG,IAAI,GAAG,EAAoC,CAAC;AAEhF,MAAM,mBAAmB,GAAG,GAA6B,EAAE,CAAC,CAAC;IACzD,kBAAkB,EAAE,CAAC;IACrB,mBAAmB,EAAE,CAAC;IACtB,eAAe,EAAE,CAAC;IAClB,aAAa,EAAE,CAAC;CACnB,CAAC,CAAC;AAEH,MAAM,0BAA0B,GAAG,CAC/B,QAAmC,EAC7B,EAAE;IACR,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,iBAAiB,CAAC;IAC7B,CAAC;IAED,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAEpC,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,iBAAiB,CAAC;AACpE,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAC3B,QAAmC,EACX,EAAE;IAC1B,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IAChE,MAAM,gBAAgB,GAClB,2BAA2B,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAExD,IAAI,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC9B,OAAO,gBAAgB,CAAC;IAC5B,CAAC;IAED,MAAM,eAAe,GAAG,mBAAmB,EAAE,CAAC;IAE9C,2BAA2B,CAAC,GAAG,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;IAErE,OAAO,eAAe,CAAC;AAC3B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,EAC/C,QAAQ,EACR,YAAY,GAId,EAAQ,EAAE;IACR,MAAM,QAAQ,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAElD,QAAQ,CAAC,eAAe,IAAI,CAAC,CAAC;IAE9B,IAAI,YAAY,EAAE,CAAC;QACf,QAAQ,CAAC,aAAa,IAAI,CAAC,CAAC;IAChC,CAAC;AACL,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC5C,QAAmC,EAC/B,EAAE;IACN,MAAM,QAAQ,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAElD,QAAQ,CAAC,kBAAkB,IAAI,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAC7C,QAAmC,EAC/B,EAAE;IACN,MAAM,QAAQ,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAElD,QAAQ,CAAC,mBAAmB,IAAI,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,GAA+B,EAAE;IAC1E,MAAM,aAAa,GAAG,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,CAAC,CAAC;IAEjE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,CAC3C,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CACpC,CAAC;IAEF,MAAM,KAAK,GAGJ,EAAE,CAAC;IACV,MAAM,MAAM,GAAG,mBAAmB,EAAE,CAAC;IAErC,KAAK,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,aAAa,EAAE,CAAC;QAC/C,MAAM,iBAAiB,GAAsB,MAAM,CAAC,MAAM,CAAC;YACvD,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB;YAC/C,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB;YACjD,eAAe,EAAE,QAAQ,CAAC,eAAe;YACzC,aAAa,EAAE,QAAQ,CAAC,aAAa;SACxC,CAAC,CAAC;QAEH,KAAK,CAAC,IAAI,CACN,MAAM,CAAC,MAAM,CAAC;YACV,QAAQ,EAAE,iBAAiB;YAC3B,QAAQ;SACX,CAAC,CACL,CAAC;QAEF,MAAM,CAAC,kBAAkB,IAAI,iBAAiB,CAAC,kBAAkB,CAAC;QAClE,MAAM,CAAC,mBAAmB,IAAI,iBAAiB,CAAC,mBAAmB,CAAC;QACpE,MAAM,CAAC,eAAe,IAAI,iBAAiB,CAAC,eAAe,CAAC;QAC5D,MAAM,CAAC,aAAa,IAAI,iBAAiB,CAAC,aAAa,CAAC;IAC5D,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC;IAErC,OAAO;QACH,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YAClB,GAAG,MAAM;YACT,iCAAiC,EAAE,MAAM,CAAC,MAAM,CAAC;gBAC7C,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;gBAC7C,SAAS;aACZ,CAAC;YACF,2BAA2B,EAAE,MAAM,CAAC,MAAM,CAAC;gBACvC,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;gBAC7C,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;aAClD,CAAC;YACF,SAAS;YACT,qBAAqB,EAAE,MAAM,CAAC,MAAM,CAAC;gBACjC,eAAe,EAAE,MAAM,CAAC,eAAe;gBACvC,aAAa,EAAE,MAAM,CAAC,aAAa;aACtC,CAAC;SACL,CAAC;KACL,CAAC;AACN,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAS,EAAE;IAC9C,2BAA2B,CAAC,KAAK,EAAE,CAAC;AACxC,CAAC,CAAC"}

package/dist/_internal/typed-rule.d.ts

@@ -0,0 +1,142 @@
+/**
+ * @packageDocumentation
+ * Internal shared utilities used by eslint-plugin-typefest rule modules and
+ * plugin wiring.
+ */
+import type { Except, UnknownArray } from "type-fest";
+import type ts from "typescript";
+import { ESLintUtils, type TSESLint, type TSESTree } from "@typescript-eslint/utils";
+import type { TypefestConfigReference } from "./typefest-config-references.js";
+/**
+ * Parser services and type checker bundle used by typed rules.
+ */
+export type TypedRuleServices = {
+    checker: ts.TypeChecker;
+    parserServices: ReturnType<typeof ESLintUtils.getParserServices>;
+};
+/** Shared typed-rule context contract used by helper utilities. */
+type TypedRuleContext = Readonly<TSESLint.RuleContext<string, UnknownArray>>;
+export type { TypedRuleContext };
+type TypefestRuleCreator = ReturnType<typeof ESLintUtils.RuleCreator<TypefestRuleInputDocs>>;
+/**
+ * Plugin-specific metadata extensions for `meta.docs`.
+ *
+ * @remarks
+ * `eslint-plugin/require-meta-docs-recommended` expects `meta.docs.recommended`
+ * to be boolean. Preset membership is tracked separately via
+ * `meta.docs.typefestConfigs`.
+ */
+type TypefestRuleDocs = {
+    recommended?: boolean;
+    requiresTypeChecking?: boolean;
+    ruleCatalogId: string;
+    ruleId?: string;
+    ruleNumber?: number;
+    typefestConfigs?: readonly TypefestConfigReference[] | TypefestConfigReference;
+};
+/**
+ * Rule authoring metadata contract accepted by `RuleCreator`.
+ *
+ * @remarks
+ * `ruleCatalogId` is injected centrally by `createTypedRule`, so authored rule
+ * modules are not required to provide it.
+ */
+type TypefestRuleInputDocs = Except<TypefestRuleDocs, "ruleCatalogId"> & {
+    ruleCatalogId?: string;
+};
+/**
+ * Rule-creator wrapper used by all plugin rules.
+ *
+ * @remarks
+ * This wrapper automatically registers per-program plugin settings.
+ *
+ * @param ruleDefinition - Rule module definition passed to
+ *   `ESLintUtils.RuleCreator`.
+ *
+ * @returns Rule module factory output that auto-registers program settings and
+ *   preserves the authored rule contract.
+ */
+export declare const createTypedRule: TypefestRuleCreator;
+/**
+ * Retrieve parser services and type checker for typed rules.
+ *
+ * @param context - Rule context from the current lint evaluation.
+ *
+ * @returns Parser services and type checker references bound to the current
+ *   program.
+ *
+ * @throws Throws when `parserServices.program` is unavailable, which indicates
+ *   the current lint run is not configured for type-aware analysis.
+ */
+export declare const getTypedRuleServices: (context: TypedRuleContext) => TypedRuleServices;
+/**
+ * Determine whether the current lint context has full type information.
+ *
+ * @param context - Rule context from the current lint evaluation.
+ *
+ * @returns `true` when parser services and `program` are available.
+ */
+export declare const hasTypeServices: (context: TypedRuleContext) => boolean;
+/**
+ * Retrieve typed services when available, otherwise return `undefined`.
+ *
+ * @param context - Rule context from the current lint evaluation.
+ *
+ * @returns Typed services when parser services include a TypeScript program.
+ */
+export declare const getTypedRuleServicesOrUndefined: (context: TypedRuleContext) => TypedRuleServices | undefined;
+/**
+ * Determine whether one TypeScript type is assignable to another.
+ *
+ * @remarks
+ * Uses `checker.isTypeAssignableTo` when available and falls back to strict
+ * reference equality if the checker API is unavailable or throws.
+ *
+ * @param checker - TypeScript type checker.
+ * @param sourceType - Candidate source type.
+ * @param targetType - Candidate target type.
+ *
+ * @returns `true` when assignable; otherwise `false`.
+ */
+export declare const isTypeAssignableTo: (checker: Readonly<ts.TypeChecker>, sourceType: Readonly<ts.Type>, targetType: Readonly<ts.Type>) => boolean;
+/**
+ * Resolve the type of a signature parameter by index.
+ *
+ * @param options - Signature parameter lookup options.
+ *
+ *   - `checker`: TypeScript type checker.
+ *   - `index`: Parameter index in the signature.
+ *   - `location`: Source location used for contextual type lookup.
+ *   - `signature`: Candidate call signature.
+ *
+ * @returns Parameter type when available; otherwise `undefined`.
+ */
+export declare const getSignatureParameterTypeAt: (options: Readonly<{
+    checker: ts.TypeChecker;
+    index: number;
+    location: ts.Node;
+    signature: null | ts.Signature | undefined;
+}>) => ts.Type | undefined;
+/**
+ * Determine whether an expression references an unshadowed global identifier.
+ *
+ * @param context - Rule context used for scope resolution.
+ * @param expression - Expression to inspect.
+ * @param identifierName - Expected identifier name.
+ *
+ * @returns `true` when the expression is an Identifier with the expected name
+ *   and resolves to the global binding.
+ */
+export declare const isGlobalIdentifierNamed: <MessageIds extends string, Options extends Readonly<UnknownArray>>(context: Readonly<TSESLint.RuleContext<MessageIds, Options>>, expression: Readonly<TSESTree.Expression>, identifierName: string) => expression is TSESTree.Identifier;
+/**
+ * Determine whether an expression references the global `undefined` binding
+ * (not a shadowed user-defined symbol).
+ *
+ * @param context - Rule context used for scope resolution.
+ * @param expression - Expression to inspect.
+ *
+ * @returns `true` when the expression is an Identifier named `undefined` that
+ *   resolves to the global binding.
+ */
+export declare const isGlobalUndefinedIdentifier: <MessageIds extends string, Options extends Readonly<UnknownArray>>(context: Readonly<TSESLint.RuleContext<MessageIds, Options>>, expression: Readonly<TSESTree.Expression>) => expression is TSESTree.Identifier;
+//# sourceMappingURL=typed-rule.d.ts.map

package/dist/_internal/typed-rule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-rule.d.ts","sourceRoot":"","sources":["../../src/_internal/typed-rule.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,EACH,WAAW,EACX,KAAK,QAAQ,EACb,KAAK,QAAQ,EAChB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAe/E;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC;IACxB,cAAc,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,iBAAiB,CAAC,CAAC;CACpE,CAAC;AAEF,mEAAmE;AACnE,KAAK,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;AAE7E,YAAY,EAAE,gBAAgB,EAAE,CAAC;AAEjC,KAAK,mBAAmB,GAAG,UAAU,CACjC,OAAO,WAAW,CAAC,WAAW,CAAC,qBAAqB,CAAC,CACxD,CAAC;AAEF;;;;;;;GAOG;AACH,KAAK,gBAAgB,GAAG;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EACV,SAAS,uBAAuB,EAAE,GAClC,uBAAuB,CAAC;CACjC,CAAC;AAEF;;;;;;GAMG;AACH,KAAK,qBAAqB,GAAG,MAAM,CAAC,gBAAgB,EAAE,eAAe,CAAC,GAAG;IACrE,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,EAAE,mBAsD7B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,GAC7B,SAAS,gBAAgB,KAC1B,iBAcF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,SAAS,gBAAgB,KAAG,OAS3D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B,GACxC,SAAS,gBAAgB,KAC1B,iBAAiB,GAAG,SACiD,CAAC;AAEzE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB,GAC3B,SAAS,QAAQ,CAAC,EAAE,CAAC,WAAW,CAAC,EACjC,YAAY,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,EAC7B,YAAY,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,KAC9B,OAgBF,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,2BAA2B,GACpC,SAAS,QAAQ,CAAC;IACd,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC;IAClB,SAAS,EAAE,IAAI,GAAG,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;CAC9C,CAAC,KACH,EAAE,CAAC,IAAI,GAAG,SASZ,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB,GAChC,UAAU,SAAS,MAAM,EACzB,OAAO,SAAS,QAAQ,CAAC,YAAY,CAAC,EAEtC,SAAS,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,EAC5D,YAAY,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,EACzC,gBAAgB,MAAM,KACvB,UAAU,IAAI,QAAQ,CAAC,UAkCzB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,2BAA2B,GACpC,UAAU,SAAS,MAAM,EACzB,OAAO,SAAS,QAAQ,CAAC,YAAY,CAAC,EAEtC,SAAS,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,EAC5D,YAAY,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,KAC1C,UAAU,IAAI,QAAQ,CAAC,UACmC,CAAC"}

package/dist/_internal/typed-rule.js

@@ -0,0 +1,197 @@
+import { ESLintUtils, } from "@typescript-eslint/utils";
+import { assertDefined, isDefined } from "ts-extras";
+import { registerProgramSettingsForContext } from "./plugin-settings.js";
+import { getRuleCatalogEntryForRuleNameOrNull } from "./rule-catalog.js";
+import { createRuleDocsUrl } from "./rule-docs-url.js";
+import { safeTypeOperation } from "./safe-type-operation.js";
+import { getScopeFromContextSourceCode } from "./scope-resolution.js";
+import { getVariableInScopeChain } from "./scope-variable.js";
+import { getTypeCheckerIsTypeAssignableToResult } from "./type-checker-compat.js";
+/**
+ * Current rule-catalog revision identifier stamped into `meta.docs`.
+ */
+const RULE_CATALOG_ID = "R002";
+/**
+ * Rule-creator wrapper used by all plugin rules.
+ *
+ * @remarks
+ * This wrapper automatically registers per-program plugin settings.
+ *
+ * @param ruleDefinition - Rule module definition passed to
+ *   `ESLintUtils.RuleCreator`.
+ *
+ * @returns Rule module factory output that auto-registers program settings and
+ *   preserves the authored rule contract.
+ */
+export const createTypedRule = (ruleDefinition) => {
+    const catalogEntry = getRuleCatalogEntryForRuleNameOrNull(ruleDefinition.name);
+    const createdRule = ESLintUtils.RuleCreator.withoutDocs(ruleDefinition);
+    const ruleDocs = createdRule.meta.docs;
+    assertDefined(ruleDocs);
+    const canonicalDocsUrl = createRuleDocsUrl(ruleDefinition.name);
+    if (typeof ruleDocs.url === "string" && ruleDocs.url !== canonicalDocsUrl) {
+        throw new TypeError(`Rule '${ruleDefinition.name}' has non-canonical docs.url '${ruleDocs.url}'. Expected '${canonicalDocsUrl}'.`);
+    }
+    if (ruleDefinition.name.startsWith("prefer-") && catalogEntry === null) {
+        throw new TypeError(`Rule '${ruleDefinition.name}' is missing from the stable rule catalog.`);
+    }
+    const docsWithCatalog = catalogEntry === null
+        ? {
+            ...ruleDocs,
+            ruleCatalogId: RULE_CATALOG_ID,
+            url: canonicalDocsUrl,
+        }
+        : {
+            ...ruleDocs,
+            ruleCatalogId: RULE_CATALOG_ID,
+            ruleId: catalogEntry.ruleId,
+            ruleNumber: catalogEntry.ruleNumber,
+            url: canonicalDocsUrl,
+        };
+    const metaDefaultOptions = createdRule.meta.defaultOptions;
+    return {
+        ...createdRule,
+        create(context) {
+            registerProgramSettingsForContext(context);
+            return createdRule.create(context);
+        },
+        meta: {
+            ...createdRule.meta,
+            ...(isDefined(metaDefaultOptions)
+                ? { defaultOptions: metaDefaultOptions }
+                : {}),
+            docs: docsWithCatalog,
+        },
+        name: ruleDefinition.name,
+    };
+};
+/**
+ * Retrieve parser services and type checker for typed rules.
+ *
+ * @param context - Rule context from the current lint evaluation.
+ *
+ * @returns Parser services and type checker references bound to the current
+ *   program.
+ *
+ * @throws Throws when `parserServices.program` is unavailable, which indicates
+ *   the current lint run is not configured for type-aware analysis.
+ */
+export const getTypedRuleServices = (context) => {
+    const parserServices = ESLintUtils.getParserServices(context, true);
+    const program = parserServices.program;
+    if (program === null) {
+        throw new Error("Typed rule requires parserServices.program; ensure projectService is enabled for this lint run.");
+    }
+    return {
+        checker: program.getTypeChecker(),
+        parserServices,
+    };
+};
+/**
+ * Determine whether the current lint context has full type information.
+ *
+ * @param context - Rule context from the current lint evaluation.
+ *
+ * @returns `true` when parser services and `program` are available.
+ */
+export const hasTypeServices = (context) => {
+    const parserServicesResult = safeTypeOperation({
+        operation: () => ESLintUtils.getParserServices(context, true),
+        reason: "typed-rule-services-check-failed",
+    });
+    return (parserServicesResult.ok && parserServicesResult.value.program !== null);
+};
+/**
+ * Retrieve typed services when available, otherwise return `undefined`.
+ *
+ * @param context - Rule context from the current lint evaluation.
+ *
+ * @returns Typed services when parser services include a TypeScript program.
+ */
+export const getTypedRuleServicesOrUndefined = (context) => hasTypeServices(context) ? getTypedRuleServices(context) : undefined;
+/**
+ * Determine whether one TypeScript type is assignable to another.
+ *
+ * @remarks
+ * Uses `checker.isTypeAssignableTo` when available and falls back to strict
+ * reference equality if the checker API is unavailable or throws.
+ *
+ * @param checker - TypeScript type checker.
+ * @param sourceType - Candidate source type.
+ * @param targetType - Candidate target type.
+ *
+ * @returns `true` when assignable; otherwise `false`.
+ */
+export const isTypeAssignableTo = (checker, sourceType, targetType) => {
+    const result = safeTypeOperation({
+        operation: () => getTypeCheckerIsTypeAssignableToResult(checker, sourceType, targetType),
+        reason: "type-assignability-check-failed",
+    });
+    if (!result.ok || typeof result.value !== "boolean") {
+        return sourceType === targetType;
+    }
+    return result.value;
+};
+/**
+ * Resolve the type of a signature parameter by index.
+ *
+ * @param options - Signature parameter lookup options.
+ *
+ *   - `checker`: TypeScript type checker.
+ *   - `index`: Parameter index in the signature.
+ *   - `location`: Source location used for contextual type lookup.
+ *   - `signature`: Candidate call signature.
+ *
+ * @returns Parameter type when available; otherwise `undefined`.
+ */
+export const getSignatureParameterTypeAt = (options) => {
+    const { checker, index, location, signature } = options;
+    const symbol = signature?.parameters[index];
+    if (!symbol) {
+        return undefined;
+    }
+    return checker.getTypeOfSymbolAtLocation(symbol, location);
+};
+/**
+ * Determine whether an expression references an unshadowed global identifier.
+ *
+ * @param context - Rule context used for scope resolution.
+ * @param expression - Expression to inspect.
+ * @param identifierName - Expected identifier name.
+ *
+ * @returns `true` when the expression is an Identifier with the expected name
+ *   and resolves to the global binding.
+ */
+export const isGlobalIdentifierNamed = (context, expression, identifierName) => {
+    if (expression.type !== "Identifier" ||
+        expression.name !== identifierName) {
+        return false;
+    }
+    const result = safeTypeOperation({
+        operation: () => {
+            const initialScope = getScopeFromContextSourceCode(context, expression);
+            if (initialScope === null) {
+                return true;
+            }
+            const variable = getVariableInScopeChain(initialScope, identifierName);
+            return variable === null || variable.defs.length === 0;
+        },
+        reason: "scope-resolution-failed",
+    });
+    if (!result.ok) {
+        return false;
+    }
+    return result.value;
+};
+/**
+ * Determine whether an expression references the global `undefined` binding
+ * (not a shadowed user-defined symbol).
+ *
+ * @param context - Rule context used for scope resolution.
+ * @param expression - Expression to inspect.
+ *
+ * @returns `true` when the expression is an Identifier named `undefined` that
+ *   resolves to the global binding.
+ */
+export const isGlobalUndefinedIdentifier = (context, expression) => isGlobalIdentifierNamed(context, expression, "undefined");
+//# sourceMappingURL=typed-rule.js.map

package/dist/_internal/typed-rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-rule.js","sourceRoot":"","sources":["../../src/_internal/typed-rule.ts"],"names":[],"mappings":"AAQA,OAAO,EACH,WAAW,GAGd,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAIrD,OAAO,EAAE,iCAAiC,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,oCAAoC,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,sCAAsC,EAAE,MAAM,0BAA0B,CAAC;AAElF;;GAEG;AACH,MAAM,eAAe,GAAG,MAAe,CAAC;AAiDxC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,eAAe,GAAwB,CAAC,cAAc,EAAE,EAAE;IACnE,MAAM,YAAY,GAAG,oCAAoC,CACrD,cAAc,CAAC,IAAI,CACtB,CAAC;IACF,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IACxE,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;IACvC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACxB,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAEhE,IAAI,OAAO,QAAQ,CAAC,GAAG,KAAK,QAAQ,IAAI,QAAQ,CAAC,GAAG,KAAK,gBAAgB,EAAE,CAAC;QACxE,MAAM,IAAI,SAAS,CACf,SAAS,cAAc,CAAC,IAAI,iCAAiC,QAAQ,CAAC,GAAG,gBAAgB,gBAAgB,IAAI,CAChH,CAAC;IACN,CAAC;IAED,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QACrE,MAAM,IAAI,SAAS,CACf,SAAS,cAAc,CAAC,IAAI,4CAA4C,CAC3E,CAAC;IACN,CAAC;IAED,MAAM,eAAe,GACjB,YAAY,KAAK,IAAI;QACjB,CAAC,CAAC;YACI,GAAG,QAAQ;YACX,aAAa,EAAE,eAAe;YAC9B,GAAG,EAAE,gBAAgB;SACxB;QACH,CAAC,CAAC;YACI,GAAG,QAAQ;YACX,aAAa,EAAE,eAAe;YAC9B,MAAM,EAAE,YAAY,CAAC,MAAM;YAC3B,UAAU,EAAE,YAAY,CAAC,UAAU;YACnC,GAAG,EAAE,gBAAgB;SACxB,CAAC;IAEZ,MAAM,kBAAkB,GAAG,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC;IAE3D,OAAO;QACH,GAAG,WAAW;QACd,MAAM,CAAC,OAAO;YACV,iCAAiC,CAAC,OAAO,CAAC,CAAC;YAE3C,OAAO,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,EAAE;YACF,GAAG,WAAW,CAAC,IAAI;YACnB,GAAG,CAAC,SAAS,CAAC,kBAAkB,CAAC;gBAC7B,CAAC,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE;gBACxC,CAAC,CAAC,EAAE,CAAC;YACT,IAAI,EAAE,eAAe;SACxB;QACD,IAAI,EAAE,cAAc,CAAC,IAAI;KAC5B,CAAC;AACN,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAChC,OAAyB,EACR,EAAE;IACnB,MAAM,cAAc,GAAG,WAAW,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;IAEvC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACX,iGAAiG,CACpG,CAAC;IACN,CAAC;IAED,OAAO;QACH,OAAO,EAAE,OAAO,CAAC,cAAc,EAAE;QACjC,cAAc;KACjB,CAAC;AACN,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAyB,EAAW,EAAE;IAClE,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;QAC3C,SAAS,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC;QAC7D,MAAM,EAAE,kCAAkC;KAC7C,CAAC,CAAC;IAEH,OAAO,CACH,oBAAoB,CAAC,EAAE,IAAI,oBAAoB,CAAC,KAAK,CAAC,OAAO,KAAK,IAAI,CACzE,CAAC;AACN,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAC3C,OAAyB,EACI,EAAE,CAC/B,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAEzE;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAC9B,OAAiC,EACjC,UAA6B,EAC7B,UAA6B,EACtB,EAAE;IACT,MAAM,MAAM,GAAG,iBAAiB,CAAC;QAC7B,SAAS,EAAE,GAAG,EAAE,CACZ,sCAAsC,CAClC,OAAO,EACP,UAAU,EACV,UAAU,CACb;QACL,MAAM,EAAE,iCAAiC;KAC5C,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAClD,OAAO,UAAU,KAAK,UAAU,CAAC;IACrC,CAAC;IAED,OAAO,MAAM,CAAC,KAAK,CAAC;AACxB,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACvC,OAKE,EACiB,EAAE;IACrB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAExD,MAAM,MAAM,GAAG,SAAS,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IAC5C,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,OAAO,CAAC,yBAAyB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAInC,OAA4D,EAC5D,UAAyC,EACzC,cAAsB,EACW,EAAE;IACnC,IACI,UAAU,CAAC,IAAI,KAAK,YAAY;QAChC,UAAU,CAAC,IAAI,KAAK,cAAc,EACpC,CAAC;QACC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,MAAM,GAAG,iBAAiB,CAAC;QAC7B,SAAS,EAAE,GAAG,EAAE;YACZ,MAAM,YAAY,GAAG,6BAA6B,CAC9C,OAAO,EACP,UAAU,CACb,CAAC;YAEF,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAC;YAChB,CAAC;YAED,MAAM,QAAQ,GAAG,uBAAuB,CACpC,YAAY,EACZ,cAAc,CACjB,CAAC;YAEF,OAAO,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC;QAC3D,CAAC;QACD,MAAM,EAAE,yBAAyB;KACpC,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,MAAM,CAAC,KAAK,CAAC;AACxB,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAIvC,OAA4D,EAC5D,UAAyC,EACR,EAAE,CACnC,uBAAuB,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC"}

package/dist/_internal/typefest-config-references.d.ts

@@ -0,0 +1,45 @@
+/** Canonical flat-config preset keys exposed through `plugin.configs`. */
+export declare const typefestConfigNames: readonly ["all", "minimal", "recommended", "recommended-type-checked", "strict", "ts-extras/type-guards", "type-fest/types"];
+/** Metadata contract shared across preset wiring, docs, and README rendering. */
+export type TypefestConfigMetadata = Readonly<{
+    icon: string;
+    presetName: `typefest:${TypefestConfigName}`;
+    readmeOrder: number;
+    requiresTypeChecking: boolean;
+}>;
+/** Canonical flat-config preset key type exposed through `plugin.configs`. */
+export type TypefestConfigName = (typeof typefestConfigNames)[number];
+/**
+ * Canonical metadata for every exported `typefest` preset key.
+ *
+ * @remarks
+ * This is the single source of truth for:
+ *
+ * - Preset display order in generated README tables,
+ * - Preset icon mapping,
+ * - Preset runtime flat-config names, and
+ * - Preset type-checking requirements.
+ */
+export declare const typefestConfigMetadataByName: Readonly<Record<TypefestConfigName, TypefestConfigMetadata>>;
+/** Stable README legend/rendering order for preset icons. */
+export declare const typefestConfigNamesByReadmeOrder: readonly TypefestConfigName[];
+/** Metadata references supported in `meta.docs.recommended`. */
+export declare const typefestConfigReferenceToName: Readonly<{
+    "typefest.configs.all": "all";
+    "typefest.configs.minimal": "minimal";
+    "typefest.configs.recommended": "recommended";
+    "typefest.configs.recommended-type-checked": "recommended-type-checked";
+    "typefest.configs.strict": "strict";
+    "typefest.configs.ts-extras/type-guards": "ts-extras/type-guards";
+    "typefest.configs.type-fest/types": "type-fest/types";
+    'typefest.configs["recommended-type-checked"]': "recommended-type-checked";
+    'typefest.configs["ts-extras/type-guards"]': "ts-extras/type-guards";
+    'typefest.configs["type-fest/types"]': "type-fest/types";
+}>;
+/** Fully-qualified preset reference type accepted in docs metadata. */
+export type TypefestConfigReference = keyof typeof typefestConfigReferenceToName;
+/**
+ * Check whether a string is a supported `meta.docs.recommended` reference.
+ */
+export declare const isTypefestConfigReference: (value: string) => value is TypefestConfigReference;
+//# sourceMappingURL=typefest-config-references.d.ts.map

package/dist/_internal/typefest-config-references.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typefest-config-references.d.ts","sourceRoot":"","sources":["../../src/_internal/typefest-config-references.ts"],"names":[],"mappings":"AAMA,0EAA0E;AAC1E,eAAO,MAAM,mBAAmB,8HAQtB,CAAC;AAEX,iFAAiF;AACjF,MAAM,MAAM,sBAAsB,GAAG,QAAQ,CAAC;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,YAAY,kBAAkB,EAAE,CAAC;IAC7C,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB,EAAE,OAAO,CAAC;CACjC,CAAC,CAAC;AAEH,8EAA8E;AAC9E,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,4BAA4B,EAAE,QAAQ,CAC/C,MAAM,CAAC,kBAAkB,EAAE,sBAAsB,CAAC,CA4CrD,CAAC;AAEF,6DAA6D;AAC7D,eAAO,MAAM,gCAAgC,EAAE,SAAS,kBAAkB,EAQzE,CAAC;AAEF,gEAAgE;AAChE,eAAO,MAAM,6BAA6B,EAAE,QAAQ,CAAC;IACjD,sBAAsB,EAAE,KAAK,CAAC;IAC9B,0BAA0B,EAAE,SAAS,CAAC;IACtC,8BAA8B,EAAE,aAAa,CAAC;IAC9C,2CAA2C,EAAE,0BAA0B,CAAC;IACxE,yBAAyB,EAAE,QAAQ,CAAC;IACpC,wCAAwC,EAAE,uBAAuB,CAAC;IAClE,kCAAkC,EAAE,iBAAiB,CAAC;IACtD,8CAA8C,EAAE,0BAA0B,CAAC;IAC3E,2CAA2C,EAAE,uBAAuB,CAAC;IACrE,qCAAqC,EAAE,iBAAiB,CAAC;CAC5D,CAWA,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,uBAAuB,GAC/B,MAAM,OAAO,6BAA6B,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,yBAAyB,GAClC,OAAO,MAAM,KACd,KAAK,IAAI,uBAC0C,CAAC"}