Merge pull request #4219 from eslint/issue3678

Fix: Support ES6 shorthand in key-spacing (fixes #3678)
eslint · Oct 21, 2015 · 64a8387 · 64a8387
2 parents e42bdad + 103eb95
commit 64a8387
Show file tree

Hide file tree

Showing 2 changed files with 146 additions and 3 deletions.
diff --git a/lib/rules/key-spacing.js b/lib/rules/key-spacing.js
@@ -181,9 +181,16 @@ module.exports = function(context) {
      * @returns {int} Width of the key.
      */
     function getKeyWidth(property) {
-        var key = property.key;
-        var startToken = getFirstNodeInLine(key);
-        var endToken = getFirstNodeBeforeColon(key);
+        var key, startToken, endToken;
+
+        // Ignore shorthand methods and properties, as they have no colon
+        if (property.method || property.shorthand) {
+            return 0;
+        }
+
+        key = property.key;
+        startToken = getFirstNodeInLine(key);
+        endToken = getFirstNodeBeforeColon(key);
 
         return endToken.range[1] - startToken.range[0];
     }

diff --git a/tests/lib/rules/key-spacing.js b/tests/lib/rules/key-spacing.js
@@ -215,6 +215,75 @@ ruleTester.run("key-spacing", rule, {
         ].join("\n"),
         ecmaFeatures: { modules: true, objectLiteralShorthandProperties: true },
         options: [{ "align": "value" }]
+    }, {
+        code: [
+            "var test = {",
+            "    prop: 123,",
+            "    a,",
+            "    b",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandProperties: true }
+    }, {
+        code: [
+            "var test = {",
+            "    prop: 456,",
+            "    c,",
+            "    d",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandProperties: true },
+        options: [{ "align": "value" }]
+    }, {
+        code: [
+            "var obj = {",
+            "    foobar: 123,",
+            "    prop,",
+            "    baz:    456",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandProperties: true },
+        options: [{ "align": "value" }]
+    }, {
+        code: [
+            "var test = {",
+            "    prop: 123,",
+            "    a() { }",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandMethods: true }
+    }, {
+        code: [
+            "var test = {",
+            "    prop: 123,",
+            "    a() { },",
+            "    b() { }",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandMethods: true },
+        options: [{ "align": "value" }]
+    }, {
+        code: [
+            "var obj = {",
+            "    foobar: 123,",
+            "    method() { },",
+            "    baz:    456",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandMethods: true },
+        options: [{ "align": "value" }]
+    }, {
+        code: [
+            "var obj = {",
+            "    foobar: 123,",
+            "    method() {",
+            "        return 42;",
+            "    },",
+            "    baz: 456",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandMethods: true },
+        options: [{ "align": "value" }]
     }],
 
     invalid: [{
@@ -445,5 +514,72 @@ ruleTester.run("key-spacing", rule, {
         errors: [
             { message: "Extra space before value for key \"key\".", line: 2, column: 8, type: "Identifier" }
         ]
+    }, {
+        code: [
+            "var obj = {",
+            "    foobar: 123,",
+            "    prop,",
+            "    baz: 456",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandProperties: true },
+        options: [{ "align": "value" }],
+        errors: [
+            { message: "Missing space before value for key \"baz\".", line: 4, column: 10, type: "Literal" }
+        ]
+    }, {
+        code: [
+            "var obj = {",
+            "    foobar:  123,",
+            "    prop,",
+            "    baz:    456",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandProperties: true },
+        options: [{ "align": "value" }],
+        errors: [
+            { message: "Extra space before value for key \"foobar\".", line: 2, column: 14, type: "Literal" }
+        ]
+    }, {
+        code: [
+            "var obj = {",
+            "    foobar: 123,",
+            "    method() { },",
+            "    baz: 456",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandMethods: true },
+        options: [{ "align": "value" }],
+        errors: [
+            { message: "Missing space before value for key \"baz\".", line: 4, column: 10, type: "Literal" }
+        ]
+    }, {
+        code: [
+            "var obj = {",
+            "    foobar:  123,",
+            "    method() { },",
+            "    baz:    456",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandMethods: true },
+        options: [{ "align": "value" }],
+        errors: [
+            { message: "Extra space before value for key \"foobar\".", line: 2, column: 14, type: "Literal" }
+        ]
+    }, {
+        code: [
+            "var obj = {",
+            "    foobar: 123,",
+            "    method() {",
+            "        return 42;",
+            "    },",
+            "    baz:    456",
+            "};"
+        ].join("\n"),
+        ecmaFeatures: { objectLiteralShorthandMethods: true },
+        options: [{ "align": "value" }],
+        errors: [
+            { message: "Extra space before value for key \"baz\".", line: 6, column: 13, type: "Literal" }
+        ]
     }]
 });