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.

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

Add autofix to value-list-comma-space-after #3558

Merged
merged 1 commit into from Aug 21, 2018
Merged

Add autofix to value-list-comma-space-after #3558

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/user-guide/rules.md
View file
Open in desktop
Expand Up @@ -250,7 +250,7 @@ Here are all the rules within stylelint, grouped first [by category](../../VISIO

- [`value-list-comma-newline-after`](../../lib/rules/value-list-comma-newline-after/README.md): Require a newline or disallow whitespace after the commas of value lists.
- [`value-list-comma-newline-before`](../../lib/rules/value-list-comma-newline-before/README.md): Require a newline or disallow whitespace before the commas of value lists.
- [`value-list-comma-space-after`](../../lib/rules/value-list-comma-space-after/README.md): Require a single space or disallow whitespace after the commas of value lists.
- [`value-list-comma-space-after`](../../lib/rules/value-list-comma-space-after/README.md): Require a single space or disallow whitespace after the commas of value lists (Autofixable).
- [`value-list-comma-space-before`](../../lib/rules/value-list-comma-space-before/README.md): Require a single space or disallow whitespace before the commas of value lists.
- [`value-list-max-empty-lines`](../../lib/rules/value-list-max-empty-lines/README.md): Limit the number of adjacent empty lines within value lists.

Expand Down
2 changes: 2 additions & 0 deletions lib/rules/value-list-comma-space-after/README.md
View file
Open in desktop
Expand Up @@ -8,6 +8,8 @@ a { background-size: 0, 0; }
* The space after these commas */
```

The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix most of the problems reported by this rule.

## Options

`string`: `"always"|"never"|"always-single-line"|"never-single-line"`
Expand Down
82 changes: 82 additions & 0 deletions lib/rules/value-list-comma-space-after/__tests__/index.js
View file
Open in desktop
Expand Up @@ -6,6 +6,7 @@ const { messages, ruleName } = rule;
testRule(rule, {
ruleName,
config: ["always"],
fix: true,

accept: [
{
Expand All @@ -27,41 +28,76 @@ testRule(rule, {
reject: [
{
code: "a { background-size: 0,0; }",
fixed: "a { background-size: 0, 0; }",
message: messages.expectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size:\n\t0, 0; }",
fixed: "a { background-size:\n\t0, 0; }",
message: messages.expectedAfter(),
line: 2,
column: 3
},
{
code: "a { background-size: 0,\n0; }",
fixed: "a { background-size: 0, 0; }",
message: messages.expectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,\r\n0; }",
fixed: "a { background-size: 0, 0; }",
description: "CRLF",
message: messages.expectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,\t0; }",
fixed: "a { background-size: 0, 0; }",
message: messages.expectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,/*1*/0; }",
fixed: "a { background-size: 0, /*1*/0; }",
message: messages.expectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,0,0,0; }",
fixed: "a { background-size: 0, 0, 0, 0; }",
message: messages.expectedAfter(),
line: 1,
column: 23
},
{
code: ":root { --variable: 0,0; }",
fixed: ":root { --variable: 0, 0; }",
message: messages.expectedAfter(),
line: 1,
column: 22
},
{
code: "a { pr,op: 0,0; }",
fixed: "a { pr,op: 0, 0; }",
description: "edge case",
message: messages.expectedAfter(),
line: 1,
column: 7
}
]
});

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

accept: [
{
Expand All @@ -83,41 +119,76 @@ testRule(rule, {
reject: [
{
code: "a { background-size: 0, 0; }",
fixed: "a { background-size: 0,0; }",
message: messages.rejectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size: 0, 0; }",
fixed: "a { background-size: 0,0; }",
message: messages.rejectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,\n0; }",
fixed: "a { background-size: 0,0; }",
message: messages.rejectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,\r\n0; }",
fixed: "a { background-size: 0,0; }",
description: "CRLF",
message: messages.rejectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,\t0; }",
fixed: "a { background-size: 0,0; }",
message: messages.rejectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size: 0, /*1*/ 0; }",
fixed: "a { background-size: 0,/*1*/ 0; }",
message: messages.rejectedAfter(),
line: 1,
column: 23
},
{
code: "a { background-size: 0, 0, 0, 0 ; }",
fixed: "a { background-size: 0,0,0,0 ; }",
message: messages.rejectedAfter(),
line: 1,
column: 23
},
{
code: ":root { --variable: 0, 0; }",
fixed: ":root { --variable: 0,0; }",
message: messages.rejectedAfter(),
line: 1,
column: 22
},
{
code: "a { pr, op: 0, 0; }",
fixed: "a { pr, op: 0,0; }",
description: "edge case",
message: messages.rejectedAfter(),
line: 1,
column: 7
}
]
});

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

accept: [
{
Expand Down Expand Up @@ -155,31 +226,36 @@ testRule(rule, {
reject: [
{
code: "a { background-size: 0,0; }",
fixed: "a { background-size: 0, 0; }",
message: messages.expectedAfterSingleLine(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,0;\n}",
fixed: "a { background-size: 0, 0;\n}",
message: messages.expectedAfterSingleLine(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,0;\r\n}",
fixed: "a { background-size: 0, 0;\r\n}",
description: "CRLF",
message: messages.expectedAfterSingleLine(),
line: 1,
column: 23
},
{
code: "a { background-size: 0, 0; }",
fixed: "a { background-size: 0, 0; }",
message: messages.expectedAfterSingleLine(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,\t0; }",
fixed: "a { background-size: 0, 0; }",
message: messages.expectedAfterSingleLine(),
line: 1,
column: 23
Expand All @@ -190,6 +266,7 @@ testRule(rule, {
testRule(rule, {
ruleName,
config: ["never-single-line"],
fix: true,

accept: [
{
Expand Down Expand Up @@ -227,31 +304,36 @@ testRule(rule, {
reject: [
{
code: "a { background-size: 0, 0; }",
fixed: "a { background-size: 0,0; }",
message: messages.rejectedAfterSingleLine(),
line: 1,
column: 23
},
{
code: "a { background-size: 0, 0;\n}",
fixed: "a { background-size: 0,0;\n}",
message: messages.rejectedAfterSingleLine(),
line: 1,
column: 23
},
{
code: "a { background-size: 0, 0;\r\n}",
fixed: "a { background-size: 0,0;\r\n}",
description: "CRLF",
message: messages.rejectedAfterSingleLine(),
line: 1,
column: 23
},
{
code: "a { background-size: 0, 0; }",
fixed: "a { background-size: 0,0; }",
message: messages.rejectedAfterSingleLine(),
line: 1,
column: 23
},
{
code: "a { background-size: 0,\t0; }",
fixed: "a { background-size: 0,0; }",
message: messages.rejectedAfterSingleLine(),
line: 1,
column: 23
Expand Down
42 changes: 40 additions & 2 deletions lib/rules/value-list-comma-space-after/index.js
View file
Open in desktop
@@ -1,5 +1,6 @@
"use strict";

const declarationValueIndex = require("../../utils/declarationValueIndex");
const ruleMessages = require("../../utils/ruleMessages");
const validateOptions = require("../../utils/validateOptions");
const valueListCommaWhitespaceChecker = require("../valueListCommaWhitespaceChecker");
Expand All @@ -16,7 +17,7 @@ const messages = ruleMessages(ruleName, {
'Unexpected whitespace after "," in a single-line list'
});

const rule = function(expectation) {
const rule = function(expectation, options, context) {
const checker = whitespaceChecker("space", expectation, messages);
return (root, result) => {
const validOptions = validateOptions(result, ruleName, {
Expand All @@ -27,12 +28,49 @@ const rule = function(expectation) {
return;
}

let fixData;
valueListCommaWhitespaceChecker({
root,
result,
locationChecker: checker.after,
checkedRuleName: ruleName
checkedRuleName: ruleName,
fix: context.fix
? (declNode, index) => {
const valueIndex = declarationValueIndex(declNode);
if (index <= valueIndex) {
return false;
}
fixData = fixData || new Map();
const commaIndices = fixData.get(declNode) || [];
commaIndices.push(index);
fixData.set(declNode, commaIndices);
return true;
}
: null
});
if (fixData) {
fixData.forEach((commaIndices, decl) => {
commaIndices
.sort()
.reverse()
.forEach(index => {
const value = decl.raws.value ? decl.raws.value.raw : decl.value;
const valueIndex = index - declarationValueIndex(decl);
const beforeValue = value.slice(0, valueIndex + 1);
let afterValue = value.slice(valueIndex + 1);
if (expectation.indexOf("always") === 0) {
afterValue = afterValue.replace(/^\s*/, " ");
} else if (expectation.indexOf("never") === 0) {
afterValue = afterValue.replace(/^\s*/, "");
}
if (decl.raws.value) {
decl.raws.value.raw = beforeValue + afterValue;
} else {
decl.value = beforeValue + afterValue;
}
});
});
}
};
};

Expand Down
3 changes: 3 additions & 0 deletions lib/rules/valueListCommaWhitespaceChecker.js
View file
Open in desktop
Expand Up @@ -30,6 +30,9 @@ module.exports = function(opts) {
source,
index,
err: m => {
if (opts.fix && opts.fix(node, index)) {
return;
}
report({
message: m,
node,
Expand Down