eslint-plugin-sonarjs 1.0.4 → 2.0.0

package/lib/src/rules/no-identical-conditions.js

@@ -1,131 +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/S1862
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const equivalence_1 = require("../utils/equivalence");
-const locations_1 = require("../utils/locations");
-const docs_url_1 = __importDefault(require("../utils/docs-url"));
-const duplicatedConditionMessage = 'This condition is covered by the one on line {{line}}';
-const duplicatedCaseMessage = 'This case duplicates the one on line {{line}}';
-const rule = {
-    defaultOptions: [],
-    meta: {
-        messages: {
-            duplicatedCondition: duplicatedConditionMessage,
-            duplicatedCase: duplicatedCaseMessage,
-            sonarRuntime: '{{sonarRuntimeData}}',
-        },
-        type: 'problem',
-        docs: {
-            description: 'Related "if-else-if" and "switch-case" statements should not have the same condition',
-            recommended: 'recommended',
-            url: (0, docs_url_1.default)(__filename),
-        },
-        schema: [
-            {
-                // internal parameter
-                type: 'string',
-                enum: ['sonar-runtime'],
-            },
-        ],
-    },
-    create(context) {
-        const { sourceCode } = context;
-        return {
-            IfStatement(node) {
-                const { test } = node;
-                const conditionsToCheck = test.type === 'LogicalExpression' && test.operator === '&&'
-                    ? [test, ...splitByAnd(test)]
-                    : [test];
-                let current = node;
-                let operandsToCheck = conditionsToCheck.map(c => splitByOr(c).map(splitByAnd));
-                while (current.parent?.type === 'IfStatement' && current.parent.alternate === current) {
-                    current = current.parent;
-                    const currentOrOperands = splitByOr(current.test).map(splitByAnd);
-                    operandsToCheck = operandsToCheck.map(orOperands => orOperands.filter(orOperand => !currentOrOperands.some(currentOrOperand => isSubset(currentOrOperand, orOperand, sourceCode))));
-                    if (operandsToCheck.some(orOperands => orOperands.length === 0)) {
-                        (0, locations_1.report)(context, {
-                            messageId: 'duplicatedCondition',
-                            data: { line: current.test.loc.start.line },
-                            node: test,
-                        }, [(0, locations_1.issueLocation)(current.test.loc, current.test.loc, 'Covering')], duplicatedConditionMessage);
-                        break;
-                    }
-                }
-            },
-            SwitchStatement(node) {
-                const switchStmt = node;
-                const previousTests = [];
-                for (const switchCase of switchStmt.cases) {
-                    if (switchCase.test) {
-                        const { test } = switchCase;
-                        const duplicateTest = previousTests.find(previousTest => (0, equivalence_1.areEquivalent)(test, previousTest, sourceCode));
-                        if (duplicateTest) {
-                            (0, locations_1.report)(context, {
-                                messageId: 'duplicatedCase',
-                                data: {
-                                    line: duplicateTest.loc.start.line,
-                                },
-                                node: test,
-                            }, [(0, locations_1.issueLocation)(duplicateTest.loc, duplicateTest.loc, 'Original')], duplicatedCaseMessage);
-                        }
-                        else {
-                            previousTests.push(test);
-                        }
-                    }
-                }
-            },
-        };
-    },
-};
-const splitByOr = splitByLogicalOperator.bind(null, '||');
-const splitByAnd = splitByLogicalOperator.bind(null, '&&');
-function splitByLogicalOperator(operator, node) {
-    if (node.type === 'LogicalExpression' && node.operator === operator) {
-        return [
-            ...splitByLogicalOperator(operator, node.left),
-            ...splitByLogicalOperator(operator, node.right),
-        ];
-    }
-    return [node];
-}
-function isSubset(first, second, sourceCode) {
-    return first.every(fst => second.some(snd => isSubsetOf(fst, snd, sourceCode)));
-    function isSubsetOf(first, second, sourceCode) {
-        if (first.type !== second.type) {
-            return false;
-        }
-        if (first.type === 'LogicalExpression') {
-            const second1 = second;
-            if ((first.operator === '||' || first.operator === '&&') &&
-                first.operator === second1.operator) {
-                return ((isSubsetOf(first.left, second1.left, sourceCode) &&
-                    isSubsetOf(first.right, second1.right, sourceCode)) ||
-                    (isSubsetOf(first.left, second1.right, sourceCode) &&
-                        isSubsetOf(first.right, second1.left, sourceCode)));
-            }
-        }
-        return (0, equivalence_1.areEquivalent)(first, second, sourceCode);
-    }
-}
-module.exports = rule;

