github-pages-deploy-action/node_modules/eslint/lib/rules/no-inner-declarations.js

89 lines
2.4 KiB
JavaScript
Raw Permalink Normal View History

2020-03-07 11:45:40 +08:00
/**
* @fileoverview Rule to enforce declarations in program or function body root.
* @author Brandon Mills
*/
"use strict";
2020-05-15 05:33:08 +08:00
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const astUtils = require("./utils/ast-utils");
2020-03-07 11:45:40 +08:00
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
2020-05-15 05:33:08 +08:00
const validParent = new Set(["Program", "ExportNamedDeclaration", "ExportDefaultDeclaration"]);
const validBlockStatementParent = new Set(["FunctionDeclaration", "FunctionExpression", "ArrowFunctionExpression"]);
2020-03-07 11:45:40 +08:00
module.exports = {
meta: {
type: "problem",
docs: {
description: "disallow variable or `function` declarations in nested blocks",
category: "Possible Errors",
recommended: true,
url: "https://eslint.org/docs/rules/no-inner-declarations"
},
schema: [
{
enum: ["functions", "both"]
}
2020-05-15 05:33:08 +08:00
],
messages: {
moveDeclToRoot: "Move {{type}} declaration to {{body}} root."
}
2020-03-07 11:45:40 +08:00
},
create(context) {
/**
* Ensure that a given node is at a program or function body's root.
* @param {ASTNode} node Declaration node to check.
* @returns {void}
*/
function check(node) {
2020-05-15 05:33:08 +08:00
const parent = node.parent;
if (
parent.type === "BlockStatement" && validBlockStatementParent.has(parent.parent.type)
) {
return;
2020-03-07 11:45:40 +08:00
}
2020-05-15 05:33:08 +08:00
if (validParent.has(parent.type)) {
return;
}
const upperFunction = astUtils.getUpperFunction(parent);
context.report({
node,
messageId: "moveDeclToRoot",
data: {
type: (node.type === "FunctionDeclaration" ? "function" : "variable"),
body: (upperFunction === null ? "program" : "function body")
}
});
2020-03-07 11:45:40 +08:00
}
2020-05-15 05:33:08 +08:00
2020-03-07 11:45:40 +08:00
return {
FunctionDeclaration: check,
VariableDeclaration(node) {
if (context.options[0] === "both" && node.kind === "var") {
check(node);
}
}
};
}
};