eslint-plugin-typefest 1.0.1

package/dist/rules/prefer-ts-extras-as-writable.d.ts

@@ -0,0 +1,13 @@
+import { createTypedRule } from "../_internal/typed-rule.js";
+/**
+ * ESLint rule definition for `prefer-ts-extras-as-writable`.
+ *
+ * @remarks
+ * Defines metadata, diagnostics, and suggestions/fixes for this rule.
+ */
+declare const preferTsExtrasAsWritableRule: ReturnType<typeof createTypedRule>;
+/**
+ * Default export for the `prefer-ts-extras-as-writable` rule module.
+ */
+export default preferTsExtrasAsWritableRule;
+//# sourceMappingURL=prefer-ts-extras-as-writable.d.ts.map

package/dist/rules/prefer-ts-extras-as-writable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-ts-extras-as-writable.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-ts-extras-as-writable.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAI7D;;;;;GAKG;AACH,QAAA,MAAM,4BAA4B,EAAE,UAAU,CAAC,OAAO,eAAe,CA4I/D,CAAC;AAEP;;GAEG;AACH,eAAe,4BAA4B,CAAC"}

package/dist/rules/prefer-ts-extras-as-writable.js

@@ -0,0 +1,110 @@
+import { collectNamedImportLocalNamesFromSource, collectNamespaceImportLocalNamesFromSource, } from "../_internal/imported-type-aliases.js";
+import { collectDirectNamedValueImportsFromSource, createSafeValueNodeTextReplacementFix, getFunctionCallArgumentText, } from "../_internal/imported-value-symbols.js";
+import { TS_EXTRAS_MODULE_SOURCE, TYPE_FEST_MODULE_SOURCE, } from "../_internal/module-source.js";
+import { reportWithOptionalFix } from "../_internal/rule-reporting.js";
+import { setContainsValue } from "../_internal/set-membership.js";
+import { createTypedRule } from "../_internal/typed-rule.js";
+const WRITABLE_TYPE_NAME = "Writable";
+/**
+ * ESLint rule definition for `prefer-ts-extras-as-writable`.
+ *
+ * @remarks
+ * Defines metadata, diagnostics, and suggestions/fixes for this rule.
+ */
+const preferTsExtrasAsWritableRule = createTypedRule({
+    create(context) {
+        const tsExtrasImports = collectDirectNamedValueImportsFromSource(context.sourceCode, TS_EXTRAS_MODULE_SOURCE);
+        const writableLocalNames = collectNamedImportLocalNamesFromSource(context.sourceCode, TYPE_FEST_MODULE_SOURCE, WRITABLE_TYPE_NAME);
+        const typeFestNamespaceImportNames = collectNamespaceImportLocalNamesFromSource(context.sourceCode, TYPE_FEST_MODULE_SOURCE);
+        /**
+         * Check whether a type annotation references `Writable` from
+         * `type-fest` (direct import or namespace member).
+         */
+        const isWritableTypeReference = (typeAnnotation) => {
+            if (typeAnnotation.type !== "TSTypeReference") {
+                return false;
+            }
+            if (typeAnnotation.typeName.type === "Identifier") {
+                return setContainsValue(writableLocalNames, typeAnnotation.typeName.name);
+            }
+            if (typeAnnotation.typeName.type !== "TSQualifiedName") {
+                return false;
+            }
+            return (typeAnnotation.typeName.left.type === "Identifier" &&
+                setContainsValue(typeFestNamespaceImportNames, typeAnnotation.typeName.left.name) &&
+                typeAnnotation.typeName.right.type === "Identifier" &&
+                typeAnnotation.typeName.right.name === WRITABLE_TYPE_NAME);
+        };
+        /**
+         * Report and optionally autofix `Writable<...>` type assertions to
+         * `asWritable(...)` calls.
+         */
+        const reportIfWritableAssertion = (node, expression, typeAnnotation) => {
+            if (!isWritableTypeReference(typeAnnotation)) {
+                return;
+            }
+            const expressionArgumentText = getFunctionCallArgumentText({
+                argumentNode: expression,
+                sourceCode: context.sourceCode,
+            });
+            if (expressionArgumentText === null) {
+                reportWithOptionalFix({
+                    context,
+                    fix: null,
+                    messageId: "preferTsExtrasAsWritable",
+                    node,
+                });
+                return;
+            }
+            const fix = createSafeValueNodeTextReplacementFix({
+                context,
+                importedName: "asWritable",
+                imports: tsExtrasImports,
+                replacementTextFactory: (replacementName) => `${replacementName}(${expressionArgumentText})`,
+                sourceModuleName: TS_EXTRAS_MODULE_SOURCE,
+                targetNode: node,
+            });
+            reportWithOptionalFix({
+                context,
+                fix,
+                messageId: "preferTsExtrasAsWritable",
+                node,
+            });
+        };
+        return {
+            TSAsExpression(node) {
+                reportIfWritableAssertion(node, node.expression, node.typeAnnotation);
+            },
+            TSTypeAssertion(node) {
+                reportIfWritableAssertion(node, node.expression, node.typeAnnotation);
+            },
+        };
+    },
+    defaultOptions: [],
+    meta: {
+        deprecated: false,
+        docs: {
+            description: "require ts-extras asWritable over Writable<T> style assertions from type-fest.",
+            frozen: false,
+            recommended: false,
+            requiresTypeChecking: false,
+            typefestConfigs: [
+                "typefest.configs.strict",
+                "typefest.configs.all",
+            ],
+            url: "https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-ts-extras-as-writable",
+        },
+        fixable: "code",
+        messages: {
+            preferTsExtrasAsWritable: "Prefer `asWritable(value)` from `ts-extras` over `Writable<...>` assertions.",
+        },
+        schema: [],
+        type: "suggestion",
+    },
+    name: "prefer-ts-extras-as-writable",
+});
+/**
+ * Default export for the `prefer-ts-extras-as-writable` rule module.
+ */
+export default preferTsExtrasAsWritableRule;
+//# sourceMappingURL=prefer-ts-extras-as-writable.js.map

