1 | "use strict";
|
2 | var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
3 | if (k2 === undefined) k2 = k;
|
4 | Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
|
5 | }) : (function(o, m, k, k2) {
|
6 | if (k2 === undefined) k2 = k;
|
7 | o[k2] = m[k];
|
8 | }));
|
9 | var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
10 | Object.defineProperty(o, "default", { enumerable: true, value: v });
|
11 | }) : function(o, v) {
|
12 | o["default"] = v;
|
13 | });
|
14 | var __importStar = (this && this.__importStar) || function (mod) {
|
15 | if (mod && mod.__esModule) return mod;
|
16 | var result = {};
|
17 | if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
18 | __setModuleDefault(result, mod);
|
19 | return result;
|
20 | };
|
21 | Object.defineProperty(exports, "__esModule", { value: true });
|
22 | const utils_1 = require("@typescript-eslint/utils");
|
23 | const tsutils = __importStar(require("tsutils"));
|
24 | const util = __importStar(require("../util"));
|
25 | const ts = __importStar(require("typescript"));
|
26 | exports.default = util.createRule({
|
27 | name: 'no-meaningless-void-operator',
|
28 | meta: {
|
29 | type: 'suggestion',
|
30 | docs: {
|
31 | description: 'Disallow the `void` operator except when used to discard a value',
|
32 | recommended: false,
|
33 | suggestion: true,
|
34 | requiresTypeChecking: true,
|
35 | },
|
36 | fixable: 'code',
|
37 | hasSuggestions: true,
|
38 | messages: {
|
39 | meaninglessVoidOperator: "void operator shouldn't be used on {{type}}; it should convey that a return value is being ignored",
|
40 | removeVoid: "Remove 'void'",
|
41 | },
|
42 | schema: [
|
43 | {
|
44 | type: 'object',
|
45 | properties: {
|
46 | checkNever: {
|
47 | type: 'boolean',
|
48 | default: false,
|
49 | },
|
50 | },
|
51 | additionalProperties: false,
|
52 | },
|
53 | ],
|
54 | },
|
55 | defaultOptions: [{ checkNever: false }],
|
56 | create(context, [{ checkNever }]) {
|
57 | const parserServices = utils_1.ESLintUtils.getParserServices(context);
|
58 | const checker = parserServices.program.getTypeChecker();
|
59 | const sourceCode = context.getSourceCode();
|
60 | return {
|
61 | 'UnaryExpression[operator="void"]'(node) {
|
62 | const fix = (fixer) => {
|
63 | return fixer.removeRange([
|
64 | sourceCode.getTokens(node)[0].range[0],
|
65 | sourceCode.getTokens(node)[1].range[0],
|
66 | ]);
|
67 | };
|
68 | const argTsNode = parserServices.esTreeNodeToTSNodeMap.get(node.argument);
|
69 | const argType = checker.getTypeAtLocation(argTsNode);
|
70 | const unionParts = tsutils.unionTypeParts(argType);
|
71 | if (unionParts.every(part => part.flags & (ts.TypeFlags.Void | ts.TypeFlags.Undefined))) {
|
72 | context.report({
|
73 | node,
|
74 | messageId: 'meaninglessVoidOperator',
|
75 | data: { type: checker.typeToString(argType) },
|
76 | fix,
|
77 | });
|
78 | }
|
79 | else if (checkNever &&
|
80 | unionParts.every(part => part.flags &
|
81 | (ts.TypeFlags.Void | ts.TypeFlags.Undefined | ts.TypeFlags.Never))) {
|
82 | context.report({
|
83 | node,
|
84 | messageId: 'meaninglessVoidOperator',
|
85 | data: { type: checker.typeToString(argType) },
|
86 | suggest: [{ messageId: 'removeVoid', fix }],
|
87 | });
|
88 | }
|
89 | },
|
90 | };
|
91 | },
|
92 | });
|
93 |
|
\ | No newline at end of file |