Skip to content

Commit

Permalink
Add autofix to declaration-block-semicolon-space-before (#3554)
Browse files Browse the repository at this point in the history 
> Which issue, if any, is this issue related to?

closes #3546

> Is there anything in the PR that needs further explanation?

ex.

* option: `always***`

    code:
    ```css
    a { color: pink; }
    ```
    fixed:
    ```css
    a { color: pink ; }
    ```

* option: `never***`

    code:
    ```css
    a { color: pink ; }
    ```

    fixed:
    ```css
    a { color: pink; }
    ```
  • Loading branch information
@ota-meshi @ntwb
ota-meshi authored and ntwb committed Aug 19, 2018
1 parent b1cf440 commit 6ec2a0f
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/user-guide/rules.md
View file
Expand Up @@ -276,7 +276,7 @@ Here are all the rules within stylelint, grouped first [by category](../../VISIO
- [`declaration-block-semicolon-newline-after`](../../lib/rules/declaration-block-semicolon-newline-after/README.md): Require a newline or disallow whitespace after the semicolons of declaration blocks (Autofixable).
- [`declaration-block-semicolon-newline-before`](../../lib/rules/declaration-block-semicolon-newline-before/README.md): Require a newline or disallow whitespace before the semicolons of declaration blocks.
- [`declaration-block-semicolon-space-after`](../../lib/rules/declaration-block-semicolon-space-after/README.md): Require a single space or disallow whitespace after the semicolons of declaration blocks.
- [`declaration-block-semicolon-space-before`](../../lib/rules/declaration-block-semicolon-space-before/README.md): Require a single space or disallow whitespace before the semicolons of declaration blocks.
- [`declaration-block-semicolon-space-before`](../../lib/rules/declaration-block-semicolon-space-before/README.md): Require a single space or disallow whitespace before the semicolons of declaration blocks (Autofixable).
- [`declaration-block-trailing-semicolon`](../../lib/rules/declaration-block-trailing-semicolon/README.md): Require or disallow a trailing semicolon within declaration blocks (Autofixable).

#### Block
Expand Down
2 changes: 2 additions & 0 deletions lib/rules/declaration-block-semicolon-space-before/README.md
View file
Expand Up @@ -10,6 +10,8 @@ a { color: pink; }

This rule ignores semicolons that are preceded by Less mixins.

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"|"never"|"always-single-line"|"never-single-line"`
Expand Down
60 changes: 60 additions & 0 deletions lib/rules/declaration-block-semicolon-space-before/__tests__/index.js
View file
Expand Up @@ -6,6 +6,7 @@ const { messages, ruleName } = rule;
testRule(rule, {
ruleName,
config: ["always"],
fix: true,

accept: [
{
Expand All @@ -29,47 +30,70 @@ testRule(rule, {
reject: [
{
code: "a { color: pink; }",
fixed: "a { color: pink ; }",
message: messages.expectedBefore(),
line: 1,
column: 15
},
{
code: "a { color: pink ; }",
fixed: "a { color: pink ; }",
message: messages.expectedBefore(),
line: 1,
column: 17
},
{
code: "a { color: pink\t; }",
fixed: "a { color: pink ; }",
message: messages.expectedBefore(),
line: 1,
column: 16
},
{
code: "a { color: pink\n; }",
fixed: "a { color: pink ; }",
message: messages.expectedBefore(),
line: 1,
column: 16
},
{
code: "a { color: pink\r\n; }",
fixed: "a { color: pink ; }",
description: "CRLF",
message: messages.expectedBefore(),
line: 1,
column: 17
},
{
code: "a { color: pink ; top: 0; }",
fixed: "a { color: pink ; top: 0 ; }",
message: messages.expectedBefore(),
line: 1,
column: 24
},
{
code: "a { color: pink/*comment*/; }",
fixed: "a { color: pink/*comment*/ ; }",
description: "comment",
message: messages.expectedBefore(),
line: 1,
column: 26
},
{
code: "a { color: pink /*comment*/; }",
fixed: "a { color: pink /*comment*/ ; }",
description: "comment",
message: messages.expectedBefore(),
line: 1,
column: 27
}
]
});

testRule(rule, {
ruleName,
config: ["never"],
fix: true,

accept: [
{
Expand All @@ -90,47 +114,70 @@ testRule(rule, {
reject: [
{
code: "a { color: pink ; }",
fixed: "a { color: pink; }",
message: messages.rejectedBefore(),
line: 1,
column: 16
},
{
code: "a { color: pink ; }",
fixed: "a { color: pink; }",
message: messages.rejectedBefore(),
line: 1,
column: 17
},
{
code: "a { color: pink\t; }",
fixed: "a { color: pink; }",
message: messages.rejectedBefore(),
line: 1,
column: 16
},
{
code: "a { color: pink\n; }",
fixed: "a { color: pink; }",
message: messages.rejectedBefore(),
line: 1,
column: 16
},
{
code: "a { color: pink\r\n; }",
fixed: "a { color: pink; }",
description: "CRLF",
message: messages.rejectedBefore(),
line: 1,
column: 17
},
{
code: "a { color: pink; top: 0 ; }",
fixed: "a { color: pink; top: 0; }",
message: messages.rejectedBefore(),
line: 1,
column: 24
},
{
code: "a { color: pink/*comment*/ ; }",
fixed: "a { color: pink/*comment*/; }",
description: "comment",
message: messages.rejectedBefore(),
line: 1,
column: 27
},
{
code: "a { color: pink /*comment*/ ; }",
fixed: "a { color: pink /*comment*/; }",
description: "comment",
message: messages.rejectedBefore(),
line: 1,
column: 28
}
]
});

testRule(rule, {
ruleName,
config: ["always-single-line"],
fix: true,

accept: [
{
Expand Down Expand Up @@ -162,37 +209,43 @@ testRule(rule, {
reject: [
{
code: "a { color: pink; }",
fixed: "a { color: pink ; }",
message: messages.expectedBeforeSingleLine(),
line: 1,
column: 15
},
{
code: "a,\nb { color: pink; }",
fixed: "a,\nb { color: pink ; }",
message: messages.expectedBeforeSingleLine(),
line: 2,
column: 15
},
{
code: "a,\r\nb { color: pink; }",
fixed: "a,\r\nb { color: pink ; }",
description: "CRLF",
message: messages.expectedBeforeSingleLine(),
line: 2,
column: 15
},
{
code: "a { color: pink ; }",
fixed: "a { color: pink ; }",
message: messages.expectedBeforeSingleLine(),
line: 1,
column: 17
},
{
code: "a { color: pink\t; }",
fixed: "a { color: pink ; }",
message: messages.expectedBeforeSingleLine(),
line: 1,
column: 16
},
{
code: "a { color: pink ; top: 0; }",
fixed: "a { color: pink ; top: 0 ; }",
message: messages.expectedBeforeSingleLine(),
line: 1,
column: 24
Expand All @@ -203,6 +256,7 @@ testRule(rule, {
testRule(rule, {
ruleName,
config: ["never-single-line"],
fix: true,

accept: [
{
Expand Down Expand Up @@ -230,37 +284,43 @@ testRule(rule, {
reject: [
{
code: "a { color: pink ; }",
fixed: "a { color: pink; }",
message: messages.rejectedBeforeSingleLine(),
line: 1,
column: 16
},
{
code: "a,\nb { color: pink ; }",
fixed: "a,\nb { color: pink; }",
message: messages.rejectedBeforeSingleLine(),
line: 2,
column: 16
},
{
code: "a,\r\nb { color: pink ; }",
fixed: "a,\r\nb { color: pink; }",
description: "CRLF",
message: messages.rejectedBeforeSingleLine(),
line: 2,
column: 16
},
{
code: "a { color: pink ; }",
fixed: "a { color: pink; }",
message: messages.rejectedBeforeSingleLine(),
line: 1,
column: 17
},
{
code: "a { color: pink\t; }",
fixed: "a { color: pink; }",
message: messages.rejectedBeforeSingleLine(),
line: 1,
column: 16
},
{
code: "a { color: pink; top: 0 ; }",
fixed: "a { color: pink; top: 0; }",
message: messages.rejectedBeforeSingleLine(),
line: 1,
column: 24
Expand Down
22 changes: 21 additions & 1 deletion lib/rules/declaration-block-semicolon-space-before/index.js
View file
Expand Up @@ -17,7 +17,7 @@ const messages = ruleMessages(ruleName, {
'Unexpected whitespace before ";" in a single-line declaration block'
});

const rule = function(expectation) {
const rule = function(expectation, options, context) {
const checker = whitespaceChecker("space", expectation, messages);

return (root, result) => {
Expand All @@ -43,6 +43,26 @@ const rule = function(expectation) {
index: declString.length,
lineCheckStr: blockString(parentRule),
err: m => {
if (context.fix) {
const value = decl.raws.value ? decl.raws.value.raw : decl.value;
if (expectation.indexOf("always") === 0) {
const fixedValue = value.replace(/\s*$/, " ");
if (decl.raws.value) {
decl.raws.value.raw = fixedValue;
} else {
decl.value = fixedValue;
}
return;
} else if (expectation.indexOf("never") === 0) {
const fixedValue = value.replace(/\s*$/, "");
if (decl.raws.value) {
decl.raws.value.raw = fixedValue;
} else {
decl.value = fixedValue;
}
return;
}
}
report({
message: m,
node: decl,
Expand Down

0 comments on commit 6ec2a0f

Please sign in to comment.