package/dist/rules/prefer-ts-extras-as-writable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-ts-extras-as-writable.js","sourceRoot":"","sources":["../../src/rules/prefer-ts-extras-as-writable.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,sCAAsC,EACtC,0CAA0C,GAC7C,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACH,wCAAwC,EACxC,qCAAqC,EACrC,2BAA2B,GAC9B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACH,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D,MAAM,kBAAkB,GAAG,UAAmB,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,4BAA4B,GAC9B,eAAe,CAAC;IACZ,MAAM,CAAC,OAAO;QACV,MAAM,eAAe,GAAG,wCAAwC,CAC5D,OAAO,CAAC,UAAU,EAClB,uBAAuB,CAC1B,CAAC;QAEF,MAAM,kBAAkB,GAAG,sCAAsC,CAC7D,OAAO,CAAC,UAAU,EAClB,uBAAuB,EACvB,kBAAkB,CACrB,CAAC;QACF,MAAM,4BAA4B,GAC9B,0CAA0C,CACtC,OAAO,CAAC,UAAU,EAClB,uBAAuB,CAC1B,CAAC;QAEN;;;WAGG;QACH,MAAM,uBAAuB,GAAG,CAC5B,cAA2C,EACpC,EAAE;YACT,IAAI,cAAc,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBAC5C,OAAO,KAAK,CAAC;YACjB,CAAC;YAED,IAAI,cAAc,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBAChD,OAAO,gBAAgB,CACnB,kBAAkB,EAClB,cAAc,CAAC,QAAQ,CAAC,IAAI,CAC/B,CAAC;YACN,CAAC;YAED,IAAI,cAAc,CAAC,QAAQ,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBACrD,OAAO,KAAK,CAAC;YACjB,CAAC;YAED,OAAO,CACH,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY;gBAClD,gBAAgB,CACZ,4BAA4B,EAC5B,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CACpC;gBACD,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY;gBACnD,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,kBAAkB,CAC5D,CAAC;QACN,CAAC,CAAC;QAEF;;;WAGG;QACH,MAAM,yBAAyB,GAAG,CAC9B,IAA6B,EAC7B,UAAyC,EACzC,cAA2C,EACvC,EAAE;YACN,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC3C,OAAO;YACX,CAAC;YAED,MAAM,sBAAsB,GAAG,2BAA2B,CAAC;gBACvD,YAAY,EAAE,UAAU;gBACxB,UAAU,EAAE,OAAO,CAAC,UAAU;aACjC,CAAC,CAAC;YAEH,IAAI,sBAAsB,KAAK,IAAI,EAAE,CAAC;gBAClC,qBAAqB,CAAC;oBAClB,OAAO;oBACP,GAAG,EAAE,IAAI;oBACT,SAAS,EAAE,0BAA0B;oBACrC,IAAI;iBACP,CAAC,CAAC;gBAEH,OAAO;YACX,CAAC;YAED,MAAM,GAAG,GAAG,qCAAqC,CAAC;gBAC9C,OAAO;gBACP,YAAY,EAAE,YAAY;gBAC1B,OAAO,EAAE,eAAe;gBACxB,sBAAsB,EAAE,CAAC,eAAe,EAAE,EAAE,CACxC,GAAG,eAAe,IAAI,sBAAsB,GAAG;gBACnD,gBAAgB,EAAE,uBAAuB;gBACzC,UAAU,EAAE,IAAI;aACnB,CAAC,CAAC;YAEH,qBAAqB,CAAC;gBAClB,OAAO;gBACP,GAAG;gBACH,SAAS,EAAE,0BAA0B;gBACrC,IAAI;aACP,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,OAAO;YACH,cAAc,CAAC,IAAI;gBACf,yBAAyB,CACrB,IAAI,EACJ,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,cAAc,CACtB,CAAC;YACN,CAAC;YACD,eAAe,CAAC,IAAI;gBAChB,yBAAyB,CACrB,IAAI,EACJ,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,cAAc,CACtB,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IACD,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACF,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,gFAAgF;YACpF,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,eAAe,EAAE;gBACb,yBAAyB;gBACzB,sBAAsB;aACzB;YACD,GAAG,EAAE,6FAA6F;SACrG;QACD,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACN,wBAAwB,EACpB,8EAA8E;SACrF;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACrB;IACD,IAAI,EAAE,8BAA8B;CACvC,CAAC,CAAC;AAEP;;GAEG;AACH,eAAe,4BAA4B,CAAC"}

