Add autofix to block-closing-brace-empty-line-before

docs/user-guide/rules.md

@@ -281,7 +281,7 @@ Here are all the rules within stylelint, grouped first [by category](../../VISIO
 
 #### Block
 
--   [`block-closing-brace-empty-line-before`](../../lib/rules/block-closing-brace-empty-line-before/README.md): Require or disallow an empty line before the closing brace of blocks.
+-   [`block-closing-brace-empty-line-before`](../../lib/rules/block-closing-brace-empty-line-before/README.md): Require or disallow an empty line before the closing brace of blocks (Autofixable).
 -   [`block-closing-brace-newline-after`](../../lib/rules/block-closing-brace-newline-after/README.md): Require a newline or disallow whitespace after the closing brace of blocks (Autofixable).
 -   [`block-closing-brace-newline-before`](../../lib/rules/block-closing-brace-newline-before/README.md): Require a newline or disallow whitespace before the closing brace of blocks (Autofixable).
 -   [`block-closing-brace-space-after`](../../lib/rules/block-closing-brace-space-after/README.md): Require a single space or disallow whitespace after the closing brace of blocks.

lib/rules/block-closing-brace-empty-line-before/README.md

@@ -11,6 +11,8 @@ a {
  * This line */
 ```
 
+The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule.
+
 ## Options
 
 `string`: `"always-multi-line"|"never"`

lib/rules/block-closing-brace-empty-line-before/__tests__/index.js

@@ -6,6 +6,7 @@ const { messages, ruleName } = rule;
 testRule(rule, {
   ruleName,
   config: ["always-multi-line"],
+  fix: true,
 
   accept: [
     {
@@ -51,58 +52,90 @@ testRule(rule, {
   reject: [
     {
       code: "a { color: pink;\n}",
+      fixed: "a { color: pink;\n\n}",
       message: messages.expected,
       line: 2,
       column: 1
     },
     {
       code: "a { color: pink;\r\n}",
+      fixed: "a { color: pink;\r\n\r\n}",
       message: messages.expected,
       line: 2,
       column: 1
     },
     {
       code: "a { color: pink;\n }",
+      fixed: "a { color: pink;\n\n }",
       message: messages.expected,
       line: 2,
       column: 2
     },
     {
       code: "a { color: pink;\n\t}",
+      fixed: "a { color: pink;\n\n\t}",
       message: messages.expected,
       line: 2,
       column: 2
     },
     {
       code: "a { color: pink;\r\n  }",
+      fixed: "a { color: pink;\r\n\r\n  }",
       message: messages.expected,
       line: 2,
       column: 3
     },
     {
       code: "a { color: pink;\n;}",
+      fixed: "a { color: pink;\n;\n\n}",
       message: messages.expected,
       line: 2,
       column: 2
     },
     {
       code: "a {\ncolor: pink;\n}",
+      fixed: "a {\ncolor: pink;\n\n}",
       message: messages.expected,
       line: 3,
       column: 1
     },
     {
       code: "a {\n\ncolor: pink;\n}",
+      fixed: "a {\n\ncolor: pink;\n\n}",
       message: messages.expected,
       line: 4,
       column: 1
+    },
+    {
+      code: "a { color: pink;\n\n/* comment here*/\n}",
+      fixed: "a { color: pink;\n\n/* comment here*/\n\n}",
+      message: messages.expected,
+      line: 4,
+      column: 1
+    },
+    {
+      code: "a { color: pink;\r\n\r\n/* comment here*/\r\n}",
+      fixed: "a { color: pink;\r\n\r\n/* comment here*/\r\n\r\n}",
+      message: messages.expected,
+      line: 4,
+      column: 1
+    },
+    {
+      code:
+        "@media print {\n  a {\n     color: pink;\n/* comment here*/\n  }\n}",
+      fixed:
+        "@media print {\n  a {\n     color: pink;\n/* comment here*/\n\n  }\n\n}",
+      message: messages.expected,
+      line: 5,
+      column: 3
     }
   ]
 });
 
 testRule(rule, {
   ruleName,
   config: ["never"],
+  fix: true,
 
   accept: [
     {
@@ -144,58 +177,81 @@ testRule(rule, {
   reject: [
     {
       code: "a { color: pink;\n\n}",
+      fixed: "a { color: pink;\n}",
       message: messages.rejected,
       line: 3,
       column: 1
     },
     {
       code: "a { color: pink;\r\n\r\n}",
+      fixed: "a { color: pink;\r\n}",
       message: messages.rejected,
       line: 3,
       column: 1
     },
     {
       code: "a { color: pink;\n\n }",
+      fixed: "a { color: pink;\n }",
       message: messages.rejected,
       line: 3,
       column: 2
     },
     {
       code: "a { color: pink;\n\n\t}",
+      fixed: "a { color: pink;\n\t}",
       message: messages.rejected,
       line: 3,
       column: 2
     },
     {
       code: "a { color: pink;\r\n\r\n  }",
+      fixed: "a { color: pink;\r\n  }",
       message: messages.rejected,
       line: 3,
       column: 3
     },
     {
       code: "a { color: pink;\n\n;}",
+      fixed: "a { color: pink;\n;}",
       message: messages.rejected,
       line: 3,
       column: 2
     },
     {
       code: "a {\ncolor: pink;\n\n}",
+      fixed: "a {\ncolor: pink;\n}",
       message: messages.rejected,
       line: 4,
       column: 1
     },
     {
       code: "a {\n\ncolor: pink;\n\n}",
+      fixed: "a {\n\ncolor: pink;\n}",
       message: messages.rejected,
       line: 5,
       column: 1
+    },
+    {
+      code: "@media print {\n  a {\n     color: pink;\n\n  }\n\n}",
+      fixed: "@media print {\n  a {\n     color: pink;\n  }\n}",
+      message: messages.rejected,
+      line: 5,
+      column: 3
+    },
+    {
+      code: "a {\n\ncolor: pink;\n\n/* comment here */\n\n}",
+      fixed: "a {\n\ncolor: pink;\n\n/* comment here */\n}",
+      message: messages.rejected,
+      line: 7,
+      column: 1
     }
   ]
 });
 
 testRule(rule, {
   ruleName,
   config: ["never", { except: ["after-closing-brace"] }],
+  fix: true,
 
   accept: [
     {
@@ -220,39 +276,48 @@ testRule(rule, {
   reject: [
     {
       code: "a {\n\tcolor: aquamarine;\n\n}",
+      fixed: "a {\n\tcolor: aquamarine;\n}",
       message: messages.rejected,
       line: 4,
       column: 1
     },
     {
       code: "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\t}\n}",
+      fixed: "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\t}\n\n}",
       message: messages.expected,
       line: 6,
       column: 1
     },
     {
       code:
         "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\t}\n\n\tb {\n\t\tcolor: hotpink;\n\t}\n}",
+      fixed:
+        "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\t}\n\n\tb {\n\t\tcolor: hotpink;\n\t}\n\n}",
       message: messages.expected,
       line: 10,
       column: 1
     },
     {
       code:
         "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\t}\n\n\tb {\n\t\tcolor: hotpink;\n\n\t}\n}",
+      fixed:
+        "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\t}\n\n\tb {\n\t\tcolor: hotpink;\n\t}\n\n}",
       message: messages.rejected,
       line: 10,
       column: 2
     },
     {
       code:
         "@supports (animation-name: test) {\n\n\ta {\n\t\tcolor: aquamarine;\n\t}\n}",
+      fixed:
+        "@supports (animation-name: test) {\n\n\ta {\n\t\tcolor: aquamarine;\n\t}\n\n}",
       message: messages.expected,
       line: 6,
       column: 1
     },
     {
       code: "@keyframes test {\n\n\t100% {\n\t\tcolor: aquamarine;\n\t}\n}",
+      fixed: "@keyframes test {\n\n\t100% {\n\t\tcolor: aquamarine;\n\t}\n\n}",
       message: messages.expected,
       line: 6,
       column: 1
@@ -263,6 +328,7 @@ testRule(rule, {
 testRule(rule, {
   ruleName,
   config: ["always-multi-line", { except: ["after-closing-brace"] }],
+  fix: true,
 
   accept: [
     {
@@ -290,39 +356,48 @@ testRule(rule, {
   reject: [
     {
       code: "a {\n\tcolor: aquamarine;\n}",
+      fixed: "a {\n\tcolor: aquamarine;\n\n}",
       message: messages.expected,
       line: 3,
       column: 1
     },
     {
       code: "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\n\t}\n\n}",
+      fixed: "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\n\t}\n}",
       message: messages.rejected,
       line: 8,
       column: 1
     },
     {
       code:
         "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\n\t}\n\n\tb {\n\t\tcolor: hotpink;\n\n\t}\n\n}",
+      fixed:
+        "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\n\t}\n\n\tb {\n\t\tcolor: hotpink;\n\n\t}\n}",
       message: messages.rejected,
       line: 13,
       column: 1
     },
     {
       code:
         "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\n\t}\n\n\tb {\n\t\tcolor: hotpink;\n\n\t}\n\n}",
+      fixed:
+        "@media print {\n\n\ta {\n\t\tcolor: aquamarine;\n\n\t}\n\n\tb {\n\t\tcolor: hotpink;\n\n\t}\n}",
       message: messages.rejected,
       line: 13,
       column: 1
     },
     {
       code:
         "@supports (animation-name: test) {\n\n\ta {\n\t\tcolor: aquamarine;\n\n\t}\n\n}",
+      fixed:
+        "@supports (animation-name: test) {\n\n\ta {\n\t\tcolor: aquamarine;\n\n\t}\n}",
       message: messages.rejected,
       line: 8,
       column: 1
     },
     {
       code: "@keyframes test {\n\n\t100% {\n\t\tcolor: aquamarine;\n\n\t}\n\n}",
+      fixed: "@keyframes test {\n\n\t100% {\n\t\tcolor: aquamarine;\n\n\t}\n}",
       message: messages.rejected,
       line: 8,
       column: 1

lib/rules/block-closing-brace-empty-line-before/index.js

@@ -1,11 +1,13 @@
 "use strict";
 
+const addEmptyLineAfter = require("../../utils/addEmptyLineAfter");
 const blockString = require("../../utils/blockString");
 const hasBlock = require("../../utils/hasBlock");
 const hasEmptyBlock = require("../../utils/hasEmptyBlock");
 const hasEmptyLine = require("../../utils/hasEmptyLine");
 const isSingleLineString = require("../../utils/isSingleLineString");
 const optionsMatches = require("../../utils/optionsMatches");
+const removeEmptyLineAfter = require("../../utils/removeEmptyLinesAfter");
 const report = require("../../utils/report");
 const ruleMessages = require("../../utils/ruleMessages");
 const validateOptions = require("../../utils/validateOptions");
@@ -17,7 +19,7 @@ const messages = ruleMessages(ruleName, {
   rejected: "Unexpected empty line before closing brace"
 });
 
-const rule = function(expectation, options) {
+const rule = function(expectation, options, context) {
   return (root, result) => {
     const validOptions = validateOptions(
       result,
@@ -87,6 +89,15 @@ const rule = function(expectation, options) {
         return;
       }
 
+      if (context.fix) {
+        if (expectEmptyLineBefore) {
+          addEmptyLineAfter(statement, context.newline);
+        } else {
+          removeEmptyLineAfter(statement, context.newline);
+        }
+        return;
+      }
+
       const message = expectEmptyLineBefore
         ? messages.expected
         : messages.rejected;

lib/utils/__tests__/addEmptyLineAfter.test.js

@@ -0,0 +1,54 @@
+"use strict";
+
+const addEmptyLineAfter = require("../addEmptyLineAfter");
+const postcss = require("postcss");
+
+describe("addEmptyLineBefore", () => {
+  it("adds single newline to the newline at the beginning", () => {
+    expect(run("a {\n}", "\n")).toBe("a {\n\n}");
+  });
+
+  it("adds single newline to newline at the beginning with CRLF", () => {
+    expect(run("a {\r\n}", "\r\n")).toBe("a {\r\n\r\n}");
+  });
+
+  it("adds single newline to newline at the end", () => {
+    expect(run("a {\t\n}", "\n")).toBe("a {\t\n\n}");
+  });
+
+  it("adds single newline to newline at the end with CRLF", () => {
+    expect(run("a {\t\r\n}", "\r\n")).toBe("a {\t\r\n\r\n}");
+  });
+
+  it("adds single newline to newline in the middle", () => {
+    expect(run("a {  \n\t}", "\n")).toBe("a {  \n\n\t}");
+  });
+
+  it("adds single newline to newline in the middle with CRLF", () => {
+    expect(run("a {  \r\n\t}", "\r\n")).toBe("a {  \r\n\r\n\t}");
+  });
+
+  it("adds two newlines if there aren't any existing newlines", () => {
+    expect(run("a {  }", "\n")).toBe("a {  \n\n}");
+  });
+
+  it("adds two newlines if there aren't any existing newlines with CRLF", () => {
+    expect(run("a {  }", "\r\n")).toBe("a {  \r\n\r\n}");
+  });
+
+  it("adds two newlines if there aren't any newlines after semicolon", () => {
+    expect(run("a {\n;}", "\n")).toBe("a {\n;\n\n}");
+  });
+
+  it("adds two newlines if there aren't any newlines after semicolon with CRLF", () => {
+    expect(run("a {\r\n;}", "\r\n")).toBe("a {\r\n;\r\n\r\n}");
+  });
+});
+
+function run(css, lineEnding) {
+  const root = postcss.parse(css);
+
+  addEmptyLineAfter(root.nodes[0], lineEnding);
+
+  return root.toString();
+}