solium-plugin-security/rules/one-break-per-loop.js

Official Solium Plugin for Security-related lint rules

/**
 * @fileoverview Flags any loops which contain two or more break statements
 * @author Artem Litchmanov <artem.litchmanov@gmail.com>
 */

"use strict";

module.exports = {

    meta: {

        docs: {
            recommended: false,
            type: "off",
            description: "Discourage use of multiple break statements in a loop"
        },

        schema: []

    },

    create: function(context) {

        // loop stack will keep track of break counts inside each loop
        let loopStack = [];
        function inspectBreakStatement(emitted) {
            if (!emitted.exit) {
                loopStack[loopStack.length-1] += 1;
            }
        }

        //While exiting for loop Node, Report if the current top of stack is more than 1
        function inspectLoopStatement(emitted) {
            let node = emitted.node;
            if (emitted.exit) {
                let breakCount = loopStack.pop();
                if (breakCount > 1) {
                    context.report({
                        node: node,
                        message: "Avoid using multiple break statements in a loop."
                    });
                }
            } else {
                // push new counter onto stack when entering loop
                loopStack.push(0);
            }
        }

        return {
            ForStatement: inspectLoopStatement,
            WhileStatement: inspectLoopStatement,
            DoWhileStatement: inspectLoopStatement,
            BreakStatement: inspectBreakStatement
        };
    }
};