disallowSpaceAfterObjectKeys: implement ignoreSingleLine and ignoreMultiLine options

Fixes #663
Closes gh-1017

Author: hzoo

lib/rules/disallow-space-after-object-keys.js

@@ -3,7 +3,10 @@
  *
  * Type: `Boolean`
  *
- * Values: `true`
+ * Values:
+ *  - `true`
+ *  - `"ignoreSingleLine"` ignores objects if the object only takes up a single line
+ *  - `"ignoreMultiLine"` ignores objects if the object takes up multiple lines
  *
  * #### Example
  *
@@ -28,22 +31,36 @@ module.exports = function() {};
 module.exports.prototype = {
 
     configure: function(disallow) {
+        var modes = {
+            'ignoreSingleLine': 'ignoreSingleLine',
+            'ignoreMultiLine': 'ignoreMultiLine'
+        };
         assert(
-            disallow === true,
-            this.getOptionName() + ' option requires true value or should be removed'
+            disallow === true || typeof disallow === 'string' && modes[disallow],
+            this.getOptionName() +
+            ' option requires true value requires one of the following values: ' +
+            Object.keys(modes).join(', ')
         );
+        this._mode = disallow === true ? true : modes[disallow];
     },
 
     getOptionName: function() {
         return 'disallowSpaceAfterObjectKeys';
     },
 
     check: function(file, errors) {
+        var mode = this._mode;
         file.iterateNodesByType('ObjectExpression', function(node) {
             node.properties.forEach(function(property) {
                 if (property.shorthand || property.method) {
                     return;
                 }
+                if (mode === 'ignoreSingleLine' && node.loc.start.line === node.loc.end.line) {
+                    return;
+                }
+                if (mode === 'ignoreMultiLine' && node.loc.start.line !== node.loc.end.line) {
+                    return;
+                }
 
                 var token = file.getFirstNodeToken(property.key);
                 errors.assert.noWhitespaceBetween({

test/rules/disallow-space-after-object-keys.js

@@ -7,37 +7,78 @@ describe('rules/disallow-space-after-object-keys', function() {
     beforeEach(function() {
         checker = new Checker();
         checker.registerDefaultRules();
-        checker.configure({ disallowSpaceAfterObjectKeys: true });
     });
 
-    it('should report with space(s) after keys', function() {
-        assert(checker.checkString('var x = { a : 1, b: 2 };').getErrorCount() === 1);
-        assert(checker.checkString('var x = { abc : 1, b  : 2 };').getErrorCount() === 2);
-    });
+    describe('true option', function() {
+        beforeEach(function() {
+            checker.configure({ disallowSpaceAfterObjectKeys: true });
+        });
 
-    it('should report with end of line after keys', function() {
-        assert(checker.checkString(
-            'var x = {' +
-            '   a\n' +
-            '   :\n' +
-            '   2\n' +
-            '}'
-        ).getErrorCount() === 1);
-    });
+        it('should report with space(s) after keys', function() {
+            assert(checker.checkString('var x = { a : 1, b: 2 };').getErrorCount() === 1);
+            assert(checker.checkString('var x = { abc : 1, b  : 2 };').getErrorCount() === 2);
+        });
+
+        it('should report with end of line after keys', function() {
+            assert(checker.checkString(
+                'var x = {' +
+                '   a\n' +
+                '      :\n' +
+                '   2\n' +
+                '}'
+            ).getErrorCount() === 1);
+        });
 
-    it('should not report without space after keys', function() {
-        assert(checker.checkString('var x = { a: 1, bcd: 2 };').isEmpty());
+        it('should not report without space after keys', function() {
+            assert(checker.checkString('var x = { a: 1, bcd: 2 };').isEmpty());
+        });
+
+        it('should not report shorthand object properties', function() {
+            checker.configure({ esnext: true });
+            assert(checker.checkString('var x = { a, b };').isEmpty());
+            assert(checker.checkString('var x = {a, b};').isEmpty());
+        });
+
+        it('should report mixed shorthand and normal object propertis', function() {
+            checker.configure({ esnext: true });
+            assert.equal(checker.checkString('var x = { a : 1, b };').getErrorCount(), 1);
+        });
     });
 
-    it('should not report shorthand object properties', function() {
-        checker.configure({ esnext: true });
-        assert(checker.checkString('var x = { a, b };').isEmpty());
-        assert(checker.checkString('var x = {a, b};').isEmpty());
+    describe('ignoreSingleLine option', function() {
+        beforeEach(function() {
+            checker.configure({ disallowSpaceAfterObjectKeys: 'ignoreSingleLine' });
+        });
+
+        it('should not report with an object that takes up a single line', function() {
+            assert(checker.checkString('var x = {a : 1, bcd : 2};').isEmpty());
+        });
+
+        it('should report with an object that takes up a multi line', function() {
+            assert(checker.checkString(
+                'var x = {\n' +
+                    'a : 1,\n' +
+                '};'
+            ).getErrorCount() === 1);
+        });
     });
 
-    it('should report mixed shorthand and normal object propertis', function() {
-        checker.configure({ esnext: true });
-        assert.equal(checker.checkString('var x = { a : 1, b };').getErrorCount(), 1);
+    describe('ignoreMultiLine option', function() {
+        beforeEach(function() {
+            checker.configure({ disallowSpaceAfterObjectKeys: 'ignoreMultiLine' });
+        });
+
+        it('should report with an object that takes up a single line', function() {
+            assert(checker.checkString('var x = {a : 1, bcd : 2};').getErrorCount() === 2);
+        });
+
+        it('should not report with an object that takes up a multi line', function() {
+            assert(checker.checkString(
+                'var x = {\n' +
+                    'a : 1,\n' +
+                '};'
+            ).isEmpty());
+        });
     });
 
     it('should not report es6-methods. #1013', function() {