fix: don't remove comments between key and value in object-shorthand (#…

…18442) * fix: don't collapse comments in object-shorthand Fixes #18441 * add missing test * refactor * fix: recognize comments inside value node
eslint · May 16, 2024 · 5c28d9a · 5c28d9a
1 parent 62e686c
commit 5c28d9a
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/lib/rules/object-shorthand.js b/lib/rules/object-shorthand.js
@@ -484,6 +484,13 @@ module.exports = {
                         node,
                         messageId: "expectedPropertyShorthand",
                         fix(fixer) {
+
+                            // x: /* */ x
+                            // x: (/* */ x)
+                            if (sourceCode.getCommentsInside(node).length > 0) {
+                                return null;
+                            }
+
                             return fixer.replaceText(node, node.value.name);
                         }
                     });
@@ -497,6 +504,13 @@ module.exports = {
                         node,
                         messageId: "expectedPropertyShorthand",
                         fix(fixer) {
+
+                            // "x": /* */ x
+                            // "x": (/* */ x)
+                            if (sourceCode.getCommentsInside(node).length > 0) {
+                                return null;
+                            }
+
                             return fixer.replaceText(node, node.value.name);
                         }
                     });

diff --git a/tests/lib/rules/object-shorthand.js b/tests/lib/rules/object-shorthand.js
@@ -516,6 +516,36 @@ ruleTester.run("object-shorthand", rule, {
             output: null,
             errors: [METHOD_ERROR]
         },
+        {
+            code: "var x = {a: /* comment */ a}",
+            output: null,
+            errors: [PROPERTY_ERROR]
+        },
+        {
+            code: "var x = {a /* comment */: a}",
+            output: null,
+            errors: [PROPERTY_ERROR]
+        },
+        {
+            code: "var x = {a: (a /* comment */)}",
+            output: null,
+            errors: [PROPERTY_ERROR]
+        },
+        {
+            code: "var x = {'a': /* comment */ a}",
+            output: null,
+            errors: [PROPERTY_ERROR]
+        },
+        {
+            code: "var x = {'a': (a /* comment */)}",
+            output: null,
+            errors: [PROPERTY_ERROR]
+        },
+        {
+            code: "var x = {'a' /* comment */: a}",
+            output: null,
+            errors: [PROPERTY_ERROR]
+        },
         {
             code: "var x = {y: function() {}}",
             output: "var x = {y() {}}",