88 lines
2.2 KiB
Plaintext
88 lines
2.2 KiB
Plaintext
/**
|
|
* @fileoverview Rule to flag when return statement contains assignment
|
|
* @author Ilya Volodin
|
|
*/
|
|
"use strict";
|
|
|
|
//------------------------------------------------------------------------------
|
|
// Requirements
|
|
//------------------------------------------------------------------------------
|
|
|
|
const astUtils = require("./utils/ast-utils");
|
|
|
|
//------------------------------------------------------------------------------
|
|
// Helpers
|
|
//------------------------------------------------------------------------------
|
|
|
|
const SENTINEL_TYPE =
|
|
/^(?:[a-zA-Z]+?Statement|ArrowFunctionExpression|FunctionExpression|ClassExpression)$/u;
|
|
|
|
//------------------------------------------------------------------------------
|
|
// Rule Definition
|
|
//------------------------------------------------------------------------------
|
|
|
|
/** @type {import('../shared/types').Rule} */
|
|
module.exports = {
|
|
meta: {
|
|
type: "suggestion",
|
|
|
|
defaultOptions: ["except-parens"],
|
|
|
|
docs: {
|
|
description: "Disallow assignment operators in `return` statements",
|
|
recommended: false,
|
|
url: "https://eslint.org/docs/latest/rules/no-return-assign",
|
|
},
|
|
|
|
schema: [
|
|
{
|
|
enum: ["except-parens", "always"],
|
|
},
|
|
],
|
|
|
|
messages: {
|
|
returnAssignment: "Return statement should not contain assignment.",
|
|
arrowAssignment: "Arrow function should not return assignment.",
|
|
},
|
|
},
|
|
|
|
create(context) {
|
|
const always = context.options[0] !== "except-parens";
|
|
const sourceCode = context.sourceCode;
|
|
|
|
return {
|
|
AssignmentExpression(node) {
|
|
if (!always && astUtils.isParenthesised(sourceCode, node)) {
|
|
return;
|
|
}
|
|
|
|
let currentChild = node;
|
|
let parent = currentChild.parent;
|
|
|
|
// Find ReturnStatement or ArrowFunctionExpression in ancestors.
|
|
while (parent && !SENTINEL_TYPE.test(parent.type)) {
|
|
currentChild = parent;
|
|
parent = parent.parent;
|
|
}
|
|
|
|
// Reports.
|
|
if (parent && parent.type === "ReturnStatement") {
|
|
context.report({
|
|
node: parent,
|
|
messageId: "returnAssignment",
|
|
});
|
|
} else if (
|
|
parent &&
|
|
parent.type === "ArrowFunctionExpression" &&
|
|
parent.body === currentChild
|
|
) {
|
|
context.report({
|
|
node: parent,
|
|
messageId: "arrowAssignment",
|
|
});
|
|
}
|
|
},
|
|
};
|
|
},
|
|
};
|