Add ignoreProperties option to value-keyword-case rule (#2937)

stylelint · Oct 5, 2017 · 3457b84 · 3457b84
1 parent fe071b6
commit 3457b84
Show file tree

Hide file tree

Showing 3 changed files with 158 additions and 0 deletions.
diff --git a/lib/rules/value-keyword-case/README.md b/lib/rules/value-keyword-case/README.md
@@ -164,3 +164,64 @@ a {
 }
 ```
 
+### `ignoreProperties: ["/regex/", "non-regex"]`
+
+Ignore case of the values of the listed properties.
+
+For example, with `"lower"`.
+
+```js
+["/^(b|B)ackground$/", "display"]
+```
+
+The following patterns are considered violations:
+
+```css
+a {
+  text-align: LEFT;
+}
+```
+
+```css
+a {
+  text-align: Left;
+}
+```
+
+The following patterns are *not* considered violations:
+
+```css
+a {
+  display: bloCk;
+}
+```
+
+```css
+a {
+  display: BloCk;
+}
+```
+
+```css
+a {
+  display: BLOCK;
+}
+```
+
+```css
+a {
+  display: block;
+}
+```
+
+```css
+a {
+  background: Red;
+}
+```
+
+```css
+a {
+  Background: deepPink;
+}
+```
diff --git a/lib/rules/value-keyword-case/__tests__/index.js b/lib/rules/value-keyword-case/__tests__/index.js
@@ -1938,3 +1938,91 @@ testRule(rule, {
     }
   ]
 });
+
+testRule(rule, {
+  ruleName,
+  config: ["lower", { ignoreProperties: ["display", "/^(b|B)ackground$/"] }],
+
+  accept: [
+    {
+      code: "a { display: bloCk; }"
+    },
+    {
+      code: "a { display: BloCk; }"
+    },
+    {
+      code: "a { display: BLOCK; }"
+    },
+    {
+      code: "a { display: block; }"
+    },
+    {
+      code: "a { background: Red; }"
+    },
+    {
+      code: "a { Background: deepPink; }"
+    }
+  ],
+
+  reject: [
+    {
+      code: "a { text-align: LEFT; }",
+      message: messages.expected("LEFT", "left"),
+      description:
+        "Rejected because property doesn't match any property in ignoreProperties list"
+    },
+    {
+      code: "a { text-align: Left; }",
+      message: messages.expected("Left", "left"),
+      description:
+        "Rejected because property doesn't match any property in ignoreProperties list"
+    }
+  ]
+});
+
+testRule(rule, {
+  ruleName,
+  config: ["upper", { ignoreProperties: ["display", "/^(b|B)ackground$/"] }],
+
+  accept: [
+    {
+      code: "a { display: bloCk; }"
+    },
+    {
+      code: "a { display: BloCk; }"
+    },
+    {
+      code: "a { display: BLOCK; }"
+    },
+    {
+      code: "a { display: block; }"
+    },
+    {
+      code: "a { background: Red; }"
+    },
+    {
+      code: "a { Background: deepPink; }"
+    }
+  ],
+
+  reject: [
+    {
+      code: "a { text-align: left; }",
+      message: messages.expected("left", "LEFT"),
+      description:
+        "Rejected because property doesn't match any property in ignoreProperties list"
+    },
+    {
+      code: "a { text-align: LeFt; }",
+      message: messages.expected("LeFt", "LEFT"),
+      description:
+        "Rejected because property doesn't match any property in ignoreProperties list"
+    },
+    {
+      code: "a { text-align: Left; }",
+      message: messages.expected("Left", "LEFT"),
+      description:
+        "Rejected because property doesn't match any property in ignoreProperties list"
+    }
+  ]
+});
diff --git a/lib/rules/value-keyword-case/index.js b/lib/rules/value-keyword-case/index.js
@@ -39,6 +39,7 @@ const rule = function(expectation, options) {
       {
         actual: options,
         possible: {
+          ignoreProperties: [_.isString],
           ignoreKeywords: [_.isString]
         },
         optional: true
@@ -156,6 +157,7 @@ const rule = function(expectation, options) {
         }
 
         const ignoreKeywords = (options && options.ignoreKeywords) || [];
+        const ignoreProperties = (options && options.ignoreProperties) || [];
 
         if (
           ignoreKeywords.length > 0 &&
@@ -164,6 +166,13 @@ const rule = function(expectation, options) {
           return;
         }
 
+        if (
+          ignoreProperties.length > 0 &&
+          matchesStringOrRegExp(prop, ignoreProperties)
+        ) {
+          return;
+        }
+
         const keywordLowerCase = keyword.toLocaleLowerCase();
         let expectedKeyword = null;