eslint-plugin-sonarjs 1.0.4 → 2.0.0

package/lib/S930/rule.js

@@ -0,0 +1,178 @@
+"use strict";
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+// https://sonarsource.github.io/rspec/#/rspec/S930
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+const helpers_1 = require("../helpers");
+const meta_json_1 = __importDefault(require("./meta.json"));
+const message = 'This function expects {{expectedArguments}}, but {{providedArguments}} provided.';
+exports.rule = {
+    meta: (0, helpers_1.generateMeta)(meta_json_1.default, {
+        messages: {
+            tooManyArguments: message,
+        },
+        schema: [
+            {
+                // internal parameter
+                type: 'string',
+                enum: ['sonar-runtime'],
+            },
+        ],
+    }),
+    create(context) {
+        const callExpressionsToCheck = [];
+        const usingArguments = new Set();
+        const emptyFunctions = new Set();
+        return {
+            CallExpression(callExpr) {
+                if ((0, helpers_1.isIdentifier)(callExpr.callee)) {
+                    const reference = context.sourceCode
+                        .getScope(callExpr)
+                        .references.find(ref => ref.identifier === callExpr.callee);
+                    const definition = reference && getSingleDefinition(reference);
+                    if (definition) {
+                        if (definition.type === 'FunctionName') {
+                            checkFunction(callExpr, definition.node);
+                        }
+                        else if (definition.type === 'Variable') {
+                            const { init } = definition.node;
+                            if (init && ((0, helpers_1.isFunctionExpression)(init) || (0, helpers_1.isArrowFunctionExpression)(init))) {
+                                checkFunction(callExpr, init);
+                            }
+                        }
+                    }
+                }
+                else if ((0, helpers_1.isArrowFunctionExpression)(callExpr.callee) ||
+                    (0, helpers_1.isFunctionExpression)(callExpr.callee)) {
+                    // IIFE
+                    checkFunction(callExpr, callExpr.callee);
+                }
+            },
+            ':function'(node) {
+                const fn = node;
+                if (fn.body.type === utils_1.AST_NODE_TYPES.BlockStatement &&
+                    fn.body.body.length === 0 &&
+                    fn.params.length === 0) {
+                    emptyFunctions.add(node);
+                }
+            },
+            'FunctionDeclaration > BlockStatement Identifier'(node) {
+                checkArguments(node);
+            },
+            'FunctionExpression > BlockStatement Identifier'(node) {
+                checkArguments(node);
+            },
+            'Program:exit'() {
+                callExpressionsToCheck.forEach(({ callExpr, functionNode }) => {
+                    if (!usingArguments.has(functionNode) && !emptyFunctions.has(functionNode)) {
+                        reportIssue(callExpr, functionNode);
+                    }
+                });
+            },
+        };
+        function getSingleDefinition(reference) {
+            if (reference.resolved) {
+                const variable = reference.resolved;
+                if (variable.defs.length === 1) {
+                    return variable.defs[0];
+                }
+            }
+            return undefined;
+        }
+        function checkArguments(identifier) {
+            if (identifier.name === 'arguments') {
+                const reference = context.sourceCode
+                    .getScope(identifier)
+                    .references.find(ref => ref.identifier === identifier);
+                const definition = reference && getSingleDefinition(reference);
+                // special `arguments` variable has no definition
+                if (!definition) {
+                    const ancestors = context.sourceCode.getAncestors(identifier).reverse();
+                    const fn = ancestors.find(node => (0, helpers_1.isFunctionDeclaration)(node) ||
+                        (0, helpers_1.isFunctionExpression)(node));
+                    if (fn) {
+                        usingArguments.add(fn);
+                    }
+                }
+            }
+        }
+        function checkFunction(callExpr, functionNode) {
+            const hasRest = functionNode.params.some(param => param.type === 'RestElement');
+            if (!hasRest && callExpr.arguments.length > functionNode.params.length) {
+                callExpressionsToCheck.push({ callExpr, functionNode });
+            }
+        }
+        function reportIssue(callExpr, functionNode) {
+            const paramLength = functionNode.params.length;
+            const argsLength = callExpr.arguments.length;
+            // prettier-ignore
+            const expectedArguments = paramLength === 0 ? "no arguments" :
+                paramLength === 1 ? "1 argument" :
+                    `${paramLength} arguments`;
+            // prettier-ignore
+            const providedArguments = argsLength === 0 ? "none was" :
+                argsLength === 1 ? "1 was" :
+                    `${argsLength} were`;
+            (0, helpers_1.report)(context, {
+                message,
+                messageId: 'tooManyArguments',
+                data: {
+                    expectedArguments,
+                    providedArguments,
+                },
+                node: callExpr.callee,
+            }, getSecondaryLocations(callExpr, functionNode));
+        }
+        function getSecondaryLocations(callExpr, functionNode) {
+            const paramLength = functionNode.params.length;
+            const secondaryLocations = [];
+            if (paramLength > 0) {
+                secondaryLocations.push((0, helpers_1.toSecondaryLocation)(functionNode.params[0], functionNode.params[paramLength - 1], 'Formal parameters'));
+            }
+            else {
+                // as we're not providing parent node, `getMainFunctionTokenLocation` may return `undefined`
+                const fnToken = (0, helpers_1.getMainFunctionTokenLocation)(functionNode, undefined, context);
+                if (fnToken) {
+                    secondaryLocations.push((0, helpers_1.toSecondaryLocation)({ loc: fnToken }, 'Formal parameters'));
+                }
+            }
+            // find actual extra arguments to highlight
+            callExpr.arguments.forEach((argument, index) => {
+                if (index >= paramLength) {
+                    const { loc } = argument;
+                    secondaryLocations.push({
+                        message: 'Extra argument',
+                        column: loc.start.column,
+                        line: loc.start.line,
+                        endColumn: loc.end.column,
+                        endLine: loc.end.line,
+                    });
+                }
+            });
+            return secondaryLocations;
+        }
+    },
+};
+//# sourceMappingURL=rule.js.map

