Permalink
Cannot retrieve contributors at this time
117 lines (98 sloc)
3.48 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/eslint/lib/rules/max-nested-callbacks.js
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* @fileoverview Rule to enforce a maximum number of nested callbacks. | |
* @author Ian Christian Myers | |
*/ | |
"use strict"; | |
//------------------------------------------------------------------------------ | |
// Rule Definition | |
//------------------------------------------------------------------------------ | |
/** @type {import('../shared/types').Rule} */ | |
module.exports = { | |
meta: { | |
type: "suggestion", | |
docs: { | |
description: "Enforce a maximum depth that callbacks can be nested", | |
recommended: false, | |
url: "https://eslint.org/docs/latest/rules/max-nested-callbacks" | |
}, | |
schema: [ | |
{ | |
oneOf: [ | |
{ | |
type: "integer", | |
minimum: 0 | |
}, | |
{ | |
type: "object", | |
properties: { | |
maximum: { | |
type: "integer", | |
minimum: 0 | |
}, | |
max: { | |
type: "integer", | |
minimum: 0 | |
} | |
}, | |
additionalProperties: false | |
} | |
] | |
} | |
], | |
messages: { | |
exceed: "Too many nested callbacks ({{num}}). Maximum allowed is {{max}}." | |
} | |
}, | |
create(context) { | |
//-------------------------------------------------------------------------- | |
// Constants | |
//-------------------------------------------------------------------------- | |
const option = context.options[0]; | |
let THRESHOLD = 10; | |
if ( | |
typeof option === "object" && | |
(Object.prototype.hasOwnProperty.call(option, "maximum") || Object.prototype.hasOwnProperty.call(option, "max")) | |
) { | |
THRESHOLD = option.maximum || option.max; | |
} else if (typeof option === "number") { | |
THRESHOLD = option; | |
} | |
//-------------------------------------------------------------------------- | |
// Helpers | |
//-------------------------------------------------------------------------- | |
const callbackStack = []; | |
/** | |
* Checks a given function node for too many callbacks. | |
* @param {ASTNode} node The node to check. | |
* @returns {void} | |
* @private | |
*/ | |
function checkFunction(node) { | |
const parent = node.parent; | |
if (parent.type === "CallExpression") { | |
callbackStack.push(node); | |
} | |
if (callbackStack.length > THRESHOLD) { | |
const opts = { num: callbackStack.length, max: THRESHOLD }; | |
context.report({ node, messageId: "exceed", data: opts }); | |
} | |
} | |
/** | |
* Pops the call stack. | |
* @returns {void} | |
* @private | |
*/ | |
function popStack() { | |
callbackStack.pop(); | |
} | |
//-------------------------------------------------------------------------- | |
// Public API | |
//-------------------------------------------------------------------------- | |
return { | |
ArrowFunctionExpression: checkFunction, | |
"ArrowFunctionExpression:exit": popStack, | |
FunctionExpression: checkFunction, | |
"FunctionExpression:exit": popStack | |
}; | |
} | |
}; |