package/dist/rules/prefer-ts-extras-assert-defined.d.ts

@@ -0,0 +1,13 @@
+import { createTypedRule } from "../_internal/typed-rule.js";
+/**
+ * ESLint rule definition for `prefer-ts-extras-assert-defined`.
+ *
+ * @remarks
+ * Defines metadata, diagnostics, and suggestions/fixes for this rule.
+ */
+declare const preferTsExtrasAssertDefinedRule: ReturnType<typeof createTypedRule>;
+/**
+ * Default export for the `prefer-ts-extras-assert-defined` rule module.
+ */
+export default preferTsExtrasAssertDefinedRule;
+//# sourceMappingURL=prefer-ts-extras-assert-defined.d.ts.map

package/dist/rules/prefer-ts-extras-assert-defined.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-ts-extras-assert-defined.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-ts-extras-assert-defined.ts"],"names":[],"mappings":"AAqBA,OAAO,EACH,eAAe,EAElB,MAAM,4BAA4B,CAAC;AAmGpC;;;;;GAKG;AACH,QAAA,MAAM,+BAA+B,EAAE,UAAU,CAAC,OAAO,eAAe,CAkIlE,CAAC;AAEP;;GAEG;AACH,eAAe,+BAA+B,CAAC"}

package/dist/rules/prefer-ts-extras-assert-defined.js

