Fix: rename "requireCapitalizedComments" option

Since it was never documented, we consider it to be backcompat Fixes #1853
jscs-dev · Oct 22, 2015 · 077c2f6 · 077c2f6
1 parent 5ee3120
commit 077c2f6
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/lib/rules/require-capitalized-comments.js b/lib/rules/require-capitalized-comments.js
@@ -124,7 +124,7 @@ module.exports.prototype = {
 
         var isObject = typeof options === 'object';
         var error = optionName + ' option requires a true value ' +
-            'or an object with String[] `allExcept` property or true with `ignoreIfInTheMiddle`';
+            'or an object with String[] `allExcept` property or true with `inlined`';
 
         assert(
             options === true ||
@@ -149,11 +149,11 @@ module.exports.prototype = {
             this._isPragma = isPragma();
         }
 
-        if (isObject && options.ignoreIfInTheMiddle) {
+        if (isObject && options.inlined) {
             this.inlined = true;
         }
 
-        if (isObject && !options.allExcept && !options.ignoreIfInTheMiddle) {
+        if (isObject && !options.allExcept && !options.inlined) {
             assert(false, error);
         }
     },

diff --git a/presets/jquery.json b/presets/jquery.json
@@ -69,7 +69,7 @@
     },
     "requirePaddingNewLinesBeforeLineComments": true,
     "requireCapitalizedComments": {
-        "ignoreIfInTheMiddle": true
+        "inlined": true
     },
     "validateLineBreaks": "LF",
 

diff --git a/test/specs/rules/require-capitalized-comments.js b/test/specs/rules/require-capitalized-comments.js
@@ -198,11 +198,11 @@ describe('rules/require-capitalized-comments', function() {
         });
     });
 
-    describe('ignoreIfInTheMiddle: true', function() {
+    describe('inlined: true', function() {
         beforeEach(function() {
             checker.configure({
                 requireCapitalizedComments: {
-                    ignoreIfInTheMiddle: true
+                    inlined: true
                 }
             });
         });
@@ -233,11 +233,11 @@ describe('rules/require-capitalized-comments', function() {
             }).to.throw('AssertionError');
         });
 
-        it('ignoreIfInTheMiddle: false', function() {
+        it('inlined: false', function() {
             expect(function() {
                 checker.configure({
                     requireCapitalizedComments: {
-                        ignoreIfInTheMiddle: false
+                        inlined: false
                     }
                 });
             }).to.throw('AssertionError');