feat: Add max-line-length rule. (#73)

WordPress · May 31, 2020 · b5f8108 · b5f8108
1 parent b947ba4
commit b5f8108
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 1 deletion.
diff --git a/packages/stylelint-config-wordpress/CHANGELOG.md b/packages/stylelint-config-wordpress/CHANGELOG.md
@@ -3,6 +3,7 @@
 * Removed: `stylelint < 6.9.0` compatibility.
 * Added: `selector-attribute-quotes` rule.
 * Added: `font-weight-notation` rule.
+* Added: `max-line-length` rule.
 
 # 8.0.0
 

diff --git a/packages/stylelint-config-wordpress/README.md b/packages/stylelint-config-wordpress/README.md
@@ -358,6 +358,8 @@ Correct:
   position: absolute;
   top: 0 !important; /* I should explain why this is so !important */
 }
+
+/* Long comments should manually break the line length at 80 characters. */
 ```
 Incorrect:
 ```css
@@ -383,6 +385,8 @@ Incorrect:
   position: absolute;
   top: 0 !important; /* I should explain why this is so !important */
 }
+
+/* Comments shouldn't have a line length greater than 80 characters, they should manually break the line length at 80 characters */
 ```
 
 ### Best Practices - [Handbook](https://make.wordpress.org/core/handbook/best-practices/coding-standards/css/#best-practices)

diff --git a/packages/stylelint-config-wordpress/__tests__/commenting.js b/packages/stylelint-config-wordpress/__tests__/commenting.js
@@ -31,6 +31,8 @@ const validCss = (`
 	position: absolute;
 	top: 0 !important; /* I should explain why this is so !important */
 }
+
+/* Long comments should manually break the line length at 80 characters. */
 `)
 
 const invalidCss = (`
@@ -56,6 +58,8 @@ const invalidCss = (`
 	position: absolute;
 	top: 0 !important; /* I should explain why this is so !important */
 }
+
+/* Comments shouldn't have a line length greater than 80 characters, they should manually break the line length at 80 characters */
 `)
 /* eslint-enable */
 
@@ -81,8 +85,9 @@ test("There are warnings with invalid commenting CSS", t => {
     const { errored, results } = data
     const { warnings } = results[0]
     t.truthy(errored, "errored")
-    t.is(warnings.length, 2, "flags eight warnings")
+    t.is(warnings.length, 3, "flags three warnings")
     t.is(warnings[0].text, "Expected empty line before comment (comment-empty-line-before)", "correct warning text")
     t.is(warnings[1].text, "Expected empty line before comment (comment-empty-line-before)", "correct warning text")
+    t.is(warnings[2].text, "Expected line length to be no more than 80 characters (max-line-length)", "correct warning text")
   })
 })
diff --git a/packages/stylelint-config-wordpress/index.js b/packages/stylelint-config-wordpress/index.js
@@ -45,6 +45,9 @@ module.exports = {
     "keyframe-declaration-no-important": true,
     "length-zero-no-unit": true,
     "max-empty-lines": 2,
+    "max-line-length": [ 80, {
+      "ignore": "non-comments",
+    } ],
     "media-feature-colon-space-after": "always",
     "media-feature-colon-space-before": "never",
     "media-feature-no-missing-punctuation": true,