eslint-plugin-sonarjs/lib/src/rules/max-switch-cases.js

SonarJS rules for ESLint

"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;