package/lib/src/rules/no-identical-expressions.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-identical-expressions.js

@@ -1,108 +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/S1764
-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 locations_1 = require("../utils/locations");
-const docs_url_1 = __importDefault(require("../utils/docs-url"));
-const EQUALITY_OPERATOR_TOKEN_KINDS = new Set(['==', '===', '!=', '!==']);
-// consider only binary expressions with these operators
-const RELEVANT_OPERATOR_TOKEN_KINDS = new Set([
-    '&&',
-    '||',
-    '/',
-    '-',
-    '<<',
-    '>>',
-    '<',
-    '<=',
-    '>',
-    '>=',
-]);
-function hasRelevantOperator(node) {
-    return (RELEVANT_OPERATOR_TOKEN_KINDS.has(node.operator) ||
-        (EQUALITY_OPERATOR_TOKEN_KINDS.has(node.operator) && !hasIdentifierOperands(node)));
-}
-function hasIdentifierOperands(node) {
-    return (0, nodes_1.isIdentifier)(node.left) && (0, nodes_1.isIdentifier)(node.right);
-}
-function isOneOntoOneShifting(node) {
-    return (node.operator === '<<' &&
-        (0, nodes_1.isLiteral)(node.left) &&
-        (node.left.value === 1 || node.left.value === 1n));
-}
-const message = 'Correct one of the identical sub-expressions on both sides of operator "{{operator}}"';
-const rule = {
-    defaultOptions: [],
-    meta: {
-        messages: {
-            correctIdenticalSubExpressions: message,
-            sonarRuntime: '{{sonarRuntimeData}}',
-        },
-        type: 'problem',
-        docs: {
-            description: 'Identical expressions should not be used on both sides of a binary operator',
-            recommended: 'recommended',
-            url: (0, docs_url_1.default)(__filename),
-        },
-        schema: [
-            {
-                // internal parameter
-                type: 'string',
-                enum: ['sonar-runtime'],
-            },
-        ],
-    },
-    create(context) {
-        return {
-            LogicalExpression(node) {
-                check(node);
-            },
-            BinaryExpression(node) {
-                check(node);
-            },
-        };
-        function check(expr) {
-            if (hasRelevantOperator(expr) &&
-                !isOneOntoOneShifting(expr) &&
-                (0, equivalence_1.areEquivalent)(expr.left, expr.right, context.sourceCode)) {
-                const secondaryLocations = [];
-                if (expr.left.loc) {
-                    secondaryLocations.push((0, locations_1.issueLocation)(expr.left.loc));
-                }
-                (0, locations_1.report)(context, {
-                    messageId: 'correctIdenticalSubExpressions',
-                    data: {
-                        operator: expr.operator,
-                    },
-                    node: isSonarRuntime() ? expr.right : expr,
-                }, secondaryLocations, message);
-            }
-        }
-        function isSonarRuntime() {
-            return context.options[context.options.length - 1] === 'sonar-runtime';
-        }
-    },
-};
-module.exports = rule;

package/lib/src/rules/no-identical-functions.d.ts

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

package/lib/src/rules/no-identical-functions.js

