Fix: Sparse arrays in rules with spacing and commas

Added tests against sparse arrays and fixes where needed.

Ref #1909
Closes gh-1937

Author: bjdixon

lib/rules/disallow-space-after-binary-operators.js

@@ -70,6 +70,9 @@ module.exports.prototype = {
         // Comma
         if (operators[',']) {
             file.iterateTokensByTypeAndValue('Punctuator', ',', function(token) {
+                if (file.getNextToken(token).value === ',') {
+                    return;
+                }
                 errors.assert.noWhitespaceBetween({
                     token: token,
                     nextToken: file.getNextToken(token),

lib/rules/disallow-space-after-comma.js

@@ -46,6 +46,9 @@ module.exports.prototype = {
         file.iterateTokensByTypeAndValue('Punctuator', ',', function(token) {
             var nextToken = file.getNextToken(token);
 
+            if (nextToken.value === ',') {
+                return;
+            }
             errors.assert.noWhitespaceBetween({
                 token: token,
                 nextToken: nextToken,

lib/rules/disallow-space-before-binary-operators.js

@@ -71,6 +71,9 @@ module.exports.prototype = {
         // Comma
         if (operators[',']) {
             file.iterateTokensByTypeAndValue('Punctuator', ',', function(token) {
+                if (file.getPrevToken(token).value === ',') {
+                    return;
+                }
                 errors.assert.noWhitespaceBetween({
                     token: file.getPrevToken(token, {includeComments: true}),
                     nextToken: token,

lib/rules/disallow-space-before-comma.js

@@ -46,6 +46,9 @@ module.exports.prototype = {
         file.iterateTokensByTypeAndValue('Punctuator', ',', function(token) {
             var prevToken = file.getPrevToken(token);
 
+            if (prevToken.value === ',') {
+                return;
+            }
             errors.assert.noWhitespaceBetween({
                 token: prevToken,
                 nextToken: token,

test/specs/rules/disallow-space-after-binary-operators.js

@@ -110,4 +110,10 @@ describe('rules/disallow-space-after-binary-operators', function() {
         expect(errors).to.have.one.validation.error.from('disallowSpaceAfterBinaryOperators');
         expect(errors.explainError(error)).to.have.string('Operator = should stick to following expression at input');
     });
+
+    it('should not report error for sparse arrays', function() {
+        checker.configure({ disallowSpaceAfterBinaryOperators: [','] });
+        expect(checker.checkString('var x = [1, , ,2] ,y = 32')).to.have.no.errors();
+    });
+
 });

test/specs/rules/disallow-space-after-comma.js

@@ -7,35 +7,71 @@ describe('rules/disallow-space-after-comma', function() {
     beforeEach(function() {
         checker = new Checker();
         checker.registerDefaultRules();
+        checker.configure({ disallowSpaceAfterComma: true });
     });
 
-    it('does not allow spaces after commas', function() {
-        checker.configure({ disallowSpaceAfterComma: true });
+    it('does not allow spaces after commas in var delarations', function() {
+        expect(checker.checkString('var a, b;')).to.have.one.validation.error.from('disallowSpaceAfterComma');
+    });
 
-        expect(checker.checkString('[a, b]')).to.have.one.validation.error.from('disallowSpaceAfterComma');
+    it('does not allow tabs after commas in var delarations', function() {
+        expect(checker.checkString('var a,\tb;')).to.have.one.validation.error.from('disallowSpaceAfterComma');
     });
 
-    it('does not allow tabs after commas', function() {
-        checker.configure({ disallowSpaceAfterComma: true });
+    it('does allow commas with no spaces in var delarations', function() {
+        expect(checker.checkString('var a,b,c;')).to.have.no.errors();
+    });
 
-        expect(checker.checkString('[a,\tb]')).to.have.one.validation.error.from('disallowSpaceAfterComma');
+    it('does allow commas with spaces before in var delarations', function() {
+        expect(checker.checkString('var a ,b ,c;')).to.have.no.errors();
     });
 
-    it('does allow commas with no spaces', function() {
-        checker.configure({ disallowSpaceAfterComma: true });
+    it('does allow commas with newline character after in var delarations', function() {
+        expect(checker.checkString('var a,\nb,\nc;')).to.have.no.errors();
+    });
 
-        expect(checker.checkString('[a,b,c]')).to.have.no.errors();
+    it('does not allow spaces after commas in arrays', function() {
+        expect(checker.checkString('[a, b]')).to.have.one.validation.error.from('disallowSpaceAfterComma');
     });
 
-    it('does allow commas with spaces before', function() {
-        checker.configure({ disallowSpaceAfterComma: true });
+    it('does not allow tabs after commas in arrays', function() {
+        expect(checker.checkString('[a,\tb]')).to.have.one.validation.error.from('disallowSpaceAfterComma');
+    });
 
-        expect(checker.checkString('[a ,b ,c]')).to.have.no.errors();
+    it('does allow commas with no spaces in arrays', function() {
+        expect(checker.checkString('[a,b,c]')).to.have.no.errors();
     });
 
-    it('does allow commas with newline character after', function() {
-        checker.configure({ disallowSpaceAfterComma: true });
+    it('does allow commas with spaces before in arrays', function() {
+        expect(checker.checkString('[a ,b ,c]')).to.have.no.errors();
+    });
 
+    it('does allow commas with newline character after in arrays', function() {
         expect(checker.checkString('[a,\nb,\nc]')).to.have.no.errors();
     });
+
+    it('does allow sparse arrays', function() {
+        expect(checker.checkString('[a, , ,b,c]')).to.have.no.errors();
+    });
+
+    it('does not allow spaces after commas in objects', function() {
+        expect(checker.checkString('var a = {x: 1, y: 2};')).to.have.one.validation.error();
+    });
+
+    it('does not allow tabs after commas in objects', function() {
+        expect(checker.checkString('var a = {x: 1,\ty: 2};')).to.have.one.validation.error();
+    });
+
+    it('does allow commas with no spaces in objects', function() {
+        expect(checker.checkString('var a = {x: 1,y: 2};')).to.have.no.errors();
+    });
+
+    it('does allow commas with spaces before in objects', function() {
+        expect(checker.checkString('var a = {x: 1 ,y: 2};')).to.have.no.errors();
+    });
+
+    it('does allow commas with newline character after in objects', function() {
+        expect(checker.checkString('var a = {x: 1,\ny: 2,\nz: 3};')).to.have.no.errors();
+    });
+
 });

test/specs/rules/disallow-space-before-binary-operators.js

@@ -101,6 +101,11 @@ describe('rules/disallow-space-before-binary-operators', function() {
         expect(checker.checkString('var x = [1, 2]\n  , y = 32')).to.have.no.errors();
     });
 
+    it('should not report error for sparse arrays', function() {
+        checker.configure({ disallowSpaceBeforeBinaryOperators: [','] });
+        expect(checker.checkString('var x = [1, , , 2], y = 32')).to.have.no.errors();
+    });
+
     it('should not report error if a comment is ahead of the comma', function() {
         checker.configure({ disallowSpaceBeforeBinaryOperators: [','] });
         expect(checker.checkString('var x = [1, 2] /* test*/, y = 32')).to.have.no.errors();

test/specs/rules/disallow-space-before-comma.js

@@ -7,35 +7,71 @@ describe('rules/disallow-space-before-comma', function() {
     beforeEach(function() {
         checker = new Checker();
         checker.registerDefaultRules();
-    });
-
-    it('does not allow spaces before commas', function() {
         checker.configure({ disallowSpaceBeforeComma: true });
+    });
 
+    it('does not allow spaces before commas in var declaration', function() {
         expect(checker.checkString('var a ,b;')).to.have.one.validation.error.from('disallowSpaceBeforeComma');
     });
 
-    it('does not allow tabs before commas', function() {
-        checker.configure({ disallowSpaceBeforeComma: true });
+    it('does allow commas with spaces after in var delcaration', function() {
+        expect(checker.checkString('var a, b, c;')).to.have.no.errors();
+    });
 
+    it('does not allow tabs before commas in var declaration', function() {
         expect(checker.checkString('var a\t,b;')).to.have.one.validation.error.from('disallowSpaceBeforeComma');
     });
 
-    it('does allow commas with no spaces', function() {
-        checker.configure({ disallowSpaceBeforeComma: true });
-
+    it('does allow commas with no spaces in var declaration', function() {
         expect(checker.checkString('var a,b;')).to.have.no.errors();
     });
 
-    it('does allow commas with spaces after', function() {
-        checker.configure({ disallowSpaceBeforeComma: true });
+    it('does allow commas with newline character before in var delcaration', function() {
+        expect(checker.checkString('var a\n,b\n,c;')).to.have.no.errors();
+    });
+
+    it('does not allow spaces before commas in arrays', function() {
+        expect(checker.checkString('[a ,b]')).to.have.one.validation.error.from('disallowSpaceBeforeComma');
+    });
 
+    it('does allow commas with spaces after in arrays', function() {
         expect(checker.checkString('[a, b, c]')).to.have.no.errors();
     });
 
-    it('does allow commas with newline character before', function() {
-        checker.configure({ disallowSpaceBeforeComma: true });
+    it('does not allow tabs before commas in arrays', function() {
+        expect(checker.checkString('[a\t,b]')).to.have.one.validation.error.from('disallowSpaceBeforeComma');
+    });
+
+    it('does allow commas with no spaces in arrays', function() {
+        expect(checker.checkString('[a,b]')).to.have.no.errors();
+    });
 
+    it('does allow commas with newline character before in arrays', function() {
         expect(checker.checkString('[a\n,b\n,c]')).to.have.no.errors();
     });
+
+    it('does allow sparse arrays', function() {
+        expect(checker.checkString('[a, , , b, c]')).to.have.no.errors();
+    });
+
+    it('does not allow spaces before commas in objects', function() {
+        expect(checker.checkString('var a = {x: 1 ,y: 2};')).to.have.one.validation.error();
+    });
+
+    it('does allow commas with spaces after in objects', function() {
+        expect(checker.checkString('var a = {x: 1, y: 2};')).to.have.no.errors();
+    });
+
+    it('does not allow tabs before commas in objects', function() {
+        expect(checker.checkString('var a = {x: 1\t,y: 2};')).to.have.one.validation.error();
+    });
+
+    it('does allow commas with no spaces in objects', function() {
+        expect(checker.checkString('var a = {x: 1,y: 2};')).to.have.no.errors();
+    });
+
+    it('does allow commas with newline character before in objects', function() {
+        expect(checker.checkString('var a = {x: 1\n,y: 2\n, z: 3};')).to.have.no.errors();
+    });
+
 });

test/specs/rules/require-space-after-binary-operators.js

@@ -123,4 +123,10 @@ describe('rules/require-space-after-binary-operators', function() {
         expect(errors.explainError(error))
           .to.have.string('Operator = should not stick to following expression at input');
     });
+
+    it('should not report error for sparse arrays', function() {
+        checker.configure({ requireSpaceAfterBinaryOperators: [','] });
+        expect(checker.checkString('var x = [1, , , 2], y = 32')).to.have.no.errors();
+    });
+
 });

test/specs/rules/require-space-after-comma.js

@@ -27,6 +27,10 @@ describe('rules/require-space-after-comma', function() {
             expect(checker.checkString('var a, b;')).to.have.no.errors();
         });
 
+        it('should allow tab after comma in var declaration', function() {
+            expect(checker.checkString('var a,\tb;')).to.have.no.errors();
+        });
+
         it('should allow space after and before comma in var declaration', function() {
             expect(checker.checkString('var a , b;')).to.have.no.errors();
         });
@@ -47,6 +51,10 @@ describe('rules/require-space-after-comma', function() {
             expect(checker.checkString('var a = [1, 2, 3, 4];')).to.have.no.errors();
         });
 
+        it('should allow tab after comma in arrays', function() {
+            expect(checker.checkString('var a = [1,\t2,\t3,\t4];')).to.have.no.errors();
+        });
+
         it('should allow space after and before comma in arrays', function() {
             expect(checker.checkString('var a = [1 , 2 , 3 , 4];')).to.have.no.errors();
         });
@@ -59,6 +67,10 @@ describe('rules/require-space-after-comma', function() {
             expect(checker.checkString('var a = [1,\n2,\n3];')).to.have.no.errors();
         });
 
+        it('should allow sparse arrays', function() {
+            expect(checker.checkString('[1, , , 2, 3];')).to.have.no.errors();
+        });
+
         it('should report errors when no space is given in objects', function() {
             expect(checker.checkString('var a = {x:1,y:2,z:3};')).to.have.error.count.equal(2);
         });
@@ -75,6 +87,10 @@ describe('rules/require-space-after-comma', function() {
             expect(checker.checkString('var a = {x: 1, y: 2, z: 3};')).to.have.no.errors();
         });
 
+        it('should allow tab after comma in objects', function() {
+            expect(checker.checkString('var a = {x: 1,\ty: 2,\tz: 3};')).to.have.no.errors();
+        });
+
         it('should allow space after and before comma in objects', function() {
             expect(checker.checkString('var a = {x: 1 , y: 2 , z: 3};')).to.have.no.errors();
         });