Merge pull request #132 from mobify/add-comment-spacing

✨ Add eslint rule to enforce comment whitespacing

Author: Marlow Payne

CHANGELOG

@@ -1,16 +1,14 @@
 # To be released
     - Re-organized and cleaned up markdown linting files
     - Switched to using `no-duplicate-headings-in-section` (instead of `no-duplicate-headings`)
-
+    - Add `spaced-comment` rule enforcement to ES5 and legacy (ESLint 1.x or lower) linting [#132](https://github.com/mobify/mobify-code-style/pull/132)
 2.7.0
     - Remove `variable-for-property` rule from sass-lint
     - Adds markdown linting via `lint-md` script
     - Add ESLint and Atom Text integration how-to doc
-
 2.6.0
     - Remove `variable-for-property` rule from sass-lint [#126](https://github.com/mobify/mobify-code-style/pull/126)
     - Add the eslint jsx-a11y plugin through a new `mobify-es6-react-a11y` configuration [#129](https://github.com/mobify/mobify-code-style/pull/129)
-
 2.5.3
     - Fix #123 by using react/jsx-wrap-multilines rule
     - Migrate CSSComb documentation from Confluence to code style repo

es5/README.md

@@ -42,11 +42,24 @@ if (condition) {
 
 In general, always favour comment placement that leads to less indenting.
 
-
 Don't commit commented out sections of code back into the repository. Just delete the code. That's what git's history is for!
 
 If a piece of code is very temporarily being removed, and will be reinserted shortly, you might decide to do this anyway. Please leave a detailed comment explaining exactly why. Sorta like those post-its we leave on boxes in the fridge with our name and date so that we know when to chuck 'em out!
 
+Comments should have whitespace beginning the comment:
+
+````javascript
+//This is a bad comment 👎
+
+// This is a good comment 👍
+
+/*This is
+*a bad multi-
+*line comment 👎 */
+
+/* This is a good
+ * multi-line comment 👍 */
+````
 
 ##Use single quotes
 

es5/mobify-es5.yml

@@ -46,6 +46,7 @@ rules:
     - never
   space-infix-ops: error
   space-unary-ops: error
+  spaced-comment: error
   no-undef: error
   eol-last: warn
   quotes:

javascript/.eslintrc

@@ -84,6 +84,9 @@
         // Disallow spacing around non-word unary operators: -, +, --, ++, !, !!
         "space-unary-ops": [2, { "words": true, "nonwords": false }],
 
+        // Enforce whitespace after the start of a comment (// or /*)
+        "spaced-comment": 2,
+
         // Disallow undeclared variables (unless mentioned in /*global ...*/ comment)
         "no-undef": 2,
 

javascript/README.md

@@ -45,11 +45,24 @@ if (condition) {
 
 In general, always favour comment placement that leads to less indenting.
 
-
 Don't commit commented out sections of code back into the repository. Just delete the code. That's what git's history is for!
 
 If a piece of code is very temporarily being removed, and will be reinserted shortly, you might decide to do this anyway. Please leave a detailed comment explaining exactly why. Sorta like those post-its we leave on boxes in the fridge with our name and date so that we know when to chuck 'em out!
 
+Comments should have whitespace beginning the comment:
+
+````javascript
+//This is a bad comment 👎
+
+// This is a good comment 👍
+
+/*This is
+*a bad multi-
+*line comment 👎 */
+
+/* This is a good
+ * multi-line comment 👍 */
+````
 
 ##Use single quotes