package/lib/S930/rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule.js","sourceRoot":"","sources":["../../S930/rule.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,mDAAmD;;;;;;AAEnD,oDAAoE;AAEpE,wCAWoB;AAEpB,4DAAoC;AAEpC,MAAM,OAAO,GAAG,kFAAkF,CAAC;AAEtF,QAAA,IAAI,GAAoB;IACnC,IAAI,EAAE,IAAA,sBAAY,EAAC,mBAA8B,EAAE;QACjD,QAAQ,EAAE;YACR,gBAAgB,EAAE,OAAO;SAC1B;QACD,MAAM,EAAE;YACN;gBACE,qBAAqB;gBACrB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,eAAe,CAAC;aACxB;SACF;KACF,CAAC;IACF,MAAM,CAAC,OAAO;QACZ,MAAM,sBAAsB,GAGvB,EAAE,CAAC;QACR,MAAM,cAAc,GAAqB,IAAI,GAAG,EAAE,CAAC;QACnD,MAAM,cAAc,GAAqB,IAAI,GAAG,EAAE,CAAC;QAEnD,OAAO;YACL,cAAc,CAAC,QAA+B;gBAC5C,IAAI,IAAA,sBAAY,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;oBAClC,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU;yBACjC,QAAQ,CAAC,QAAQ,CAAC;yBAClB,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC;oBAC9D,MAAM,UAAU,GAAG,SAAS,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAC;oBAC/D,IAAI,UAAU,EAAE,CAAC;wBACf,IAAI,UAAU,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;4BACvC,aAAa,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;wBAC3C,CAAC;6BAAM,IAAI,UAAU,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;4BAC1C,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,IAAmC,CAAC;4BAChE,IAAI,IAAI,IAAI,CAAC,IAAA,8BAAoB,EAAC,IAAI,CAAC,IAAI,IAAA,mCAAyB,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gCAC5E,aAAa,CAAC,QAAQ,EAAE,IAAuB,CAAC,CAAC;4BACnD,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;qBAAM,IACL,IAAA,mCAAyB,EAAC,QAAQ,CAAC,MAAuB,CAAC;oBAC3D,IAAA,8BAAoB,EAAC,QAAQ,CAAC,MAAuB,CAAC,EACtD,CAAC;oBACD,OAAO;oBACP,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAyB,CAAC,CAAC;gBAC9D,CAAC;YACH,CAAC;YAED,WAAW,CAAC,IAAiB;gBAC3B,MAAM,EAAE,GAAG,IAAmC,CAAC;gBAC/C,IACE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,cAAc;oBAC9C,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;oBACzB,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EACtB,CAAC;oBACD,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;YAED,iDAAiD,CAAC,IAAuB;gBACvE,cAAc,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YAED,gDAAgD,CAAC,IAAuB;gBACtE,cAAc,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YAED,cAAc;gBACZ,sBAAsB,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE;oBAC5D,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;wBAC3E,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;oBACtC,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;SACF,CAAC;QAEF,SAAS,mBAAmB,CAAC,SAA0B;YACrD,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;gBACvB,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;gBACpC,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC/B,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,SAAS,cAAc,CAAC,UAA6B;YACnD,IAAI,UAAU,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBACpC,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU;qBACjC,QAAQ,CAAC,UAAU,CAAC;qBACpB,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC;gBACzD,MAAM,UAAU,GAAG,SAAS,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAC;gBAC/D,iDAAiD;gBACjD,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,CAAC;oBACxE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CACvB,IAAI,CAAC,EAAE,CACL,IAAA,+BAAqB,EAAC,IAAqB,CAAC;wBAC5C,IAAA,8BAAoB,EAAC,IAAqB,CAAC,CAC9C,CAAC;oBACF,IAAI,EAAE,EAAE,CAAC;wBACP,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBACzB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,SAAS,aAAa,CAAC,QAA+B,EAAE,YAA6B;YACnF,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC;YAChF,IAAI,CAAC,OAAO,IAAI,QAAQ,CAAC,SAAS,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACvE,sBAAsB,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;QAED,SAAS,WAAW,CAAC,QAA+B,EAAE,YAA6B;YACjF,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;YAC/C,MAAM,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC;YAC7C,kBAAkB;YAClB,MAAM,iBAAiB,GACrB,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;gBACpC,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;oBAClC,GAAG,WAAW,YAAY,CAAC;YAE7B,kBAAkB;YAClB,MAAM,iBAAiB,GACrB,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;gBAC/B,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;oBAC5B,GAAG,UAAU,OAAO,CAAC;YAEvB,IAAA,gBAAM,EACJ,OAAO,EACP;gBACE,OAAO;gBACP,SAAS,EAAE,kBAAkB;gBAC7B,IAAI,EAAE;oBACJ,iBAAiB;oBACjB,iBAAiB;iBAClB;gBACD,IAAI,EAAE,QAAQ,CAAC,MAAM;aACtB,EACD,qBAAqB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAC9C,CAAC;QACJ,CAAC;QAED,SAAS,qBAAqB,CAAC,QAA+B,EAAE,YAA6B;YAC3F,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;YAC/C,MAAM,kBAAkB,GAAoB,EAAE,CAAC;YAC/C,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;gBACpB,kBAAkB,CAAC,IAAI,CACrB,IAAA,6BAAmB,EACjB,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EACtB,YAAY,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,EACpC,mBAAmB,CACpB,CACF,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,4FAA4F;gBAC5F,MAAM,OAAO,GAAG,IAAA,sCAA4B,EAC1C,YAAqC,EACrC,SAAS,EACT,OAAiC,CAClC,CAAC;gBACF,IAAI,OAAO,EAAE,CAAC;oBACZ,kBAAkB,CAAC,IAAI,CAAC,IAAA,6BAAmB,EAAC,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC;gBACtF,CAAC;YACH,CAAC;YACD,2CAA2C;YAC3C,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;gBAC7C,IAAI,KAAK,IAAI,WAAW,EAAE,CAAC;oBACzB,MAAM,EAAE,GAAG,EAAE,GAAG,QAA2C,CAAC;oBAC5D,kBAAkB,CAAC,IAAI,CAAC;wBACtB,OAAO,EAAE,gBAAgB;wBACzB,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM;wBACxB,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI;wBACpB,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM;wBACzB,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI;qBACtB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC,CAAC,CAAC;YACH,OAAO,kBAAkB,CAAC;QAC5B,CAAC;IACH,CAAC;CACF,CAAC"}

