requirePaddingNewLinesBeforeLineComments: Allow consecutive comments …

…and firstAfterCurly exception Refs #1103 Closes gh-1102
jscs-dev · Mar 2, 2015 · afc670d · afc670d
1 parent a9e7f09
commit afc670d
Show file tree

Hide file tree

Showing 2 changed files with 137 additions and 28 deletions.
diff --git a/lib/rules/require-padding-newlines-before-line-comments.js b/lib/rules/require-padding-newlines-before-line-comments.js
@@ -3,21 +3,42 @@
  *
  * Type: `Boolean`
  *
- * Values: `true`
- *
- * #### Example
+ * Values:
+ * - `true`: always require a newline before line comments
+ * - `Object`:
+ *      - `"allExcept"`: `"firstAfterCurly"` Comments may be first line of block without extra padding
  *
+ * #### Examples
  * ```js
  * "requirePaddingNewLinesBeforeLineComments": true
+ * "requirePaddingNewLinesBeforeLineComments": { "allExcept": "firstAfterCurly" }
+ * ```
+ *
+ * ##### Valid for `true`
+ *
+ * ```js
+ * var a = 2;
+ *
+ * // comment
+ * return a;
+ *
+ * function() {
+ *
+ *   // comment
+ * }
  * ```
  *
- * ##### Valid
+ * ##### Valid for `{ "allExcept": "firstAfterCurly" }`
  *
  * ```js
  * var a = 2;
  *
  * // comment
  * return a;
+ *
+ * function() {
+ *   // comment
+ * }
  * ```
  *
  * ##### Invalid
@@ -26,6 +47,10 @@
  * var a = 2;
  * //comment
  * return a;