@@ -0,0 +1,182 @@
+import { collectDirectNamedValueImportsFromSource, createSafeValueNodeTextReplacementFix, getFunctionCallArgumentText, } from "../_internal/imported-value-symbols.js";
+import { TS_EXTRAS_MODULE_SOURCE } from "../_internal/module-source.js";
+import { reportWithOptionalFix, reportWithTypefestPolicy, } from "../_internal/rule-reporting.js";
+import { getThrowStatementFromConsequent, isThrowOnlyConsequent, } from "../_internal/throw-consequent.js";
+import { getSingleGlobalTypeErrorArgument } from "../_internal/throw-type-error.js";
+import { createTypedRule, isGlobalUndefinedIdentifier, } from "../_internal/typed-rule.js";
+/**
+ * Determine whether an expression references the global `undefined` value.
+ *
+ * @param context - Active rule context for scope resolution.
+ * @param node - Expression to inspect.
+ *
+ * @returns `true` when the expression is an unshadowed `undefined` identifier.
+ */
+const isUndefinedExpression = ({ context, node, }) => {
+    if (node.type !== "Identifier" || node.name !== "undefined") {
+        return false;
+    }
+    return isGlobalUndefinedIdentifier(context, node);
+};
+/**
+ * Check whether the throw body matches the canonical assertDefined-equivalent
+ * error shape.
+ *
+ * @param context - Active rule context for global-binding checks.
+ * @param throwStatement - Throw statement extracted from the guard branch.
+ *
+ * @returns True when the throw is a TypeError whose message equals "Expected a
+ *   defined value, got undefined".
+ */
+const isCanonicalAssertDefinedThrow = (context, throwStatement) => {
+    const firstArgument = getSingleGlobalTypeErrorArgument({
+        context,
+        throwStatement,
+    });
+    if (firstArgument === null) {
+        return false;
+    }
+    return (firstArgument.type === "Literal" &&
+        firstArgument.value === "Expected a defined value, got `undefined`");
+};
+/**
+ * Extract the guarded expression from `x == undefined` / `undefined === x`
+ * checks.
+ *
+ * @param test - Conditional test expression to inspect.
+ * @param context - Active rule context for global-binding checks.
+ *
+ * @returns Guarded expression when the test is a supported undefined
+ *   comparison; otherwise `null`.
+ */
+const extractDefinedGuardExpression = (test, context) => {
+    if (test.type !== "BinaryExpression" ||
+        (test.operator !== "==" && test.operator !== "===")) {
+        return null;
+    }
+    if (isUndefinedExpression({
+        context,
+        node: test.left,
+    })) {
+        return test.right;
+    }
+    if (isUndefinedExpression({
+        context,
+        node: test.right,
+    })) {
+        return test.left;
+    }
+    return null;
+};
+/**
+ * ESLint rule definition for `prefer-ts-extras-assert-defined`.
+ *
+ * @remarks
+ * Defines metadata, diagnostics, and suggestions/fixes for this rule.
+ */
+const preferTsExtrasAssertDefinedRule = createTypedRule({
+    create(context) {
+        const tsExtrasImports = collectDirectNamedValueImportsFromSource(context.sourceCode, TS_EXTRAS_MODULE_SOURCE);
+        return {
+            IfStatement(node) {
+                if (node.alternate !== null ||
+                    !isThrowOnlyConsequent(node.consequent)) {
+                    return;
+                }
+                const guardExpression = extractDefinedGuardExpression(node.test, context);
+                if (guardExpression === null) {
+                    return;
+                }
+                const throwStatement = getThrowStatementFromConsequent(node.consequent);
+                const canAutofix = throwStatement !== null &&
+                    isCanonicalAssertDefinedThrow(context, throwStatement);
+                const guardExpressionArgumentText = getFunctionCallArgumentText({
+                    argumentNode: guardExpression,
+                    sourceCode: context.sourceCode,
+                });
+                if (guardExpressionArgumentText === null) {
+                    reportWithOptionalFix({
+                        context,
+                        fix: null,
+                        messageId: "preferTsExtrasAssertDefined",
+                        node,
+                    });
+                    return;
+                }
+                const replacementFix = createSafeValueNodeTextReplacementFix({
+                    context,
+                    importedName: "assertDefined",
+                    imports: tsExtrasImports,
+                    replacementTextFactory: (replacementName) => `${replacementName}(${guardExpressionArgumentText});`,
+                    reportFixIntent: canAutofix
+                        ? "autofix"
+                        : "suggestion",
+                    sourceModuleName: TS_EXTRAS_MODULE_SOURCE,
+                    targetNode: node,
+                });
+                if (replacementFix === null) {
+                    reportWithOptionalFix({
+                        context,
+                        fix: null,
+                        messageId: "preferTsExtrasAssertDefined",
+                        node,
+                    });
+                    return;
+                }
+                if (canAutofix) {
+                    reportWithOptionalFix({
+                        context,
+                        fix: replacementFix,
+                        messageId: "preferTsExtrasAssertDefined",
+                        node,
+                    });
+                    return;
+                }
+                reportWithTypefestPolicy({
+                    context,
+                    descriptor: {
+                        messageId: "preferTsExtrasAssertDefined",
+                        node,
+                        suggest: [
+                            {
+                                fix: replacementFix,
+                                messageId: "suggestTsExtrasAssertDefined",
+                            },
+                        ],
+                    },
+                });
+            },
+        };
+    },
+    defaultOptions: [],
+    meta: {
+        deprecated: false,
+        docs: {
+            description: "require ts-extras assertDefined over manual undefined-guard throw blocks.",
+            frozen: false,
+            recommended: true,
+            requiresTypeChecking: false,
+            typefestConfigs: [
+                "typefest.configs.recommended",
+                "typefest.configs.strict",
+                "typefest.configs.all",
+                "typefest.configs.ts-extras/type-guards",
+            ],
+            url: "https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-ts-extras-assert-defined",
+        },
+        fixable: "code",
+        hasSuggestions: true,
+        messages: {
+            preferTsExtrasAssertDefined: "Prefer `assertDefined` from `ts-extras` over manual undefined guard throw blocks.",
+            suggestTsExtrasAssertDefined: "Replace this manual guard with `assertDefined(...)` from `ts-extras`.",
+        },
+        schema: [],
+        type: "suggestion",
+    },
+    name: "prefer-ts-extras-assert-defined",
+});
+/**
+ * Default export for the `prefer-ts-extras-assert-defined` rule module.
+ */
+export default preferTsExtrasAssertDefinedRule;
+//# sourceMappingURL=prefer-ts-extras-assert-defined.js.map

