minor adjustment to readme
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / eslint / lib / rules / prefer-spread.js
1 /**
2  * @fileoverview A rule to suggest using of the spread operator instead of `.apply()`.
3  * @author Toru Nagashima
4  */
5
6 "use strict";
7
8 const astUtils = require("./utils/ast-utils");
9
10 //------------------------------------------------------------------------------
11 // Helpers
12 //------------------------------------------------------------------------------
13
14 /**
15  * Checks whether or not a node is a `.apply()` for variadic.
16  * @param {ASTNode} node A CallExpression node to check.
17  * @returns {boolean} Whether or not the node is a `.apply()` for variadic.
18  */
19 function isVariadicApplyCalling(node) {
20     return (
21         node.callee.type === "MemberExpression" &&
22         node.callee.property.type === "Identifier" &&
23         node.callee.property.name === "apply" &&
24         node.callee.computed === false &&
25         node.arguments.length === 2 &&
26         node.arguments[1].type !== "ArrayExpression" &&
27         node.arguments[1].type !== "SpreadElement"
28     );
29 }
30
31
32 /**
33  * Checks whether or not `thisArg` is not changed by `.apply()`.
34  * @param {ASTNode|null} expectedThis The node that is the owner of the applied function.
35  * @param {ASTNode} thisArg The node that is given to the first argument of the `.apply()`.
36  * @param {RuleContext} context The ESLint rule context object.
37  * @returns {boolean} Whether or not `thisArg` is not changed by `.apply()`.
38  */
39 function isValidThisArg(expectedThis, thisArg, context) {
40     if (!expectedThis) {
41         return astUtils.isNullOrUndefined(thisArg);
42     }
43     return astUtils.equalTokens(expectedThis, thisArg, context);
44 }
45
46 //------------------------------------------------------------------------------
47 // Rule Definition
48 //------------------------------------------------------------------------------
49
50 module.exports = {
51     meta: {
52         type: "suggestion",
53
54         docs: {
55             description: "require spread operators instead of `.apply()`",
56             category: "ECMAScript 6",
57             recommended: false,
58             url: "https://eslint.org/docs/rules/prefer-spread"
59         },
60
61         schema: [],
62         fixable: null
63     },
64
65     create(context) {
66         const sourceCode = context.getSourceCode();
67
68         return {
69             CallExpression(node) {
70                 if (!isVariadicApplyCalling(node)) {
71                     return;
72                 }
73
74                 const applied = node.callee.object;
75                 const expectedThis = (applied.type === "MemberExpression") ? applied.object : null;
76                 const thisArg = node.arguments[0];
77
78                 if (isValidThisArg(expectedThis, thisArg, sourceCode)) {
79                     context.report({
80                         node,
81                         message: "Use the spread operator instead of '.apply()'."
82                     });
83                 }
84             }
85         };
86     }
87 };