Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update: Add autofix for padded-blocks (fixes #6320) #6393

Merged
merged 1 commit into from Jun 15, 2016
Merged

Update: Add autofix for padded-blocks (fixes #6320) #6393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/rules/README.md
View file
Open in desktop
Expand Up @@ -210,7 +210,7 @@ These rules relate to style guidelines, and are therefore quite subjective:
* [one-var-declaration-per-line](one-var-declaration-per-line.md): require or disallow newlines around `var` declarations
* [operator-assignment](operator-assignment.md): require or disallow assignment operator shorthand where possible
* [operator-linebreak](operator-linebreak.md): enforce consistent linebreak style for operators
* [padded-blocks](padded-blocks.md): require or disallow padding within blocks
* [padded-blocks](padded-blocks.md): require or disallow padding within blocks (fixable)
* [quote-props](quote-props.md): require quotes around object literal property names
* [quotes](quotes.md): enforce the consistent use of either backticks, double, or single quotes (fixable)
* [require-jsdoc](require-jsdoc.md): require JSDoc comments
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/padded-blocks.md
View file
Open in desktop
@@ -1,5 +1,7 @@
# Enforce padding within blocks (padded-blocks)

(fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) automatically fixes problems reported by this rule.

Some style guides require block statements to start and end with blank lines. The goal is
to improve readability by visually separating the block content and the surrounding code.

Expand Down
20 changes: 19 additions & 1 deletion lib/rules/padded-blocks.js
View file
Open in desktop
Expand Up @@ -17,6 +17,8 @@ module.exports = {
recommended: false
},

fixable: "whitespace",

schema: [
{
oneOf: [
Expand Down Expand Up @@ -164,30 +166,46 @@ module.exports = {
context.report({
node: node,
loc: { line: openBrace.loc.start.line, column: openBrace.loc.start.column },
fix: function(fixer) {
return fixer.insertTextAfter(openBrace, "\n");
},
message: ALWAYS_MESSAGE
});
}
if (!blockHasBottomPadding) {
context.report({
node: node,
loc: {line: closeBrace.loc.end.line, column: closeBrace.loc.end.column - 1 },
fix: function(fixer) {
return fixer.insertTextBefore(closeBrace, "\n");
},
message: ALWAYS_MESSAGE
});
}
} else {
if (blockHasTopPadding) {
var nextToken = sourceCode.getTokenOrCommentAfter(openBrace);

context.report({
node: node,
loc: { line: openBrace.loc.start.line, column: openBrace.loc.start.column },
fix: function(fixer) {
return fixer.replaceTextRange([openBrace.end, nextToken.start], "\n");
},
message: NEVER_MESSAGE
});
}

if (blockHasBottomPadding) {
var previousToken = sourceCode.getTokenOrCommentBefore(closeBrace);

context.report({
node: node,
loc: {line: closeBrace.loc.end.line, column: closeBrace.loc.end.column - 1 },
message: NEVER_MESSAGE
message: NEVER_MESSAGE,
fix: function(fixer) {
return fixer.replaceTextRange([previousToken.end, closeBrace.start], "\n");
}
});
}
}
Expand Down
56 changes: 55 additions & 1 deletion tests/lib/rules/padded-blocks.js
View file
Open in desktop
Expand Up @@ -76,6 +76,7 @@ ruleTester.run("padded-blocks", rule, {
invalid: [
{
code: "{\n//comment\na();\n\n}",
output: "{\n\n//comment\na();\n\n}",
errors: [
{
message: ALWAYS_MESSAGE,
Expand All @@ -86,6 +87,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\n\na();\n//comment\n}",
output: "{\n\na();\n//comment\n\n}",
errors: [
{
message: ALWAYS_MESSAGE,
Expand All @@ -96,6 +98,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\n\na()\n//comment\n}",
output: "{\n\na()\n//comment\n\n}",
errors: [
{
message: ALWAYS_MESSAGE,
Expand All @@ -106,6 +109,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\na();\n\n}",
output: "{\n\na();\n\n}",
errors: [
{
message: ALWAYS_MESSAGE,
Expand All @@ -115,6 +119,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\n\na();\n}",
output: "{\n\na();\n\n}",
errors: [
{
message: ALWAYS_MESSAGE,
Expand All @@ -124,6 +129,21 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\na();\n}",
output: "{\n\na();\n\n}",
errors: [
{
message: ALWAYS_MESSAGE,
line: 1
},
{
message: ALWAYS_MESSAGE,
line: 3
}
]
},
{
code: "{\r\na();\r\n}",
output: "{\n\r\na();\r\n\n}",
errors: [
{
message: ALWAYS_MESSAGE,
Expand All @@ -137,6 +157,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\na();}",
output: "{\n\na();\n}",
errors: [
{
message: ALWAYS_MESSAGE,
Expand All @@ -150,6 +171,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{a();\n}",
output: "{\na();\n\n}",
errors: [
{
message: ALWAYS_MESSAGE,
Expand All @@ -163,6 +185,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{a();\n}",
output: "{\na();\n\n}",
options: [{blocks: "always"}],
errors: [
{
Expand All @@ -177,6 +200,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "switch (a) {\ncase 0: foo();\ncase 1: bar();\n}",
output: "switch (a) {\n\ncase 0: foo();\ncase 1: bar();\n\n}",
options: [{switches: "always"}],
errors: [
{
Expand All @@ -193,6 +217,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "switch (a) {\n//comment\ncase 0: foo();//comment\n}",
output: "switch (a) {\n\n//comment\ncase 0: foo();//comment\n\n}",
options: [{switches: "always"}],
errors: [
{
Expand All @@ -209,6 +234,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "class A {\nconstructor(){}\n}",
output: "class A {\n\nconstructor(){}\n\n}",
parserOptions: { ecmaVersion: 6 },
options: [{classes: "always"}],
errors: [
Expand All @@ -226,6 +252,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{a();}",
output: "{\na();\n}",
errors: [
{
message: ALWAYS_MESSAGE,
Expand All @@ -239,6 +266,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\na()\n//comment\n\n}",
output: "{\na()\n//comment\n}",
options: ["never"],
errors: [
{
Expand All @@ -249,6 +277,22 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\n\na();\n\n}",
output: "{\na();\n}",
options: ["never"],
errors: [
{
message: NEVER_MESSAGE,
line: 1
},
{
message: NEVER_MESSAGE,
line: 5
}
]
},
{
code: "{\r\n\r\na();\r\n\r\n}",
output: "{\na();\n}",
options: ["never"],
errors: [
{
Expand All @@ -262,7 +306,8 @@ ruleTester.run("padded-blocks", rule, {
]
},
{
code: "{\n\n\na();\n\n\n}",
code: "{\n\n\n a();\n\n\n}",
output: "{\na();\n}",
options: ["never"],
errors: [
{
Expand All @@ -277,6 +322,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\n\na();\n}",
output: "{\na();\n}",
options: ["never"],
errors: [
{
Expand All @@ -287,6 +333,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\na();\n\n}",
output: "{\na();\n}",
options: ["never"],
errors: [
{
Expand All @@ -297,6 +344,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\n// comment\nif (\n// comment\n a) {}\n\n}",
output: "{\n\n// comment\nif (\n// comment\n a) {}\n\n}",
options: ["always"],
errors: [
{
Expand All @@ -308,6 +356,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\n\n// comment\nif (\n// comment\n a) {}\n}",
output: "{\n// comment\nif (\n// comment\n a) {}\n}",
options: ["never"],
errors: [
{
Expand All @@ -319,6 +368,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "{\n\n// comment\nif (\n// comment\n a) {}\n}",
output: "{\n// comment\nif (\n// comment\n a) {}\n}",
options: [{blocks: "never"}],
errors: [
{
Expand All @@ -330,6 +380,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "switch (a) {\n\ncase 0: foo();\n}",
output: "switch (a) {\ncase 0: foo();\n}",
options: [{switches: "never"}],
errors: [
{
Expand All @@ -341,6 +392,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "switch (a) {\ncase 0: foo();\n\n }",
output: "switch (a) {\ncase 0: foo();\n}",
options: [{switches: "never"}],
errors: [
{
Expand All @@ -352,6 +404,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "class A {\n\nconstructor(){\n\nfoo();\n\n}\n\n}",
output: "class A {\nconstructor(){\n\nfoo();\n\n}\n}",
parserOptions: { ecmaVersion: 6 },
options: [{classes: "never"}],
errors: [
Expand All @@ -367,6 +420,7 @@ ruleTester.run("padded-blocks", rule, {
},
{
code: "class A {\n\nconstructor(){\n\nfoo();\n\n}\n\n}",
output: "class A {\nconstructor(){\nfoo();\n}\n}",
parserOptions: { ecmaVersion: 6 },
options: [{blocks: "never", classes: "never"}],
errors: [
Expand Down