package/dist/rules/prefer-ts-extras-assert-defined.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-ts-extras-assert-defined.js","sourceRoot":"","sources":["../../src/rules/prefer-ts-extras-assert-defined.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,wCAAwC,EACxC,qCAAqC,EACrC,2BAA2B,GAC9B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EACH,qBAAqB,EACrB,wBAAwB,GAC3B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACH,+BAA+B,EAC/B,qBAAqB,GACxB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,gCAAgC,EAAE,MAAM,kCAAkC,CAAC;AACpF,OAAO,EACH,eAAe,EACf,2BAA2B,GAC9B,MAAM,4BAA4B,CAAC;AAOpC;;;;;;;GAOG;AACH,MAAM,qBAAqB,GAAG,CAAC,EAC3B,OAAO,EACP,IAAI,GAIN,EAAW,EAAE;IACX,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QAC1D,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,2BAA2B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,6BAA6B,GAAG,CAClC,OAAoB,EACpB,cAAiD,EAC1C,EAAE;IACT,MAAM,aAAa,GAAG,gCAAgC,CAAC;QACnD,OAAO;QACP,cAAc;KACjB,CAAC,CAAC;IACH,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,CACH,aAAa,CAAC,IAAI,KAAK,SAAS;QAChC,aAAa,CAAC,KAAK,KAAK,2CAA2C,CACtE,CAAC;AACN,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,6BAA6B,GAAG,CAClC,IAAmC,EACnC,OAAoB,EACM,EAAE;IAC5B,IACI,IAAI,CAAC,IAAI,KAAK,kBAAkB;QAChC,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,EACrD,CAAC;QACC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IACI,qBAAqB,CAAC;QAClB,OAAO;QACP,IAAI,EAAE,IAAI,CAAC,IAAI;KAClB,CAAC,EACJ,CAAC;QACC,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,IACI,qBAAqB,CAAC;QAClB,OAAO;QACP,IAAI,EAAE,IAAI,CAAC,KAAK;KACnB,CAAC,EACJ,CAAC;QACC,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,+BAA+B,GACjC,eAAe,CAAC;IACZ,MAAM,CAAC,OAAO;QACV,MAAM,eAAe,GAAG,wCAAwC,CAC5D,OAAO,CAAC,UAAU,EAClB,uBAAuB,CAC1B,CAAC;QAEF,OAAO;YACH,WAAW,CAAC,IAAI;gBACZ,IACI,IAAI,CAAC,SAAS,KAAK,IAAI;oBACvB,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,EACzC,CAAC;oBACC,OAAO;gBACX,CAAC;gBAED,MAAM,eAAe,GAAG,6BAA6B,CACjD,IAAI,CAAC,IAAI,EACT,OAAO,CACV,CAAC;gBAEF,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;oBAC3B,OAAO;gBACX,CAAC;gBAED,MAAM,cAAc,GAAG,+BAA+B,CAClD,IAAI,CAAC,UAAU,CAClB,CAAC;gBACF,MAAM,UAAU,GACZ,cAAc,KAAK,IAAI;oBACvB,6BAA6B,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;gBAC3D,MAAM,2BAA2B,GAC7B,2BAA2B,CAAC;oBACxB,YAAY,EAAE,eAAe;oBAC7B,UAAU,EAAE,OAAO,CAAC,UAAU;iBACjC,CAAC,CAAC;gBAEP,IAAI,2BAA2B,KAAK,IAAI,EAAE,CAAC;oBACvC,qBAAqB,CAAC;wBAClB,OAAO;wBACP,GAAG,EAAE,IAAI;wBACT,SAAS,EAAE,6BAA6B;wBACxC,IAAI;qBACP,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,MAAM,cAAc,GAChB,qCAAqC,CAAC;oBAClC,OAAO;oBACP,YAAY,EAAE,eAAe;oBAC7B,OAAO,EAAE,eAAe;oBACxB,sBAAsB,EAAE,CAAC,eAAe,EAAE,EAAE,CACxC,GAAG,eAAe,IAAI,2BAA2B,IAAI;oBACzD,eAAe,EAAE,UAAU;wBACvB,CAAC,CAAC,SAAS;wBACX,CAAC,CAAC,YAAY;oBAClB,gBAAgB,EAAE,uBAAuB;oBACzC,UAAU,EAAE,IAAI;iBACnB,CAAC,CAAC;gBAEP,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;oBAC1B,qBAAqB,CAAC;wBAClB,OAAO;wBACP,GAAG,EAAE,IAAI;wBACT,SAAS,EAAE,6BAA6B;wBACxC,IAAI;qBACP,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,IAAI,UAAU,EAAE,CAAC;oBACb,qBAAqB,CAAC;wBAClB,OAAO;wBACP,GAAG,EAAE,cAAc;wBACnB,SAAS,EAAE,6BAA6B;wBACxC,IAAI;qBACP,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,wBAAwB,CAAC;oBACrB,OAAO;oBACP,UAAU,EAAE;wBACR,SAAS,EAAE,6BAA6B;wBACxC,IAAI;wBACJ,OAAO,EAAE;4BACL;gCACI,GAAG,EAAE,cAAc;gCACnB,SAAS,EAAE,8BAA8B;6BAC5C;yBACJ;qBACJ;iBACJ,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACF,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,2EAA2E;YAC/E,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,eAAe,EAAE;gBACb,8BAA8B;gBAC9B,yBAAyB;gBACzB,sBAAsB;gBACtB,wCAAwC;aAC3C;YACD,GAAG,EAAE,gGAAgG;SACxG;QACD,OAAO,EAAE,MAAM;QACf,cAAc,EAAE,IAAI;QACpB,QAAQ,EAAE;YACN,2BAA2B,EACvB,mFAAmF;YACvF,4BAA4B,EACxB,uEAAuE;SAC9E;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACrB;IACD,IAAI,EAAE,iCAAiC;CAC1C,CAAC,CAAC;AAEP;;GAEG;AACH,eAAe,+BAA+B,CAAC"}