package/lib/core/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * ESLint core rules.
+ */
+export declare const eslintRules: {
+    [k: string]: import("eslint").Rule.RuleModule;
+};

package/lib/core/index.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eslintRules = void 0;
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+const eslint_1 = require("eslint");
+/**
+ * ESLint core rules.
+ */
+exports.eslintRules = Object.fromEntries(new eslint_1.Linter({ configType: 'eslintrc' }).getRules());
+//# sourceMappingURL=index.js.map

package/lib/core/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../core/index.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,mCAAgC;AAEhC;;GAEG;AACU,QAAA,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,eAAM,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC"}

package/lib/helpers/accessibility.d.ts

@@ -0,0 +1,3 @@
+import { TSESTree } from '@typescript-eslint/utils';
+import { Rule } from 'eslint';
+export declare function isPresentationTable(context: Rule.RuleContext, node: TSESTree.JSXOpeningElement): boolean;

package/lib/helpers/accessibility.js

@@ -0,0 +1,42 @@
+"use strict";
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPresentationTable = void 0;
+const jsx_ast_utils_1 = require("jsx-ast-utils");
+const getElementType_1 = __importDefault(require("eslint-plugin-jsx-a11y/lib/util/getElementType"));
+function isPresentationTable(context, node) {
+    const DISALLOWED_VALUES = ['presentation', 'none'];
+    const type = (0, getElementType_1.default)(context)(node);
+    if (type.toLowerCase() !== 'table') {
+        return false;
+    }
+    const role = (0, jsx_ast_utils_1.getProp)(node.attributes, 'role');
+    if (!role) {
+        return false;
+    }
+    const roleValue = String((0, jsx_ast_utils_1.getLiteralPropValue)(role));
+    return DISALLOWED_VALUES.includes(roleValue?.toLowerCase());
+}
+exports.isPresentationTable = isPresentationTable;
+//# sourceMappingURL=accessibility.js.map

