| "use strict"; |
| var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { |
| if (k2 === undefined) k2 = k; |
| Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); |
| }) : (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 util = __importStar(require("../util")); |
| exports.default = util.createRule({ |
| name: 'no-invalid-void-type', |
| meta: { |
| type: 'problem', |
| docs: { |
| description: 'Disallows usage of `void` type outside of generic or return types', |
| recommended: false, |
| }, |
| messages: { |
| invalidVoidForGeneric: '{{ generic }} may not have void as a type variable.', |
| invalidVoidNotReturnOrGeneric: 'void is only valid as a return type or generic type variable.', |
| invalidVoidNotReturn: 'void is only valid as a return type.', |
| invalidVoidNotReturnOrThisParam: 'void is only valid as return type or type of `this` parameter.', |
| invalidVoidNotReturnOrThisParamOrGeneric: 'void is only valid as a return type or generic type variable or the type of a `this` parameter.', |
| }, |
| schema: [ |
| { |
| type: 'object', |
| properties: { |
| allowInGenericTypeArguments: { |
| oneOf: [ |
| { type: 'boolean' }, |
| { |
| type: 'array', |
| items: { type: 'string' }, |
| minLength: 1, |
| }, |
| ], |
| }, |
| allowAsThisParameter: { |
| type: 'boolean', |
| }, |
| }, |
| additionalProperties: false, |
| }, |
| ], |
| }, |
| defaultOptions: [ |
| { allowInGenericTypeArguments: true, allowAsThisParameter: false }, |
| ], |
| create(context, [{ allowInGenericTypeArguments, allowAsThisParameter }]) { |
| const validParents = [ |
| utils_1.AST_NODE_TYPES.TSTypeAnnotation, // |
| ]; |
| const invalidGrandParents = [ |
| utils_1.AST_NODE_TYPES.TSPropertySignature, |
| utils_1.AST_NODE_TYPES.CallExpression, |
| utils_1.AST_NODE_TYPES.PropertyDefinition, |
| utils_1.AST_NODE_TYPES.Identifier, |
| ]; |
| const validUnionMembers = [ |
| utils_1.AST_NODE_TYPES.TSVoidKeyword, |
| utils_1.AST_NODE_TYPES.TSNeverKeyword, |
| ]; |
| if (allowInGenericTypeArguments === true) { |
| validParents.push(utils_1.AST_NODE_TYPES.TSTypeParameterInstantiation); |
| } |
| /** |
| * @brief check if the given void keyword is used as a valid generic type |
| * |
| * reports if the type parametrized by void is not in the whitelist, or |
| * allowInGenericTypeArguments is false. |
| * no-op if the given void keyword is not used as generic type |
| */ |
| function checkGenericTypeArgument(node) { |
| var _a, _b; |
| // only matches T<..., void, ...> |
| // extra check for precaution |
| /* istanbul ignore next */ |
| if (((_a = node.parent) === null || _a === void 0 ? void 0 : _a.type) !== utils_1.AST_NODE_TYPES.TSTypeParameterInstantiation || |
| ((_b = node.parent.parent) === null || _b === void 0 ? void 0 : _b.type) !== utils_1.AST_NODE_TYPES.TSTypeReference) { |
| return; |
| } |
| // check whitelist |
| if (Array.isArray(allowInGenericTypeArguments)) { |
| const sourceCode = context.getSourceCode(); |
| const fullyQualifiedName = sourceCode |
| .getText(node.parent.parent.typeName) |
| .replace(/ /gu, ''); |
| if (!allowInGenericTypeArguments |
| .map(s => s.replace(/ /gu, '')) |
| .includes(fullyQualifiedName)) { |
| context.report({ |
| messageId: 'invalidVoidForGeneric', |
| data: { generic: fullyQualifiedName }, |
| node, |
| }); |
| } |
| return; |
| } |
| if (!allowInGenericTypeArguments) { |
| context.report({ |
| messageId: allowAsThisParameter |
| ? 'invalidVoidNotReturnOrThisParam' |
| : 'invalidVoidNotReturn', |
| node, |
| }); |
| } |
| } |
| /** |
| * @brief checks that a union containing void is valid |
| * @return true if every member of the union is specified as a valid type in |
| * validUnionMembers, or is a valid generic type parametrized by void |
| */ |
| function isValidUnionType(node) { |
| return node.types.every(member => { |
| var _a, _b; |
| return validUnionMembers.includes(member.type) || |
| // allows any T<..., void, ...> here, checked by checkGenericTypeArgument |
| (member.type === utils_1.AST_NODE_TYPES.TSTypeReference && |
| ((_a = member.typeParameters) === null || _a === void 0 ? void 0 : _a.type) === |
| utils_1.AST_NODE_TYPES.TSTypeParameterInstantiation && |
| ((_b = member.typeParameters) === null || _b === void 0 ? void 0 : _b.params.map(param => param.type).includes(utils_1.AST_NODE_TYPES.TSVoidKeyword))); |
| }); |
| } |
| return { |
| TSVoidKeyword(node) { |
| var _a; |
| /* istanbul ignore next */ |
| if (!((_a = node.parent) === null || _a === void 0 ? void 0 : _a.parent)) { |
| return; |
| } |
| // checks T<..., void, ...> against specification of allowInGenericArguments option |
| if (node.parent.type === utils_1.AST_NODE_TYPES.TSTypeParameterInstantiation && |
| node.parent.parent.type === utils_1.AST_NODE_TYPES.TSTypeReference) { |
| checkGenericTypeArgument(node); |
| return; |
| } |
| // union w/ void must contain types from validUnionMembers, or a valid generic void type |
| if (node.parent.type === utils_1.AST_NODE_TYPES.TSUnionType && |
| isValidUnionType(node.parent)) { |
| return; |
| } |
| // this parameter is ok to be void. |
| if (allowAsThisParameter && |
| node.parent.type === utils_1.AST_NODE_TYPES.TSTypeAnnotation && |
| node.parent.parent.type === utils_1.AST_NODE_TYPES.Identifier && |
| node.parent.parent.name === 'this') { |
| return; |
| } |
| // default cases |
| if (validParents.includes(node.parent.type) && |
| !invalidGrandParents.includes(node.parent.parent.type)) { |
| return; |
| } |
| context.report({ |
| messageId: allowInGenericTypeArguments && allowAsThisParameter |
| ? 'invalidVoidNotReturnOrThisParamOrGeneric' |
| : allowInGenericTypeArguments |
| ? 'invalidVoidNotReturnOrGeneric' |
| : allowAsThisParameter |
| ? 'invalidVoidNotReturnOrThisParam' |
| : 'invalidVoidNotReturn', |
| node, |
| }); |
| }, |
| }; |
| }, |
| }); |
| //# sourceMappingURL=no-invalid-void-type.js.map |