package/dist/rules/prefer-ts-extras-assert-error.d.ts

@@ -0,0 +1,13 @@
+import { createTypedRule } from "../_internal/typed-rule.js";
+/**
+ * ESLint rule definition for `prefer-ts-extras-assert-error`.
+ *
+ * @remarks
+ * Defines metadata, diagnostics, and suggestions/fixes for this rule.
+ */
+declare const preferTsExtrasAssertErrorRule: ReturnType<typeof createTypedRule>;
+/**
+ * Default export for the `prefer-ts-extras-assert-error` rule module.
+ */
+export default preferTsExtrasAssertErrorRule;
+//# sourceMappingURL=prefer-ts-extras-assert-error.d.ts.map

package/dist/rules/prefer-ts-extras-assert-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-ts-extras-assert-error.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-ts-extras-assert-error.ts"],"names":[],"mappings":"AAkBA,OAAO,EACH,eAAe,EAElB,MAAM,4BAA4B,CAAC;AAoEpC;;;;;GAKG;AACH,QAAA,MAAM,6BAA6B,EAAE,UAAU,CAAC,OAAO,eAAe,CA8GhE,CAAC;AAEP;;GAEG;AACH,eAAe,6BAA6B,CAAC"}

package/dist/rules/prefer-ts-extras-assert-error.js