package/lib/helpers/accessibility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessibility.js","sourceRoot":"","sources":["../../helpers/accessibility.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;;;;AAEH,iDAA6D;AAC7D,oGAA4E;AAI5E,SAAgB,mBAAmB,CAAC,OAAyB,EAAE,IAAgC;IAC7F,MAAM,iBAAiB,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACnD,MAAM,IAAI,GAAG,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IAC3C,IAAI,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE,CAAC;QACnC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,IAAI,GAAG,IAAA,uBAAO,EAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC9C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAA,mCAAmB,EAAC,IAAI,CAAC,CAAC,CAAC;IAEpD,OAAO,iBAAiB,CAAC,QAAQ,CAAC,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;AAC9D,CAAC;AAbD,kDAaC"}

package/lib/helpers/ancestor.d.ts

@@ -0,0 +1,30 @@
+import { TSESTree } from '@typescript-eslint/utils';
+import { Rule, SourceCode } from 'eslint';
+import estree, { Node } from 'estree';
+export declare function findFirstMatchingLocalAncestor(node: TSESTree.Node, predicate: (node: TSESTree.Node) => boolean): TSESTree.Node | undefined;
+export declare function findFirstMatchingAncestor(node: TSESTree.Node, predicate: (node: TSESTree.Node) => boolean): TSESTree.Node | undefined;
+export declare function localAncestorsChain(node: TSESTree.Node): TSESTree.Node[];
+export declare function ancestorsChain(node: TSESTree.Node, boundaryTypes: Set<string>): TSESTree.Node[];
+export declare function getParent(context: Rule.RuleContext, node: estree.Node): estree.Property | estree.CatchClause | estree.ClassDeclaration | estree.ClassExpression | estree.ClassBody | estree.Identifier | estree.SimpleLiteral | estree.RegExpLiteral | estree.BigIntLiteral | estree.ArrayExpression | estree.ArrowFunctionExpression | estree.AssignmentExpression | estree.AwaitExpression | estree.BinaryExpression | estree.SimpleCallExpression | estree.NewExpression | estree.ChainExpression | estree.ConditionalExpression | estree.FunctionExpression | estree.ImportExpression | estree.LogicalExpression | estree.MemberExpression | estree.MetaProperty | estree.ObjectExpression | estree.SequenceExpression | estree.TaggedTemplateExpression | estree.TemplateLiteral | estree.ThisExpression | estree.UnaryExpression | estree.UpdateExpression | estree.YieldExpression | estree.FunctionDeclaration | estree.MethodDefinition | estree.ImportDeclaration | estree.ExportNamedDeclaration | estree.ExportDefaultDeclaration | estree.ExportAllDeclaration | estree.ImportSpecifier | estree.ImportDefaultSpecifier | estree.ImportNamespaceSpecifier | estree.ExportSpecifier | estree.ObjectPattern | estree.ArrayPattern | estree.RestElement | estree.AssignmentPattern | estree.PrivateIdentifier | estree.Program | estree.PropertyDefinition | estree.SpreadElement | estree.ExpressionStatement | estree.BlockStatement | estree.StaticBlock | estree.EmptyStatement | estree.DebuggerStatement | estree.WithStatement | estree.ReturnStatement | estree.LabeledStatement | estree.BreakStatement | estree.ContinueStatement | estree.IfStatement | estree.SwitchStatement | estree.ThrowStatement | estree.TryStatement | estree.WhileStatement | estree.DoWhileStatement | estree.ForStatement | estree.ForInStatement | estree.ForOfStatement | estree.VariableDeclaration | estree.Super | estree.SwitchCase | estree.TemplateElement | estree.VariableDeclarator | undefined;
+/**
+ * Returns the parent of an ESLint node
+ *
+ * This function assumes that an ESLint node exposes a parent property,
+ * which is always defined. However, it's better to use `getParent` if
+ * it is possible to retrieve the parent based on the rule context.
+ *
+ * It should eventually disappear once we come up with a proper solution
+ * against the conflicting typings between ESLint and TypeScript ESLint
+ * when it comes to the parent of a node.
+ *
+ * @param node an ESLint node
+ * @returns the parent node
+ */
+export declare function getNodeParent(node: Node): estree.Node;
+/**
+ * Returns the direct children of a node
+ * @param node the node to get the children
+ * @param visitorKeys the visitor keys provided by the source code
+ * @returns the node children
+ */
+export declare function childrenOf(node: estree.Node, visitorKeys: SourceCode.VisitorKeys): estree.Node[];