@@ -1,114 +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/S4144
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const equivalence_1 = require("../utils/equivalence");
-const locations_1 = require("../utils/locations");
-const docs_url_1 = __importDefault(require("../utils/docs-url"));
-const DEFAULT_MIN_LINES = 3;
-const message = 'Update this function so that its implementation is not identical to the one on line {{line}}.';
-const rule = {
-    defaultOptions: [DEFAULT_MIN_LINES],
-    meta: {
-        messages: {
-            identicalFunctions: message,
-            sonarRuntime: '{{sonarRuntimeData}}',
-        },
-        type: 'problem',
-        docs: {
-            description: 'Functions should not have identical implementations',
-            recommended: 'recommended',
-            url: (0, docs_url_1.default)(__filename),
-        },
-        schema: [
-            { type: 'integer', minimum: 3 },
-            {
-                type: 'string',
-                enum: ['sonar-runtime'],
-            },
-        ],
-    },
-    create(context) {
-        const functions = [];
-        const minLines = typeof context.options[0] === 'number' ? context.options[0] : DEFAULT_MIN_LINES;
-        return {
-            FunctionDeclaration(node) {
-                visitFunction(node);
-            },
-            'VariableDeclarator > FunctionExpression, MethodDefinition > FunctionExpression': (node) => {
-                visitFunction(node);
-            },
-            'VariableDeclarator > ArrowFunctionExpression, MethodDefinition > ArrowFunctionExpression': (node) => {
-                visitFunction(node);
-            },
-            'Program:exit'() {
-                processFunctions();
-            },
-        };
-        function visitFunction(node) {
-            if (isBigEnough(node.body)) {
-                functions.push({ function: node, parent: node.parent });
-            }
-        }
-        function processFunctions() {
-            for (let i = 1; i < functions.length; i++) {
-                const duplicatingFunction = functions[i].function;
-                for (let j = 0; j < i; j++) {
-                    const originalFunction = functions[j].function;
-                    if ((0, equivalence_1.areEquivalent)(duplicatingFunction.body, originalFunction.body, context.sourceCode) &&
-                        originalFunction.loc) {
-                        const loc = (0, locations_1.getMainFunctionTokenLocation)(duplicatingFunction, functions[i].parent, context);
-                        const originalFunctionLoc = (0, locations_1.getMainFunctionTokenLocation)(originalFunction, functions[j].parent, context);
-                        const secondaryLocations = [
-                            (0, locations_1.issueLocation)(originalFunctionLoc, originalFunctionLoc, 'Original implementation'),
-                        ];
-                        (0, locations_1.report)(context, {
-                            messageId: 'identicalFunctions',
-                            data: {
-                                line: originalFunction.loc.start.line,
-                            },
-                            loc,
-                        }, secondaryLocations, message);
-                        break;
-                    }
-                }
-            }
-        }
-        function isBigEnough(node) {
-            const tokens = context.sourceCode.getTokens(node);
-            if (tokens.length > 0 && tokens[0].value === '{') {
-                tokens.shift();
-            }
-            if (tokens.length > 0 && tokens[tokens.length - 1].value === '}') {
-                tokens.pop();
-            }
-            if (tokens.length > 0) {
-                const firstLine = tokens[0].loc.start.line;
-                const lastLine = tokens[tokens.length - 1].loc.end.line;
-                return lastLine - firstLine + 1 >= minLines;
-            }
-            return false;
-        }
-    },
-};
-module.exports = rule;

package/lib/src/rules/no-ignored-return.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-ignored-return.js

