You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
174 lines
5.8 KiB
174 lines
5.8 KiB
/**
|
|
* @fileoverview A rule to disallow or enforce spaces inside of single line blocks.
|
|
* @author Toru Nagashima
|
|
* @deprecated in ESLint v8.53.0
|
|
*/
|
|
|
|
"use strict";
|
|
|
|
const util = require("./utils/ast-utils");
|
|
|
|
//------------------------------------------------------------------------------
|
|
// Rule Definition
|
|
//------------------------------------------------------------------------------
|
|
|
|
/** @type {import('../shared/types').Rule} */
|
|
module.exports = {
|
|
meta: {
|
|
deprecated: true,
|
|
replacedBy: [],
|
|
type: "layout",
|
|
|
|
docs: {
|
|
description: "Disallow or enforce spaces inside of blocks after opening block and before closing block",
|
|
recommended: false,
|
|
url: "https://eslint.org/docs/latest/rules/block-spacing"
|
|
},
|
|
|
|
fixable: "whitespace",
|
|
|
|
schema: [
|
|
{ enum: ["always", "never"] }
|
|
],
|
|
|
|
messages: {
|
|
missing: "Requires a space {{location}} '{{token}}'.",
|
|
extra: "Unexpected space(s) {{location}} '{{token}}'."
|
|
}
|
|
},
|
|
|
|
create(context) {
|
|
const always = (context.options[0] !== "never"),
|
|
messageId = always ? "missing" : "extra",
|
|
sourceCode = context.sourceCode;
|
|
|
|
/**
|
|
* Gets the open brace token from a given node.
|
|
* @param {ASTNode} node A BlockStatement/StaticBlock/SwitchStatement node to get.
|
|
* @returns {Token} The token of the open brace.
|
|
*/
|
|
function getOpenBrace(node) {
|
|
if (node.type === "SwitchStatement") {
|
|
if (node.cases.length > 0) {
|
|
return sourceCode.getTokenBefore(node.cases[0]);
|
|
}
|
|
return sourceCode.getLastToken(node, 1);
|
|
}
|
|
|
|
if (node.type === "StaticBlock") {
|
|
return sourceCode.getFirstToken(node, { skip: 1 }); // skip the `static` token
|
|
}
|
|
|
|
// "BlockStatement"
|
|
return sourceCode.getFirstToken(node);
|
|
}
|
|
|
|
/**
|
|
* Checks whether or not:
|
|
* - given tokens are on same line.
|
|
* - there is/isn't a space between given tokens.
|
|
* @param {Token} left A token to check.
|
|
* @param {Token} right The token which is next to `left`.
|
|
* @returns {boolean}
|
|
* When the option is `"always"`, `true` if there are one or more spaces between given tokens.
|
|
* When the option is `"never"`, `true` if there are not any spaces between given tokens.
|
|
* If given tokens are not on same line, it's always `true`.
|
|
*/
|
|
function isValid(left, right) {
|
|
return (
|
|
!util.isTokenOnSameLine(left, right) ||
|
|
sourceCode.isSpaceBetweenTokens(left, right) === always
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Checks and reports invalid spacing style inside braces.
|
|
* @param {ASTNode} node A BlockStatement/StaticBlock/SwitchStatement node to check.
|
|
* @returns {void}
|
|
*/
|
|
function checkSpacingInsideBraces(node) {
|
|
|
|
// Gets braces and the first/last token of content.
|
|
const openBrace = getOpenBrace(node);
|
|
const closeBrace = sourceCode.getLastToken(node);
|
|
const firstToken = sourceCode.getTokenAfter(openBrace, { includeComments: true });
|
|
const lastToken = sourceCode.getTokenBefore(closeBrace, { includeComments: true });
|
|
|
|
// Skip if the node is invalid or empty.
|
|
if (openBrace.type !== "Punctuator" ||
|
|
openBrace.value !== "{" ||
|
|
closeBrace.type !== "Punctuator" ||
|
|
closeBrace.value !== "}" ||
|
|
firstToken === closeBrace
|
|
) {
|
|
return;
|
|
}
|
|
|
|
// Skip line comments for option never
|
|
if (!always && firstToken.type === "Line") {
|
|
return;
|
|
}
|
|
|
|
// Check.
|
|
if (!isValid(openBrace, firstToken)) {
|
|
let loc = openBrace.loc;
|
|
|
|
if (messageId === "extra") {
|
|
loc = {
|
|
start: openBrace.loc.end,
|
|
end: firstToken.loc.start
|
|
};
|
|
}
|
|
|
|
context.report({
|
|
node,
|
|
loc,
|
|
messageId,
|
|
data: {
|
|
location: "after",
|
|
token: openBrace.value
|
|
},
|
|
fix(fixer) {
|
|
if (always) {
|
|
return fixer.insertTextBefore(firstToken, " ");
|
|
}
|
|
|
|
return fixer.removeRange([openBrace.range[1], firstToken.range[0]]);
|
|
}
|
|
});
|
|
}
|
|
if (!isValid(lastToken, closeBrace)) {
|
|
let loc = closeBrace.loc;
|
|
|
|
if (messageId === "extra") {
|
|
loc = {
|
|
start: lastToken.loc.end,
|
|
end: closeBrace.loc.start
|
|
};
|
|
}
|
|
context.report({
|
|
node,
|
|
loc,
|
|
messageId,
|
|
data: {
|
|
location: "before",
|
|
token: closeBrace.value
|
|
},
|
|
fix(fixer) {
|
|
if (always) {
|
|
return fixer.insertTextAfter(lastToken, " ");
|
|
}
|
|
|
|
return fixer.removeRange([lastToken.range[1], closeBrace.range[0]]);
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
return {
|
|
BlockStatement: checkSpacingInsideBraces,
|
|
StaticBlock: checkSpacingInsideBraces,
|
|
SwitchStatement: checkSpacingInsideBraces
|
|
};
|
|
}
|
|
};
|