"use strict"; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); __setModuleDefault(result, mod); return result; }; Object.defineProperty(exports, "__esModule", { value: true }); const utils_1 = require("@typescript-eslint/utils"); const tsutils = __importStar(require("ts-api-utils")); const ts = __importStar(require("typescript")); const util_1 = require("../util"); exports.default = (0, util_1.createRule)({ name: 'no-unsafe-return', meta: { type: 'problem', docs: { description: 'Disallow returning a value with type `any` from a function', recommended: 'recommended', requiresTypeChecking: true, }, messages: { unsafeReturn: 'Unsafe return of an `{{type}}` typed value.', unsafeReturnThis: [ 'Unsafe return of an `{{type}}` typed value. `this` is typed as `any`.', 'You can try to fix this by turning on the `noImplicitThis` compiler option, or adding a `this` parameter to the function.', ].join('\n'), unsafeReturnAssignment: 'Unsafe return of type `{{sender}}` from function with return type `{{receiver}}`.', }, schema: [], }, defaultOptions: [], create(context) { const services = (0, util_1.getParserServices)(context); const checker = services.program.getTypeChecker(); const compilerOptions = services.program.getCompilerOptions(); const isNoImplicitThis = tsutils.isStrictCompilerOptionEnabled(compilerOptions, 'noImplicitThis'); function getParentFunctionNode(node) { let current = node.parent; while (current) { if (current.type === utils_1.AST_NODE_TYPES.ArrowFunctionExpression || current.type === utils_1.AST_NODE_TYPES.FunctionDeclaration || current.type === utils_1.AST_NODE_TYPES.FunctionExpression) { return current; } current = current.parent; } // this shouldn't happen in correct code, but someone may attempt to parse bad code // the parser won't error, so we shouldn't throw here /* istanbul ignore next */ return null; } function checkReturn(returnNode, reportingNode = returnNode) { const tsNode = services.esTreeNodeToTSNodeMap.get(returnNode); const anyType = (0, util_1.isAnyOrAnyArrayTypeDiscriminated)(tsNode, checker); const functionNode = getParentFunctionNode(returnNode); /* istanbul ignore if */ if (!functionNode) { return; } // function has an explicit return type, so ensure it's a safe return const returnNodeType = (0, util_1.getConstrainedTypeAtLocation)(services, returnNode); const functionTSNode = services.esTreeNodeToTSNodeMap.get(functionNode); // function expressions will not have their return type modified based on receiver typing // so we have to use the contextual typing in these cases, i.e. // const foo1: () => Set = () => new Set(); // the return type of the arrow function is Set even though the variable is typed as Set let functionType = ts.isFunctionExpression(functionTSNode) || ts.isArrowFunction(functionTSNode) ? (0, util_1.getContextualType)(checker, functionTSNode) : services.getTypeAtLocation(functionNode); if (!functionType) { functionType = services.getTypeAtLocation(functionNode); } // If there is an explicit type annotation *and* that type matches the actual // function return type, we shouldn't complain (it's intentional, even if unsafe) if (functionTSNode.type) { for (const signature of functionType.getCallSignatures()) { if (returnNodeType === signature.getReturnType() || (0, util_1.isTypeFlagSet)(signature.getReturnType(), ts.TypeFlags.Any | ts.TypeFlags.Unknown)) { return; } } } if (anyType !== util_1.AnyType.Safe) { // Allow cases when the declared return type of the function is either unknown or unknown[] // and the function is returning any or any[]. for (const signature of functionType.getCallSignatures()) { const functionReturnType = signature.getReturnType(); if (anyType === util_1.AnyType.Any && (0, util_1.isTypeUnknownType)(functionReturnType)) { return; } if (anyType === util_1.AnyType.AnyArray && (0, util_1.isTypeUnknownArrayType)(functionReturnType, checker)) { return; } } let messageId = 'unsafeReturn'; if (!isNoImplicitThis) { // `return this` const thisExpression = (0, util_1.getThisExpression)(returnNode); if (thisExpression && (0, util_1.isTypeAnyType)((0, util_1.getConstrainedTypeAtLocation)(services, thisExpression))) { messageId = 'unsafeReturnThis'; } } // If the function return type was not unknown/unknown[], mark usage as unsafeReturn. return context.report({ node: reportingNode, messageId, data: { type: anyType === util_1.AnyType.Any ? 'any' : 'any[]', }, }); } for (const signature of functionType.getCallSignatures()) { const functionReturnType = signature.getReturnType(); const result = (0, util_1.isUnsafeAssignment)(returnNodeType, functionReturnType, checker, returnNode); if (!result) { return; } const { sender, receiver } = result; return context.report({ node: reportingNode, messageId: 'unsafeReturnAssignment', data: { sender: checker.typeToString(sender), receiver: checker.typeToString(receiver), }, }); } } return { ReturnStatement(node) { const argument = node.argument; if (!argument) { return; } checkReturn(argument, node); }, 'ArrowFunctionExpression > :not(BlockStatement).body': checkReturn, }; }, }); //# sourceMappingURL=no-unsafe-return.js.map