123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188 |
- "use strict";
- const astUtils = require("./utils/ast-utils");
- module.exports = {
- meta: {
- type: "layout",
- docs: {
- description: "enforce consistent brace style for blocks",
- category: "Stylistic Issues",
- recommended: false,
- url: "https://eslint.org/docs/rules/brace-style"
- },
- schema: [
- {
- enum: ["1tbs", "stroustrup", "allman"]
- },
- {
- type: "object",
- properties: {
- allowSingleLine: {
- type: "boolean",
- default: false
- }
- },
- additionalProperties: false
- }
- ],
- fixable: "whitespace",
- messages: {
- nextLineOpen: "Opening curly brace does not appear on the same line as controlling statement.",
- sameLineOpen: "Opening curly brace appears on the same line as controlling statement.",
- blockSameLine: "Statement inside of curly braces should be on next line.",
- nextLineClose: "Closing curly brace does not appear on the same line as the subsequent block.",
- singleLineClose: "Closing curly brace should be on the same line as opening curly brace or on the line after the previous block.",
- sameLineClose: "Closing curly brace appears on the same line as the subsequent block."
- }
- },
- create(context) {
- const style = context.options[0] || "1tbs",
- params = context.options[1] || {},
- sourceCode = context.getSourceCode();
-
-
-
-
- function removeNewlineBetween(firstToken, secondToken) {
- const textRange = [firstToken.range[1], secondToken.range[0]];
- const textBetween = sourceCode.text.slice(textRange[0], textRange[1]);
-
- if (textBetween.trim()) {
- return null;
- }
- return fixer => fixer.replaceTextRange(textRange, " ");
- }
-
- function validateCurlyPair(openingCurly, closingCurly) {
- const tokenBeforeOpeningCurly = sourceCode.getTokenBefore(openingCurly);
- const tokenAfterOpeningCurly = sourceCode.getTokenAfter(openingCurly);
- const tokenBeforeClosingCurly = sourceCode.getTokenBefore(closingCurly);
- const singleLineException = params.allowSingleLine && astUtils.isTokenOnSameLine(openingCurly, closingCurly);
- if (style !== "allman" && !astUtils.isTokenOnSameLine(tokenBeforeOpeningCurly, openingCurly)) {
- context.report({
- node: openingCurly,
- messageId: "nextLineOpen",
- fix: removeNewlineBetween(tokenBeforeOpeningCurly, openingCurly)
- });
- }
- if (style === "allman" && astUtils.isTokenOnSameLine(tokenBeforeOpeningCurly, openingCurly) && !singleLineException) {
- context.report({
- node: openingCurly,
- messageId: "sameLineOpen",
- fix: fixer => fixer.insertTextBefore(openingCurly, "\n")
- });
- }
- if (astUtils.isTokenOnSameLine(openingCurly, tokenAfterOpeningCurly) && tokenAfterOpeningCurly !== closingCurly && !singleLineException) {
- context.report({
- node: openingCurly,
- messageId: "blockSameLine",
- fix: fixer => fixer.insertTextAfter(openingCurly, "\n")
- });
- }
- if (tokenBeforeClosingCurly !== openingCurly && !singleLineException && astUtils.isTokenOnSameLine(tokenBeforeClosingCurly, closingCurly)) {
- context.report({
- node: closingCurly,
- messageId: "singleLineClose",
- fix: fixer => fixer.insertTextBefore(closingCurly, "\n")
- });
- }
- }
-
- function validateCurlyBeforeKeyword(curlyToken) {
- const keywordToken = sourceCode.getTokenAfter(curlyToken);
- if (style === "1tbs" && !astUtils.isTokenOnSameLine(curlyToken, keywordToken)) {
- context.report({
- node: curlyToken,
- messageId: "nextLineClose",
- fix: removeNewlineBetween(curlyToken, keywordToken)
- });
- }
- if (style !== "1tbs" && astUtils.isTokenOnSameLine(curlyToken, keywordToken)) {
- context.report({
- node: curlyToken,
- messageId: "sameLineClose",
- fix: fixer => fixer.insertTextAfter(curlyToken, "\n")
- });
- }
- }
-
-
-
- return {
- BlockStatement(node) {
- if (!astUtils.STATEMENT_LIST_PARENTS.has(node.parent.type)) {
- validateCurlyPair(sourceCode.getFirstToken(node), sourceCode.getLastToken(node));
- }
- },
- ClassBody(node) {
- validateCurlyPair(sourceCode.getFirstToken(node), sourceCode.getLastToken(node));
- },
- SwitchStatement(node) {
- const closingCurly = sourceCode.getLastToken(node);
- const openingCurly = sourceCode.getTokenBefore(node.cases.length ? node.cases[0] : closingCurly);
- validateCurlyPair(openingCurly, closingCurly);
- },
- IfStatement(node) {
- if (node.consequent.type === "BlockStatement" && node.alternate) {
-
- validateCurlyBeforeKeyword(sourceCode.getLastToken(node.consequent));
- }
- },
- TryStatement(node) {
-
- validateCurlyBeforeKeyword(sourceCode.getLastToken(node.block));
- if (node.handler && node.finalizer) {
-
- validateCurlyBeforeKeyword(sourceCode.getLastToken(node.handler.body));
- }
- }
- };
- }
- };
|