package/lib/helpers/ancestor.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.childrenOf = exports.getNodeParent = exports.getParent = exports.ancestorsChain = exports.localAncestorsChain = exports.findFirstMatchingAncestor = exports.findFirstMatchingLocalAncestor = void 0;
+const ast_1 = require("./ast");
+function findFirstMatchingLocalAncestor(node, predicate) {
+    return localAncestorsChain(node).find(predicate);
+}
+exports.findFirstMatchingLocalAncestor = findFirstMatchingLocalAncestor;
+function findFirstMatchingAncestor(node, predicate) {
+    return ancestorsChain(node, new Set()).find(predicate);
+}
+exports.findFirstMatchingAncestor = findFirstMatchingAncestor;
+function localAncestorsChain(node) {
+    return ancestorsChain(node, ast_1.functionLike);
+}
+exports.localAncestorsChain = localAncestorsChain;
+function ancestorsChain(node, boundaryTypes) {
+    const chain = [];
+    let currentNode = node.parent;
+    while (currentNode) {
+        chain.push(currentNode);
+        if (boundaryTypes.has(currentNode.type)) {
+            break;
+        }
+        currentNode = currentNode.parent;
+    }
+    return chain;
+}
+exports.ancestorsChain = ancestorsChain;
+function getParent(context, node) {
+    const ancestors = context.sourceCode.getAncestors(node);
+    return ancestors.length > 0 ? ancestors[ancestors.length - 1] : undefined;
+}
+exports.getParent = getParent;
+/**
+ * Returns the parent of an ESLint node
+ *
+ * This function assumes that an ESLint node exposes a parent property,
+ * which is always defined. However, it's better to use `getParent` if
+ * it is possible to retrieve the parent based on the rule context.
+ *
+ * It should eventually disappear once we come up with a proper solution
+ * against the conflicting typings between ESLint and TypeScript ESLint
+ * when it comes to the parent of a node.
+ *
+ * @param node an ESLint node
+ * @returns the parent node
+ */
+function getNodeParent(node) {
+    return node.parent;
+}
+exports.getNodeParent = getNodeParent;
+/**
+ * Returns the direct children of a node
+ * @param node the node to get the children
+ * @param visitorKeys the visitor keys provided by the source code
+ * @returns the node children
+ */
+function childrenOf(node, visitorKeys) {
+    const keys = visitorKeys[node.type];
+    const children = [];
+    if (keys) {
+        for (const key of keys) {
+            /**
+             * A node's child may be a node or an array of nodes, e.g., `body` in `estree.Program`.
+             * If it's an array, we extract all the nodes from it; if not, we just add the node.
+             */
+            const child = node[key];
+            if (Array.isArray(child)) {
+                children.push(...child);
+            }
+            else {
+                children.push(child);
+            }
+        }
+    }
+    return children.filter(Boolean);
+}
+exports.childrenOf = childrenOf;
+//# sourceMappingURL=ancestor.js.map