+ *
+ * function() {
+ *   // comment
+ * }
  * ```
  */
 
@@ -36,24 +61,44 @@ module.exports = function() {};
 module.exports.prototype = {
 
     configure: function(value) {
-        assert(
-            value === true,
-            'requirePaddingNewLinesBeforeLineComments option requires true value or should be removed'
-        );
+        this._allowFirstAfterCurly = false;
+
+        if (typeof value === 'object') {
+            assert(typeof value.allExcept === 'string' && value.allExcept === 'firstAfterCurly',
+                'requirePaddingNewLinesBeforeLineComments option requires the "allExcept" ' +
+                 'property to equal "firstAfterCurly"');
+            this._allowFirstAfterCurly = true;
+        } else {
+            assert(value === true,
+                'requirePaddingNewLinesBeforeLineComments option requires true value or object'
+            );
+        }
     },
 
     getOptionName: function() {
         return 'requirePaddingNewLinesBeforeLineComments';
     },
 
     check: function(file, errors) {
+        var allowFirstAfterCurly = this._allowFirstAfterCurly;
+
         file.iterateTokensByType('Line', function(comment) {
             if (comment.loc.start.line === 1) {
                 return;
             }
 
+            var prevToken = file.getPrevToken(comment, {includeComments: true});
+
+            if (prevToken.type === 'Line') {
+                return;
+            }
+
+            if (allowFirstAfterCurly && prevToken.type === 'Punctuator' && prevToken.value === '{') {
+                return;
+            }
+
             errors.assert.linesBetween({
-                token: file.getPrevToken(comment, {includeComments: true}),
+                token: prevToken,
                 nextToken: comment,
                 atLeast: 2,
                 message: 'Line comments must be preceded with a blank line'

diff --git a/test/rules/require-padding-newlines-before-line-comments.js b/test/rules/require-padding-newlines-before-line-comments.js
@@ -7,34 +7,98 @@ describe('rules/require-padding-newlines-before-line-comments', function() {
     beforeEach(function() {
         checker = new Checker();
         checker.registerDefaultRules();
-        checker.configure({ requirePaddingNewLinesBeforeLineComments: true });
     });
 
-    it('should report missing padding before line comment', function() {
-        assert(checker.checkString('var a = 2;\n// comment').getErrorCount() === 1);
-    });
+    describe('invalid options', function() {
+        it('should throw if false', function() {
+            assert.throws(function() {
+                checker.configure({ requirePaddingNewLinesBeforeLineComments: false });
+            });
+        });
 
-    it('should report line comment after block comment', function() {
-        assert(checker.checkString('var a = 2;\n/* comment */\n// comment').getErrorCount() === 1);
-    });
+        it('should throw if array', function() {
+            assert.throws(function() {
+                checker.configure({ requirePaddingNewLinesBeforeLineComments: [] });
+            });
+        });
 
-    it('should not report missing padding if comment is first line', function() {
-        assert(checker.checkString('// comment\nvar a = 2;').isEmpty());
-    });
+        it('should throw if empty object', function() {
+            assert.throws(function() {
+                checker.configure({ requirePaddingNewLinesBeforeLineComments: {} });
+            });
+        });
 
-    it('should not report padding before line comment', function() {
-        assert(checker.checkString('var a = 2;\n\n// comment').isEmpty());
-    });
+        it('should throw if not allExcept object', function() {
+            assert.throws(function() {
+                checker.configure({ requirePaddingNewLinesBeforeLineComments: { allBut: false} });
+            });
+        });
 
-    it('should not report additional padding before line comment', function() {
-        assert(checker.checkString('var a = 2;\n\n\n// comment').isEmpty());
+        it('should throw if not allExcept firstAfterCurly', function() {
+            assert.throws(function() {
+                checker.configure({ requirePaddingNewLinesBeforeLineComments: { allExcept: 'badOptionName'} });
+            });
+        });
     });
 
-    it('should not report missing padding with block comment', function() {
-        assert(checker.checkString('var a = 2;\n/* comment */').isEmpty());
+    describe('value true', function() {
+        beforeEach(function() {
+            checker.configure({ requirePaddingNewLinesBeforeLineComments: true });
+        });
+
+        it('should report missing padding before line comment', function() {
+            assert(checker.checkString('var a = 2;\n// comment').getErrorCount() === 1);
+        });
+
+        it('should report line comment after block comment', function() {
+            assert(checker.checkString('var a = 2;\n/* comment */\n// comment').getErrorCount() === 1);
+        });
+
+        it('should not report multiple line comments', function() {
+            assert(checker.checkString('// comment\n//foo').isEmpty());
+        });
+
+        it('should report one error if multiple comments dont have line space', function() {
+            assert(checker.checkString('var a = 2;\n// comment\n// comment').getErrorCount() === 1);
+        });
+
+        it('should not report missing padding if comment is first line', function() {
+            assert(checker.checkString('// comment\nvar a = 2;').isEmpty());
+        });
+
+        it('should not report padding before line comment', function() {
+            assert(checker.checkString('var a = 2;\n\n// comment').isEmpty());
+        });
+
+        it('should not report additional padding before line comment', function() {
+            assert(checker.checkString('var a = 2;\n\n\n// comment').isEmpty());
+        });
+
+        it('should not report missing padding with block comment', function() {
+            assert(checker.checkString('var a = 2;\n/* comment */').isEmpty());
+        });
+
+        it('should not report line comment after block comment with padding', function() {
+            assert(checker.checkString('var a = 2;\n/* comment */\n\n// comment').isEmpty());
+        });
+
+        it('should report error if first line after a curly', function() {
+            assert(checker.checkString('if (true) {\n// comment\n}').getErrorCount() === 1);
+        });
     });
 
-    it('should not report line comment after block comment with padding', function() {
-        assert(checker.checkString('var a = 2;\n/* comment */\n\n// comment').isEmpty());
+    describe('value allExcept: firstAfterCurly', function() {
+        beforeEach(function() {
+            checker.configure({
+                requirePaddingNewLinesBeforeLineComments: {
+                    allExcept: 'firstAfterCurly'
+                }
+            });
+        });
+
+        it('should not report error if first line after a curly', function() {
+            assert(checker.checkString('if (true) {\n// comment\n}').isEmpty());
+            assert(checker.checkString('var a = {\n// comment\n};').isEmpty());
+        });
     });
 });