@@ -0,0 +1,152 @@
+import { collectDirectNamedValueImportsFromSource, createSafeValueNodeTextReplacementFix, getFunctionCallArgumentText, } from "../_internal/imported-value-symbols.js";
+import { TS_EXTRAS_MODULE_SOURCE } from "../_internal/module-source.js";
+import { reportWithOptionalFix, reportWithTypefestPolicy, } from "../_internal/rule-reporting.js";
+import { isThrowOnlyConsequent } from "../_internal/throw-consequent.js";
+import { createTypedRule, isGlobalIdentifierNamed, } from "../_internal/typed-rule.js";
+/**
+ * Checks whether an expression is `<value> instanceof Error`.
+ *
+ * @param context - Rule context used to verify that `Error` resolves to the
+ *   global constructor.
+ * @param expression - Expression to inspect.
+ *
+ * @returns `true` when the expression is an `instanceof` check against the
+ *   global `Error` symbol.
+ */
+const isErrorInstanceofExpression = (context, expression) => {
+    if (expression.type !== "BinaryExpression") {
+        return false;
+    }
+    if (expression.operator !== "instanceof") {
+        return false;
+    }
+    if (expression.right.type !== "Identifier") {
+        return false;
+    }
+    return isGlobalIdentifierNamed(context, expression.right, "Error");
+};
+/**
+ * Extracts the guarded value from `!(value instanceof Error)` checks.
+ *
+ * @param context - Rule context used for global identifier resolution.
+ * @param test - `IfStatement.test` expression to inspect.
+ *
+ * @returns The left-hand expression from `value instanceof Error` when the test
+ *   shape is compatible with `assertError`; otherwise `null`.
+ */
+const extractAssertErrorTarget = (context, test) => {
+    if (test.type !== "UnaryExpression") {
+        return null;
+    }
+    if (test.operator !== "!") {
+        return null;
+    }
+    const { argument } = test;
+    if (!isErrorInstanceofExpression(context, argument)) {
+        return null;
+    }
+    /* V8 ignore next -- ESTree allows PrivateIdentifier here, but parsed
+       TS/JS `instanceof` left operands are expressions (e.g. `this.#value`),
+       not bare PrivateIdentifier nodes. */
+    if (argument.left.type === "PrivateIdentifier") {
+        return null;
+    }
+    return argument.left;
+};
+/**
+ * ESLint rule definition for `prefer-ts-extras-assert-error`.
+ *
+ * @remarks
+ * Defines metadata, diagnostics, and suggestions/fixes for this rule.
+ */
+const preferTsExtrasAssertErrorRule = createTypedRule({
+    create(context) {
+        const tsExtrasImports = collectDirectNamedValueImportsFromSource(context.sourceCode, TS_EXTRAS_MODULE_SOURCE);
+        return {
+            IfStatement(node) {
+                if (node.alternate !== null ||
+                    !isThrowOnlyConsequent(node.consequent)) {
+                    return;
+                }
+                const guardExpression = extractAssertErrorTarget(context, node.test);
+                if (guardExpression === null) {
+                    return;
+                }
+                const guardExpressionArgumentText = getFunctionCallArgumentText({
+                    argumentNode: guardExpression,
+                    sourceCode: context.sourceCode,
+                });
+                if (guardExpressionArgumentText === null) {
+                    reportWithOptionalFix({
+                        context,
+                        fix: null,
+                        messageId: "preferTsExtrasAssertError",
+                        node,
+                    });
+                    return;
+                }
+                const replacementFix = createSafeValueNodeTextReplacementFix({
+                    context,
+                    importedName: "assertError",
+                    imports: tsExtrasImports,
+                    replacementTextFactory: (replacementName) => `${replacementName}(${guardExpressionArgumentText});`,
+                    reportFixIntent: "suggestion",
+                    sourceModuleName: TS_EXTRAS_MODULE_SOURCE,
+                    targetNode: node,
+                });
+                if (replacementFix === null) {
+                    reportWithOptionalFix({
+                        context,
+                        fix: null,
+                        messageId: "preferTsExtrasAssertError",
+                        node,
+                    });
+                    return;
+                }
+                reportWithTypefestPolicy({
+                    context,
+                    descriptor: {
+                        messageId: "preferTsExtrasAssertError",
+                        node,
+                        suggest: [
+                            {
+                                fix: replacementFix,
+                                messageId: "suggestTsExtrasAssertError",
+                            },
+                        ],
+                    },
+                });
+            },
+        };
+    },
+    defaultOptions: [],
+    meta: {
+        deprecated: false,
+        docs: {
+            description: "require ts-extras assertError over manual instanceof Error throw guards.",
+            frozen: false,
+            recommended: true,
+            requiresTypeChecking: false,
+            typefestConfigs: [
+                "typefest.configs.recommended",
+                "typefest.configs.strict",
+                "typefest.configs.all",
+                "typefest.configs.ts-extras/type-guards",
+            ],
+            url: "https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-ts-extras-assert-error",
+        },
+        hasSuggestions: true,
+        messages: {
+            preferTsExtrasAssertError: "Prefer `assertError` from `ts-extras` over manual `instanceof Error` throw guards.",
+            suggestTsExtrasAssertError: "Replace this manual guard with `assertError(...)` from `ts-extras`.",
+        },
+        schema: [],
+        type: "suggestion",
+    },
+    name: "prefer-ts-extras-assert-error",
+});
+/**
+ * Default export for the `prefer-ts-extras-assert-error` rule module.
+ */
+export default preferTsExtrasAssertErrorRule;
+//# sourceMappingURL=prefer-ts-extras-assert-error.js.map