package/lib/helpers/ancestor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ancestor.js","sourceRoot":"","sources":["../../helpers/ancestor.ts"],"names":[],"mappings":";;;AAsBA,+BAAqC;AAErC,SAAgB,8BAA8B,CAC5C,IAAmB,EACnB,SAA2C;IAE3C,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC;AALD,wEAKC;AAED,SAAgB,yBAAyB,CACvC,IAAmB,EACnB,SAA2C;IAE3C,OAAO,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACzD,CAAC;AALD,8DAKC;AAED,SAAgB,mBAAmB,CAAC,IAAmB;IACrD,OAAO,cAAc,CAAC,IAAI,EAAE,kBAAY,CAAC,CAAC;AAC5C,CAAC;AAFD,kDAEC;AAED,SAAgB,cAAc,CAAC,IAAmB,EAAE,aAA0B;IAC5E,MAAM,KAAK,GAAoB,EAAE,CAAC;IAElC,IAAI,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;IAC9B,OAAO,WAAW,EAAE,CAAC;QACnB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxB,IAAI,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,MAAM;QACR,CAAC;QACD,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC;IACnC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAZD,wCAYC;AAED,SAAgB,SAAS,CAAC,OAAyB,EAAE,IAAiB;IACpE,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACxD,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC5E,CAAC;AAHD,8BAGC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,aAAa,CAAC,IAAU;IACtC,OAAQ,IAAsB,CAAC,MAAc,CAAC;AAChD,CAAC;AAFD,sCAEC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,IAAiB,EAAE,WAAmC;IAC/E,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,IAAI,IAAI,EAAE,CAAC;QACT,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB;;;eAGG;YACH,MAAM,KAAK,GAAI,IAAY,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAlBD,gCAkBC"}

package/lib/helpers/ast.d.ts