@@ -1,269 +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/S2201
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const parser_services_1 = require("../utils/parser-services");
-const docs_url_1 = __importDefault(require("../utils/docs-url"));
-const utils_1 = require("../utils");
-const METHODS_WITHOUT_SIDE_EFFECTS = {
-    array: new Set([
-        'concat',
-        'includes',
-        'join',
-        'slice',
-        'indexOf',
-        'lastIndexOf',
-        'entries',
-        'filter',
-        'findIndex',
-        'keys',
-        'map',
-        'values',
-        'find',
-        'reduce',
-        'reduceRight',
-        'toString',
-        'toLocaleString',
-    ]),
-    date: new Set([
-        'getDate',
-        'getDay',
-        'getFullYear',
-        'getHours',
-        'getMilliseconds',
-        'getMinutes',
-        'getMonth',
-        'getSeconds',
-        'getTime',
-        'getTimezoneOffset',
-        'getUTCDate',
-        'getUTCDay',
-        'getUTCFullYear',
-        'getUTCHours',
-        'getUTCMilliseconds',
-        'getUTCMinutes',
-        'getUTCMonth',
-        'getUTCSeconds',
-        'getYear',
-        'toDateString',
-        'toISOString',
-        'toJSON',
-        'toGMTString',
-        'toLocaleDateString',
-        'toLocaleTimeString',
-        'toTimeString',
-        'toUTCString',
-        'toString',
-        'toLocaleString',
-    ]),
-    math: new Set([
-        'abs',
-        'E',
-        'LN2',
-        'LN10',
-        'LOG2E',
-        'LOG10E',
-        'PI',
-        'SQRT1_2',
-        'SQRT2',
-        'abs',
-        'acos',
-        'acosh',
-        'asin',
-        'asinh',
-        'atan',
-        'atanh',
-        'atan2',
-        'cbrt',
-        'ceil',
-        'clz32',
-        'cos',
-        'cosh',
-        'exp',
-        'expm1',
-        'floor',
-        'fround',
-        'hypot',
-        'imul',
-        'log',
-        'log1p',
-        'log10',
-        'log2',
-        'max',
-        'min',
-        'pow',
-        'random',
-        'round',
-        'sign',
-        'sin',
-        'sinh',
-        'sqrt',
-        'tan',
-        'tanh',
-        'trunc',
-    ]),
-    number: new Set(['toExponential', 'toFixed', 'toPrecision', 'toLocaleString', 'toString']),
-    regexp: new Set(['test', 'toString']),
-    string: new Set([
-        'charAt',
-        'charCodeAt',
-        'codePointAt',
-        'concat',
-        'includes',
-        'endsWith',
-        'indexOf',
-        'lastIndexOf',
-        'localeCompare',
-        'match',
-        'normalize',
-        'padEnd',
-        'padStart',
-        'repeat',
-        'replace',
-        'search',
-        'slice',
-        'split',
-        'startsWith',
-        'substr',
-        'substring',
-        'toLocaleLowerCase',
-        'toLocaleUpperCase',
-        'toLowerCase',
-        'toUpperCase',
-        'trim',
-        'length',
-        'toString',
-        'valueOf',
-        // HTML wrapper methods
-        'anchor',
-        'big',
-        'blink',
-        'bold',
-        'fixed',
-        'fontcolor',
-        'fontsize',
-        'italics',
-        'link',
-        'small',
-        'strike',
-        'sub',
-        'sup',
-    ]),
-};
-const rule = {
-    defaultOptions: [],
-    meta: {
-        messages: {
-            useForEach: `Consider using "forEach" instead of "map" as its return value is not being used here.`,
-            returnValueMustBeUsed: 'The return value of "{{methodName}}" must be used.',
-        },
-        schema: [],
-        type: 'problem',
-        docs: {
-            description: 'Return values from functions without side effects should not be ignored',
-            recommended: 'recommended',
-            url: (0, docs_url_1.default)(__filename),
-        },
-    },
-    create(context) {
-        const services = context.sourceCode.parserServices;
-        if (!(0, parser_services_1.isParserServicesWithTypeInformation)(services)) {
-            return {};
-        }
-        return {
-            CallExpression: (node) => {
-                const call = node;
-                const { callee } = call;
-                if (callee.type === 'MemberExpression') {
-                    const { parent } = node;
-                    if (parent && parent.type === 'ExpressionStatement') {
-                        const methodName = context.sourceCode.getText(callee.property);
-                        const objectType = services.program
-                            .getTypeChecker()
-                            .getTypeAtLocation(services.esTreeNodeToTSNodeMap.get(callee.object));
-                        if (!hasSideEffect(methodName, objectType, services) &&
-                            !isReplaceWithCallback(methodName, call.arguments, services)) {
-                            context.report(reportDescriptor(methodName, node));
-                        }
-                    }
-                }
-            },
-        };
-    },
-};
-function isReplaceWithCallback(methodName, callArguments, services) {
-    if (methodName === 'replace' && callArguments.length > 1) {
-        const type = (0, utils_1.getTypeFromTreeNode)(callArguments[1], services);
-        const typeNode = services.program.getTypeChecker().typeToTypeNode(type, undefined, undefined);
-        // dynamically import 'typescript' as classic 'import' will fail if project not using 'typescript' parser
-        // we are sure it's available as 'RequiredParserServices' are available here
-        // eslint-disable-next-line import/no-extraneous-dependencies
-        const ts = require('typescript');
-        return typeNode && ts.isFunctionTypeNode(typeNode);
-    }
-    return false;
-}
-function reportDescriptor(methodName, node) {
-    if (methodName === 'map') {
-        return {
-            messageId: 'useForEach',
-            node,
-        };
-    }
-    else {
-        return {
-            messageId: 'returnValueMustBeUsed',
-            node,
-            data: { methodName },
-        };
-    }
-}
-function hasSideEffect(methodName, objectType, services) {
-    const typeAsString = typeToString(objectType, services);
-    if (typeAsString !== null) {
-        const methods = METHODS_WITHOUT_SIDE_EFFECTS[typeAsString];
-        return !(methods && methods.has(methodName));
-    }
-    return true;
-}
-function typeToString(tp, services) {
-    const typechecker = services.program.getTypeChecker();
-    const baseType = typechecker.getBaseTypeOfLiteralType(tp);
-    const typeAsString = typechecker.typeToString(baseType);
-    if (typeAsString === 'number' || typeAsString === 'string') {
-        return typeAsString;
-    }
-    const symbol = tp.getSymbol();
-    if (symbol) {
-        const name = symbol.getName();
-        switch (name) {
-            case 'Array':
-            case 'Date':
-            case 'Math':
-            case 'RegExp':
-                return name.toLowerCase();
-        }
-    }
-    return null;
-}
-module.exports = rule;

package/lib/src/rules/no-inverted-boolean-check.d.ts

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