package/dist/rules/prefer-ts-extras-assert-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-ts-extras-assert-error.js","sourceRoot":"","sources":["../../src/rules/prefer-ts-extras-assert-error.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,wCAAwC,EACxC,qCAAqC,EACrC,2BAA2B,GAC9B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EACH,qBAAqB,EACrB,wBAAwB,GAC3B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EACH,eAAe,EACf,uBAAuB,GAC1B,MAAM,4BAA4B,CAAC;AAEpC;;;;;;;;;GASG;AACH,MAAM,2BAA2B,GAAG,CAChC,OAAuE,EACvE,UAAyC,EACF,EAAE;IACzC,IAAI,UAAU,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;QACzC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,UAAU,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACzC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,uBAAuB,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACvE,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,wBAAwB,GAAG,CAC7B,OAAuE,EACvE,IAAmC,EACT,EAAE;IAC5B,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,GAAG,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAE1B,IAAI,CAAC,2BAA2B,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;2CAEuC;IACvC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,6BAA6B,GAC/B,eAAe,CAAC;IACZ,MAAM,CAAC,OAAO;QACV,MAAM,eAAe,GAAG,wCAAwC,CAC5D,OAAO,CAAC,UAAU,EAClB,uBAAuB,CAC1B,CAAC;QAEF,OAAO;YACH,WAAW,CAAC,IAAI;gBACZ,IACI,IAAI,CAAC,SAAS,KAAK,IAAI;oBACvB,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,EACzC,CAAC;oBACC,OAAO;gBACX,CAAC;gBAED,MAAM,eAAe,GAAG,wBAAwB,CAC5C,OAAO,EACP,IAAI,CAAC,IAAI,CACZ,CAAC;gBAEF,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;oBAC3B,OAAO;gBACX,CAAC;gBAED,MAAM,2BAA2B,GAC7B,2BAA2B,CAAC;oBACxB,YAAY,EAAE,eAAe;oBAC7B,UAAU,EAAE,OAAO,CAAC,UAAU;iBACjC,CAAC,CAAC;gBAEP,IAAI,2BAA2B,KAAK,IAAI,EAAE,CAAC;oBACvC,qBAAqB,CAAC;wBAClB,OAAO;wBACP,GAAG,EAAE,IAAI;wBACT,SAAS,EAAE,2BAA2B;wBACtC,IAAI;qBACP,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,MAAM,cAAc,GAChB,qCAAqC,CAAC;oBAClC,OAAO;oBACP,YAAY,EAAE,aAAa;oBAC3B,OAAO,EAAE,eAAe;oBACxB,sBAAsB,EAAE,CAAC,eAAe,EAAE,EAAE,CACxC,GAAG,eAAe,IAAI,2BAA2B,IAAI;oBACzD,eAAe,EAAE,YAAY;oBAC7B,gBAAgB,EAAE,uBAAuB;oBACzC,UAAU,EAAE,IAAI;iBACnB,CAAC,CAAC;gBAEP,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;oBAC1B,qBAAqB,CAAC;wBAClB,OAAO;wBACP,GAAG,EAAE,IAAI;wBACT,SAAS,EAAE,2BAA2B;wBACtC,IAAI;qBACP,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,wBAAwB,CAAC;oBACrB,OAAO;oBACP,UAAU,EAAE;wBACR,SAAS,EAAE,2BAA2B;wBACtC,IAAI;wBACJ,OAAO,EAAE;4BACL;gCACI,GAAG,EAAE,cAAc;gCACnB,SAAS,EAAE,4BAA4B;6BAC1C;yBACJ;qBACJ;iBACJ,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACF,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,0EAA0E;YAC9E,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,eAAe,EAAE;gBACb,8BAA8B;gBAC9B,yBAAyB;gBACzB,sBAAsB;gBACtB,wCAAwC;aAC3C;YACD,GAAG,EAAE,8FAA8F;SACtG;QACD,cAAc,EAAE,IAAI;QACpB,QAAQ,EAAE;YACN,yBAAyB,EACrB,oFAAoF;YACxF,0BAA0B,EACtB,qEAAqE;SAC5E;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACrB;IACD,IAAI,EAAE,+BAA+B;CACxC,CAAC,CAAC;AAEP;;GAEG;AACH,eAAe,6BAA6B,CAAC"}

package/dist/rules/prefer-ts-extras-assert-present.d.ts

@@ -0,0 +1,13 @@
+import { createTypedRule } from "../_internal/typed-rule.js";
+/**
+ * ESLint rule definition for `prefer-ts-extras-assert-present`.
+ *
+ * @remarks
+ * Defines metadata, diagnostics, and suggestions/fixes for this rule.
+ */
+declare const preferTsExtrasAssertPresentRule: ReturnType<typeof createTypedRule>;
+/**
+ * Default export for the `prefer-ts-extras-assert-present` rule module.
+ */
+export default preferTsExtrasAssertPresentRule;
+//# sourceMappingURL=prefer-ts-extras-assert-present.d.ts.map

package/dist/rules/prefer-ts-extras-assert-present.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-ts-extras-assert-present.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-ts-extras-assert-present.ts"],"names":[],"mappings":"AAsBA,OAAO,EACH,eAAe,EAElB,MAAM,4BAA4B,CAAC;AA2KpC;;;;;GAKG;AACH,QAAA,MAAM,+BAA+B,EAAE,UAAU,CAAC,OAAO,eAAe,CAmLlE,CAAC;AAEP;;GAEG;AACH,eAAe,+BAA+B,CAAC"}