"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 () { var ownKeys = function(o) { ownKeys = Object.getOwnPropertyNames || function (o) { var ar = []; for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k; return ar; }; return ownKeys(o); }; return function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); __setModuleDefault(result, mod); return result; }; })(); Object.defineProperty(exports, "__esModule", { value: true }); const utils_1 = require("@typescript-eslint/utils"); const ts_api_utils_1 = require("ts-api-utils"); const ts = __importStar(require("typescript")); const util_1 = require("../util"); exports.default = (0, util_1.createRule)({ name: 'prefer-return-this-type', meta: { type: 'suggestion', docs: { description: 'Enforce that `this` is used when only `this` type is returned', recommended: 'strict', requiresTypeChecking: true, }, fixable: 'code', messages: { useThisType: 'Use `this` type instead.', }, schema: [], }, defaultOptions: [], create(context) { const services = (0, util_1.getParserServices)(context); const checker = services.program.getTypeChecker(); function tryGetNameInType(name, typeNode) { if (typeNode.type === utils_1.AST_NODE_TYPES.TSTypeReference && typeNode.typeName.type === utils_1.AST_NODE_TYPES.Identifier && typeNode.typeName.name === name) { return typeNode; } if (typeNode.type === utils_1.AST_NODE_TYPES.TSUnionType) { for (const type of typeNode.types) { const found = tryGetNameInType(name, type); if (found) { return found; } } } return undefined; } function isThisSpecifiedInParameters(originalFunc) { const firstArg = originalFunc.params.at(0); return (firstArg?.type === utils_1.AST_NODE_TYPES.Identifier && firstArg.name === 'this'); } function isFunctionReturningThis(originalFunc, originalClass) { if (isThisSpecifiedInParameters(originalFunc)) { return false; } const func = services.esTreeNodeToTSNodeMap.get(originalFunc); if (!func.body) { return false; } const classType = services.getTypeAtLocation(originalClass); if (func.body.kind !== ts.SyntaxKind.Block) { const type = checker.getTypeAtLocation(func.body); return classType.thisType === type; } let hasReturnThis = false; let hasReturnClassType = false; (0, util_1.forEachReturnStatement)(func.body, stmt => { const expr = stmt.expression; if (!expr) { return; } // fast check if (expr.kind === ts.SyntaxKind.ThisKeyword) { hasReturnThis = true; return; } const type = checker.getTypeAtLocation(expr); if (classType === type) { hasReturnClassType = true; return true; } if (classType.thisType === type) { hasReturnThis = true; return; } if ((0, ts_api_utils_1.isUnionType)(type) && type.types.some(typePart => typePart === classType)) { hasReturnClassType = true; return true; } return; }); return !hasReturnClassType && hasReturnThis; } function checkFunction(originalFunc, originalClass) { const className = originalClass.id?.name; if (!className || !originalFunc.returnType) { return; } const node = tryGetNameInType(className, originalFunc.returnType.typeAnnotation); if (!node) { return; } if (isFunctionReturningThis(originalFunc, originalClass)) { context.report({ node, messageId: 'useThisType', fix: fixer => fixer.replaceText(node, 'this'), }); } } function checkProperty(node) { if (!(node.value?.type === utils_1.AST_NODE_TYPES.FunctionExpression || node.value?.type === utils_1.AST_NODE_TYPES.ArrowFunctionExpression)) { return; } checkFunction(node.value, node.parent.parent); } return { 'ClassBody > AccessorProperty': checkProperty, 'ClassBody > MethodDefinition'(node) { checkFunction(node.value, node.parent.parent); }, 'ClassBody > PropertyDefinition': checkProperty, }; }, });