eslint-plugin-sonarjs 1.0.4 → 2.0.0

package/lib/src/rules/cognitive-complexity.js

@@ -1,273 +0,0 @@
-"use strict";
-/*
- * eslint-plugin-sonarjs
- * Copyright (C) 2018-2021 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/S3776
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const nodes_1 = require("../utils/nodes");
-const locations_1 = require("../utils/locations");
-const docs_url_1 = __importDefault(require("../utils/docs-url"));
-const jsx_1 = require("../utils/jsx");
-const DEFAULT_THRESHOLD = 15;
-const message = 'Refactor this function to reduce its Cognitive Complexity from {{complexityAmount}} to the {{threshold}} allowed.';
-const rule = {
-    defaultOptions: [],
-    meta: {
-        messages: {
-            refactorFunction: message,
-            sonarRuntime: '{{sonarRuntimeData}}',
-            fileComplexity: '{{complexityAmount}}',
-        },
-        type: 'suggestion',
-        docs: {
-            description: 'Cognitive Complexity of functions should not be too high',
-            url: (0, docs_url_1.default)(__filename),
-        },
-        schema: [
-            { type: 'integer', minimum: 0 },
-            {
-                // internal parameter
-                type: 'string',
-                enum: ['sonar-runtime', 'metric'],
-            },
-        ],
-    },
-    create(context) {
-        const { options } = context;
-        /** Complexity threshold */
-        const threshold = typeof options[0] === 'number' ? options[0] : DEFAULT_THRESHOLD;
-        /** Indicator if the file complexity should be reported */
-        const isFileComplexity = context.options.includes('metric');
-        /** Set of already considered (with already computed complexity) logical expressions */
-        const consideredLogicalExpressions = new Set();
-        /** Stack of scopes that are either functions or the program */
-        const scopes = [];
-        return {
-            ':function': (node) => {
-                onEnterFunction(node);
-            },
-            ':function:exit'(node) {
-                onLeaveFunction(node);
-            },
-            '*'(node) {
-                if (scopes[scopes.length - 1]?.nestingNodes.has(node)) {
-                    scopes[scopes.length - 1].nestingLevel++;
-                }
-            },
-            '*:exit'(node) {
-                if (scopes[scopes.length - 1]?.nestingNodes.has(node)) {
-                    scopes[scopes.length - 1].nestingLevel--;
-                    scopes[scopes.length - 1].nestingNodes.delete(node);
-                }
-            },
-            Program(node) {
-                scopes.push({
-                    node,
-                    nestingLevel: 0,
-                    nestingNodes: new Set(),
-                    complexityPoints: [],
-                });
-            },
-            'Program:exit'(node) {
-                const programComplexity = scopes.pop();
-                if (isFileComplexity) {
-                    // value from the message will be saved in SonarQube as file complexity metric
-                    context.report({
-                        node,
-                        messageId: 'fileComplexity',
-                        data: {
-                            complexityAmount: programComplexity.complexityPoints.reduce((acc, cur) => acc + cur.complexity, 0),
-                        },
-                    });
-                }
-            },
-            IfStatement(node) {
-                visitIfStatement(node);
-            },
-            ForStatement(node) {
-                visitLoop(node);
-            },
-            ForInStatement(node) {
-                visitLoop(node);
-            },
-            ForOfStatement(node) {
-                visitLoop(node);
-            },
-            DoWhileStatement(node) {
-                visitLoop(node);
-            },
-            WhileStatement(node) {
-                visitLoop(node);
-            },
-            SwitchStatement(node) {
-                visitSwitchStatement(node);
-            },
-            ContinueStatement(node) {
-                visitContinueOrBreakStatement(node);
-            },
-            BreakStatement(node) {
-                visitContinueOrBreakStatement(node);
-            },
-            CatchClause(node) {
-                visitCatchClause(node);
-            },
-            LogicalExpression(node) {
-                visitLogicalExpression(node);
-            },
-            ConditionalExpression(node) {
-                visitConditionalExpression(node);
-            },
-        };
-        function onEnterFunction(node) {
-            scopes.push({ node, nestingLevel: 0, nestingNodes: new Set(), complexityPoints: [] });
-        }
-        function onLeaveFunction(node) {
-            const functionComplexity = scopes.pop();
-            checkFunction(functionComplexity.complexityPoints, (0, locations_1.getMainFunctionTokenLocation)(node, node.parent, context));
-        }
-        function visitIfStatement(ifStatement) {
-            const { parent } = ifStatement;
-            const { loc: ifLoc } = (0, locations_1.getFirstToken)(ifStatement, context);
-            // if the current `if` statement is `else if`, do not count it in structural complexity
-            if ((0, nodes_1.isIfStatement)(parent) && parent.alternate === ifStatement) {
-                addComplexity(ifLoc);
-            }
-            else {
-                addStructuralComplexity(ifLoc);
-            }
-            // always increase nesting level inside `then` statement
-            scopes[scopes.length - 1].nestingNodes.add(ifStatement.consequent);
-            // if `else` branch is not `else if` then
-            // - increase nesting level inside `else` statement
-            // - add +1 complexity
-            if (ifStatement.alternate && !(0, nodes_1.isIfStatement)(ifStatement.alternate)) {
-                scopes[scopes.length - 1].nestingNodes.add(ifStatement.alternate);
-                const elseTokenLoc = (0, locations_1.getFirstTokenAfter)(ifStatement.consequent, context).loc;
-                addComplexity(elseTokenLoc);
-            }
-        }
-        function visitLoop(loop) {
-            addStructuralComplexity((0, locations_1.getFirstToken)(loop, context).loc);
-            scopes[scopes.length - 1].nestingNodes.add(loop.body);
-        }
-        function visitSwitchStatement(switchStatement) {
-            addStructuralComplexity((0, locations_1.getFirstToken)(switchStatement, context).loc);
-            for (const switchCase of switchStatement.cases) {
-                scopes[scopes.length - 1].nestingNodes.add(switchCase);
-            }
-        }
-        function visitContinueOrBreakStatement(statement) {
-            if (statement.label) {
-                addComplexity((0, locations_1.getFirstToken)(statement, context).loc);
-            }
-        }
-        function visitCatchClause(catchClause) {
-            addStructuralComplexity((0, locations_1.getFirstToken)(catchClause, context).loc);
-            scopes[scopes.length - 1].nestingNodes.add(catchClause.body);
-        }
-        function visitConditionalExpression(conditionalExpression) {
-            const questionTokenLoc = (0, locations_1.getFirstTokenAfter)(conditionalExpression.test, context).loc;
-            addStructuralComplexity(questionTokenLoc);
-            scopes[scopes.length - 1].nestingNodes.add(conditionalExpression.consequent);
-            scopes[scopes.length - 1].nestingNodes.add(conditionalExpression.alternate);
-        }
-        function visitLogicalExpression(logicalExpression) {
-            const jsxShortCircuitNodes = (0, jsx_1.getJsxShortCircuitNodes)(logicalExpression);
-            if (jsxShortCircuitNodes != null) {
-                jsxShortCircuitNodes.forEach(node => consideredLogicalExpressions.add(node));
-                return;
-            }
-            if (isDefaultValuePattern(logicalExpression)) {
-                return;
-            }
-            if (!consideredLogicalExpressions.has(logicalExpression)) {
-                const flattenedLogicalExpressions = flattenLogicalExpression(logicalExpression);
-                let previous;
-                for (const current of flattenedLogicalExpressions) {
-                    if (!previous || previous.operator !== current.operator) {
-                        const operatorTokenLoc = (0, locations_1.getFirstTokenAfter)(current.left, context).loc;
-                        addComplexity(operatorTokenLoc);
-                    }
-                    previous = current;
-                }
-            }
-        }
-        function isDefaultValuePattern(node) {
-            const { left, right, operator, parent } = node;
-            const operators = ['||', '??'];
-            const literals = ['Literal', 'ArrayExpression', 'ObjectExpression'];
-            switch (parent?.type) {
-                /* Matches: const x = a || literal */
-                case 'VariableDeclarator':
-                    return operators.includes(operator) && literals.includes(right.type);
-                /* Matches: a = a || literal */
-                case 'AssignmentExpression':
-                    return (operators.includes(operator) &&
-                        literals.includes(right.type) &&
-                        context.sourceCode.getText(parent.left) === context.sourceCode.getText(left));
-                default:
-                    return false;
-            }
-        }
-        function flattenLogicalExpression(node) {
-            if ((0, nodes_1.isLogicalExpression)(node)) {
-                consideredLogicalExpressions.add(node);
-                return [
-                    ...flattenLogicalExpression(node.left),
-                    node,
-                    ...flattenLogicalExpression(node.right),
-                ];
-            }
-            return [];
-        }
-        function addStructuralComplexity(location) {
-            const added = scopes[scopes.length - 1].nestingLevel + 1;
-            const complexityPoint = { complexity: added, location };
-            scopes[scopes.length - 1].complexityPoints.push(complexityPoint);
-        }
-        function addComplexity(location) {
-            const complexityPoint = { complexity: 1, location };
-            scopes[scopes.length - 1].complexityPoints.push(complexityPoint);
-        }
-        function checkFunction(complexity = [], loc) {
-            if (isFileComplexity) {
-                return;
-            }
-            const complexityAmount = complexity.reduce((acc, cur) => acc + cur.complexity, 0);
-            if (complexityAmount > threshold) {
-                const secondaryLocations = complexity.map(complexityPoint => {
-                    const { complexity, location } = complexityPoint;
-                    const message = complexity === 1 ? '+1' : `+${complexity} (incl. ${complexity - 1} for nesting)`;
-                    return (0, locations_1.issueLocation)(location, undefined, message);
-                });
-                (0, locations_1.report)(context, {
-                    messageId: 'refactorFunction',
-                    data: {
-                        complexityAmount,
-                        threshold,
-                    },
-                    loc,
-                }, secondaryLocations, message, complexityAmount - threshold);
-            }
-        }
-    },
-};
-module.exports = rule;