@@ -0,0 +1,149 @@
+import { TSESTree } from '@typescript-eslint/utils';
+import { Rule, Scope } from 'eslint';
+import * as estree from 'estree';
+export type Node = estree.Node | TSESTree.Node;
+export declare function isModuleDeclaration(node: estree.Node | undefined): node is estree.ExportAllDeclaration | estree.ExportDefaultDeclaration | estree.ExportNamedDeclaration | estree.ImportDeclaration;
+export type LoopLike = estree.WhileStatement | estree.DoWhileStatement | estree.ForStatement | estree.ForOfStatement | estree.ForInStatement;
+export type FunctionNodeType = estree.FunctionDeclaration | estree.FunctionExpression | estree.ArrowFunctionExpression;
+export type StringLiteral = estree.Literal & {
+    value: string;
+};
+export declare const FUNCTION_NODES: string[];
+export declare const functionLike: Set<string>;
+export declare function isFunctionExpression(node: TSESTree.Node | undefined): node is TSESTree.FunctionExpression;
+export declare function isFunctionDeclaration(node: TSESTree.Node | undefined): node is TSESTree.FunctionDeclaration;
+export declare function isArrowFunctionExpression(node: TSESTree.Node | undefined): node is TSESTree.ArrowFunctionExpression;
+export declare function isIdentifier(node: Node | undefined, ...values: string[]): node is estree.Identifier;
+export declare function getProgramStatements(program: estree.Program): estree.Statement[];
+export declare function isIfStatement(node: Node | undefined): node is TSESTree.IfStatement;
+export declare function isMemberWithProperty(node: estree.Node, ...values: string[]): boolean;
+export declare function isThrowStatement(node: Node | undefined): node is TSESTree.ThrowStatement;
+export declare function isMemberExpression(node: estree.Node, objectValue: string, ...propertyValue: string[]): boolean;
+export declare function isLogicalExpression(node: TSESTree.Node | undefined): node is TSESTree.LogicalExpression;
+export declare function isBinaryPlus(node: estree.Node): node is estree.BinaryExpression & {
+    operator: '+';
+};
+export declare function isUnaryExpression(node: estree.Node | undefined): node is estree.UnaryExpression;
+export declare function isArrayExpression(node: estree.Node | undefined): node is estree.ArrayExpression;
+export declare function isRequireModule(node: estree.CallExpression, ...moduleNames: string[]): boolean;
+export declare function isMethodInvocation(callExpression: estree.CallExpression, objectIdentifierName: string, methodName: string, minArgs: number): boolean;
+export declare function isFunctionInvocation(callExpression: estree.CallExpression, functionName: string, minArgs: number): boolean;
+export declare function isFunctionCall(node: estree.Node): node is estree.CallExpression & {
+    callee: estree.Identifier;
+};
+export declare function isMethodCall(callExpr: estree.CallExpression): callExpr is estree.CallExpression & {
+    callee: estree.MemberExpression & {
+        property: estree.Identifier;
+    };
+};
+export declare function isVariableDeclaration(node: TSESTree.Node | undefined): node is TSESTree.VariableDeclaration;
+export declare function isCallingMethod(callExpr: estree.CallExpression, arity: number, ...methodNames: string[]): callExpr is estree.CallExpression & {
+    callee: estree.MemberExpression & {
+        property: estree.Identifier;
+    };
+};
+export declare function isNamespaceSpecifier(importDeclaration: estree.ImportDeclaration, name: string): boolean;
+export declare function isDefaultSpecifier(importDeclaration: estree.ImportDeclaration, name: string): boolean;
+export declare function isModuleExports(node: estree.Node): boolean;
+export declare function isFunctionNode(node: estree.Node): node is FunctionNodeType;
+export declare function isLiteral(n: estree.Node | null): n is estree.Literal;
+export declare function isNullLiteral(n: estree.Node): boolean;
+export declare function isFalseLiteral(n: estree.Node): boolean;
+export declare function isUndefined(node: Node): boolean;
+/**
+ * Detect expression statements like the following:
+ *  myArray[1] = 42;
+ *  myArray[1] += 42;
+ *  myObj.prop1 = 3;
+ *  myObj.prop1 += 3;
+ */
+export declare function isElementWrite(statement: estree.ExpressionStatement, ref: Scope.Reference, recursive?: boolean): boolean;
+export declare function isReferenceTo(ref: Scope.Reference, node: estree.Node): boolean;
+export declare function getUniqueWriteUsage(context: Rule.RuleContext, name: string, node: estree.Node): estree.Node | undefined;
+export declare function getUniqueWriteReference(variable: Scope.Variable | undefined): estree.Node | undefined;
+export declare function getUniqueWriteUsageOrNode(context: Rule.RuleContext, node: estree.Node, recursive?: boolean): estree.Node;
+export declare function getValueOfExpression<T extends estree.Node['type']>(context: Rule.RuleContext, expr: estree.Node | undefined | null, type: T, recursive?: boolean): Extract<estree.Node, {
+    type: T;
+}> | undefined;
+/**
+ * for `x = 42` or `let x = 42` when visiting '42' returns 'x' variable
+ */
+export declare function getLhsVariable(context: Rule.RuleContext, node: estree.Node): Scope.Variable | undefined;
+export declare function getVariableFromScope(scope: Scope.Scope | null, name: string): Scope.Variable | undefined;
+export declare function getVariableFromName(context: Rule.RuleContext, name: string, node: estree.Node): Scope.Variable | undefined;
+/**
+ * Takes array of arguments. Keeps following variable definitions
+ * and unpacking arrays as long as possible. Returns flattened
+ * array with all collected nodes.
+ *
+ * A usage example should clarify why this might be useful.
+ * According to ExpressJs `app.use` spec, the arguments can be:
+ *
+ * - A middleware function.
+ * - A series of middleware functions (separated by commas).
+ * - An array of middleware functions.
+ * - A combination of all of the above.
+ *
+ * This means that methods like `app.use` accept variable arguments,
+ * but also arrays, or combinations thereof. This methods helps
+ * to flatten out such complicated composed argument lists.
+ */
+export declare function flattenArgs(context: Rule.RuleContext, args: estree.Node[]): estree.Node[];
+export declare function resolveIdentifiers(node: TSESTree.Node, acceptShorthand?: boolean): TSESTree.Identifier[];
+export declare function getPropertyWithValue(context: Rule.RuleContext, objectExpression: estree.ObjectExpression, propertyName: string, propertyValue: estree.Literal['value']): estree.Property | undefined;
+/**
+ * Retrieves the property with the specified key from the given node.
+ * @returns The property if found, or null if not found, or undefined if property not found and one of the properties
+ * is an unresolved SpreadElement.
+ */
+export declare function getProperty(expr: estree.Node | undefined | null, key: string, ctx: Rule.RuleContext): estree.Property | null | undefined;
+export declare function resolveFromFunctionReference(context: Rule.RuleContext, functionIdentifier: estree.Identifier): estree.FunctionExpression | estree.FunctionDeclaration | null;
+export declare function resolveFunction(context: Rule.RuleContext, node: estree.Node): estree.Function | null;
+export declare function checkSensitiveCall(context: Rule.RuleContext, callExpression: estree.CallExpression, sensitiveArgumentIndex: number, sensitiveProperty: string, sensitivePropertyValue: boolean, message: string): void;
+export declare function isStringLiteral(node: estree.Node): node is StringLiteral;
+export declare function isBooleanLiteral(node: estree.Node): node is estree.Literal & {
+    value: boolean;
+};
+export declare function isNumberLiteral(node: estree.Node): node is estree.Literal & {
+    value: number;
+};
+export declare function isRegexLiteral(node: estree.Node): node is estree.RegExpLiteral;
+/**
+ * Checks if the node is of the form: foo.bar
+ *
+ * @param node
+ * @returns
+ */
+export declare function isDotNotation(node: estree.Node): node is estree.MemberExpression & {
+    property: estree.Identifier;
+};
+/**
+ * Checks if the node is of the form: foo["bar"]
+ *
+ * @param node
+ * @returns
+ */
+export declare function isIndexNotation(node: estree.Node): node is estree.MemberExpression & {
+    property: StringLiteral;
+};
+export declare function isObjectDestructuring(node: estree.Node): node is (estree.VariableDeclarator & {
+    id: estree.ObjectPattern;
+}) | (estree.AssignmentExpression & {
+    left: estree.ObjectPattern;
+});
+export declare function isStaticTemplateLiteral(node: estree.Node): node is estree.TemplateLiteral;
+export declare function isSimpleRawString(node: estree.Node): node is estree.TaggedTemplateExpression;
+export declare function getSimpleRawStringValue(node: estree.TaggedTemplateExpression): string;
+export declare function isThisExpression(node: estree.Node): node is estree.ThisExpression;
+export declare function isProperty(node: estree.Node): node is estree.Property;
+/**
+ * Check if an identifier has no known value, meaning:
+ *
+ * - It's not imported/required
+ * - Defined variable without any write references (function parameter?)
+ * - Non-defined variable (a possible global?)
+ *
+ * @param node Node to check
+ * @param ctx Rule context
+ */
+export declare function isUnresolved(node: estree.Node | undefined | null, ctx: Rule.RuleContext): boolean;