package/lib/src/rules/elseif-without-else.d.ts

@@ -1,3 +0,0 @@
-import type { TSESLint } from '@typescript-eslint/utils';
-declare const rule: TSESLint.RuleModule<string, string[]>;
-export = rule;

package/lib/src/rules/elseif-without-else.js

@@ -1,63 +0,0 @@
-"use strict";
-/*
- * eslint-plugin-sonarjs
- * Copyright (C) 2018-2021 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/S126
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const docs_url_1 = __importDefault(require("../utils/docs-url"));
-const rule = {
-    defaultOptions: [],
-    meta: {
-        messages: {
-            addMissingElseClause: 'Add the missing "else" clause.',
-        },
-        schema: [],
-        type: 'suggestion',
-        docs: {
-            description: '"if ... else if" constructs should end with "else" clauses',
-            url: (0, docs_url_1.default)(__filename),
-        },
-    },
-    create(context) {
-        return {
-            IfStatement: (node) => {
-                const ifstmt = node;
-                if (isElseIf(ifstmt) && !ifstmt.alternate) {
-                    const { sourceCode } = context;
-                    const elseKeyword = sourceCode.getTokenBefore(node, token => token.type === 'Keyword' && token.value === 'else');
-                    const ifKeyword = sourceCode.getFirstToken(node, token => token.type === 'Keyword' && token.value === 'if');
-                    context.report({
-                        messageId: 'addMissingElseClause',
-                        loc: {
-                            start: elseKeyword.loc.start,
-                            end: ifKeyword.loc.end,
-                        },
-                    });
-                }
-            },
-        };
-    },
-};
-function isElseIf(node) {
-    const { parent } = node;
-    return parent?.type === 'IfStatement' && parent.alternate === node;
-}
-module.exports = rule;

package/lib/src/rules/max-switch-cases.d.ts

@@ -1,4 +0,0 @@
-import type { TSESLint } from '@typescript-eslint/utils';
-type Options = [number];
-declare const rule: TSESLint.RuleModule<string, Options>;
-export = rule;

package/lib/src/rules/max-switch-cases.js

@@ -1,73 +0,0 @@
-"use strict";
-/*
- * eslint-plugin-sonarjs
- * Copyright (C) 2018-2021 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/S1479
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const docs_url_1 = __importDefault(require("../utils/docs-url"));
-const DEFAULT_MAX_SWITCH_CASES = 30;
-let maxSwitchCases = DEFAULT_MAX_SWITCH_CASES;
-const rule = {
-    defaultOptions: [DEFAULT_MAX_SWITCH_CASES],
-    meta: {
-        messages: {
-            reduceNumberOfNonEmptySwitchCases: 'Reduce the number of non-empty switch cases from {{numSwitchCases}} to at most {{maxSwitchCases}}.',
-        },
-        type: 'suggestion',
-        docs: {
-            description: '"switch" statements should not have too many "case" clauses',
-            recommended: 'recommended',
-            url: (0, docs_url_1.default)(__filename),
-        },
-        schema: [
-            {
-                type: 'integer',
-                minimum: 0,
-            },
-        ],
-    },
-    create(context) {
-        if (context.options.length > 0) {
-            maxSwitchCases = context.options[0];
-        }
-        return {
-            SwitchStatement: (node) => visitSwitchStatement(node, context),
-        };
-    },
-};
-function visitSwitchStatement(switchStatement, context) {
-    const nonEmptyCases = switchStatement.cases.filter(switchCase => switchCase.consequent.length > 0 && !isDefaultCase(switchCase));
-    if (nonEmptyCases.length > maxSwitchCases) {
-        const switchKeyword = context.sourceCode.getFirstToken(switchStatement);
-        context.report({
-            messageId: 'reduceNumberOfNonEmptySwitchCases',
-            loc: switchKeyword.loc,
-            data: {
-                numSwitchCases: nonEmptyCases.length.toString(),
-                maxSwitchCases: maxSwitchCases.toString(),
-            },
-        });
-    }
-}
-function isDefaultCase(switchCase) {
-    return switchCase.test === null;
-}
-module.exports = rule;

package/lib/src/rules/no-all-duplicated-branches.d.ts

@@ -1,3 +0,0 @@
-import type { TSESLint } from '@typescript-eslint/utils';
-declare const rule: TSESLint.RuleModule<string, string[]>;
-export = rule;

package/lib/src/rules/no-all-duplicated-branches.js

@@ -1,79 +0,0 @@
-"use strict";
-/*
- * eslint-plugin-sonarjs
- * Copyright (C) 2018-2021 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/S3923
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const nodes_1 = require("../utils/nodes");
-const equivalence_1 = require("../utils/equivalence");
-const conditions_1 = require("../utils/conditions");
-const docs_url_1 = __importDefault(require("../utils/docs-url"));
-const rule = {
-    defaultOptions: [],
-    meta: {
-        messages: {
-            removeOrEditConditionalStructure: "Remove this conditional structure or edit its code blocks so that they're not all the same.",
-            returnsTheSameValue: 'This conditional operation returns the same value whether the condition is "true" or "false".',
-        },
-        schema: [],
-        type: 'problem',
-        docs: {
-            description: 'All branches in a conditional structure should not have exactly the same implementation',
-            recommended: 'recommended',
-            url: (0, docs_url_1.default)(__filename),
-        },
-    },
-    create(context) {
-        return {
-            IfStatement(node) {
-                const ifStmt = node;
-                // don't visit `else if` statements
-                if (!(0, nodes_1.isIfStatement)(node.parent)) {
-                    const { branches, endsWithElse } = (0, conditions_1.collectIfBranches)(ifStmt);
-                    if (endsWithElse && allDuplicated(branches)) {
-                        context.report({ messageId: 'removeOrEditConditionalStructure', node: ifStmt });
-                    }
-                }
-            },
-            SwitchStatement(node) {
-                const switchStmt = node;
-                const { branches, endsWithDefault } = (0, conditions_1.collectSwitchBranches)(switchStmt);
-                if (endsWithDefault && allDuplicated(branches)) {
-                    context.report({ messageId: 'removeOrEditConditionalStructure', node: switchStmt });
-                }
-            },
-            ConditionalExpression(node) {
-                const conditional = node;
-                const branches = [conditional.consequent, conditional.alternate];
-                if (allDuplicated(branches)) {
-                    context.report({ messageId: 'returnsTheSameValue', node: conditional });
-                }
-            },
-        };
-        function allDuplicated(branches) {
-            return (branches.length > 1 &&
-                branches.slice(1).every((branch, index) => {
-                    return (0, equivalence_1.areEquivalent)(branch, branches[index], context.sourceCode);
-                }));
-        }
-    },
-};
-module.exports = rule;

package/lib/src/rules/no-collapsible-if.d.ts

@@ -1,3 +0,0 @@
-import type { TSESLint } from '@typescript-eslint/utils';
-declare const rule: TSESLint.RuleModule<string, string[]>;
-export = rule;

package/lib/src/rules/no-collapsible-if.js

@@ -1,74 +0,0 @@
-"use strict";
-/*
- * eslint-plugin-sonarjs
- * Copyright (C) 2018-2021 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/S1066
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const nodes_1 = require("../utils/nodes");
-const locations_1 = require("../utils/locations");
-const docs_url_1 = __importDefault(require("../utils/docs-url"));
-const message = 'Merge this if statement with the nested one.';
-const rule = {
-    defaultOptions: [],
-    meta: {
-        messages: {
-            mergeNestedIfStatement: message,
-            sonarRuntime: '{{sonarRuntimeData}}',
-        },
-        type: 'suggestion',
-        docs: {
-            description: 'Collapsible "if" statements should be merged',
-            recommended: 'recommended',
-            url: (0, docs_url_1.default)(__filename),
-        },
-        schema: [
-            {
-                // internal parameter
-                type: 'string',
-                enum: ['sonar-runtime'],
-            },
-        ],
-    },
-    create(context) {
-        return {
-            IfStatement(node) {
-                let { consequent } = node;
-                if ((0, nodes_1.isBlockStatement)(consequent) && consequent.body.length === 1) {
-                    consequent = consequent.body[0];
-                }
-                if (isIfStatementWithoutElse(node) && isIfStatementWithoutElse(consequent)) {
-                    const ifKeyword = context.sourceCode.getFirstToken(consequent);
-                    const enclosingIfKeyword = context.sourceCode.getFirstToken(node);
-                    if (ifKeyword && enclosingIfKeyword) {
-                        (0, locations_1.report)(context, {
-                            messageId: 'mergeNestedIfStatement',
-                            loc: enclosingIfKeyword.loc,
-                        }, [(0, locations_1.issueLocation)(ifKeyword.loc, ifKeyword.loc, 'Nested "if" statement.')], message);
-                    }
-                }
-            },
-        };
-        function isIfStatementWithoutElse(node) {
-            return (0, nodes_1.isIfStatement)(node) && !node.alternate;
-        }
-    },
-};
-module.exports = rule;

package/lib/src/rules/no-collection-size-mischeck.d.ts

@@ -1,3 +0,0 @@
-import type { TSESLint } from '@typescript-eslint/utils';
-declare const rule: TSESLint.RuleModule<string, string[]>;
-export = rule;