feat: suggest to add comments inside empty blocks

eslint · Jul 3, 2022 · ecc2bd2 · ecc2bd2
1 parent 9615a42
commit ecc2bd2
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 4 deletions.
diff --git a/docs/src/_data/rules.json b/docs/src/_data/rules.json
@@ -724,7 +724,7 @@
                     "description": "Disallow empty block statements",
                     "recommended": true,
                     "fixable": false,
-                    "hasSuggestions": false
+                    "hasSuggestions": true
                 },
                 {
                     "name": "no-empty-function",

diff --git a/docs/src/_data/rules_meta.json b/docs/src/_data/rules_meta.json
@@ -927,6 +927,7 @@
         "fixable": "code"
     },
     "no-empty": {
+        "hasSuggestions": true,
         "type": "suggestion",
         "docs": {
             "description": "Disallow empty block statements",

diff --git a/lib/rules/no-empty.js b/lib/rules/no-empty.js
@@ -17,6 +17,7 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        hasSuggestions: true,
         type: "suggestion",
 
         docs: {
@@ -39,7 +40,8 @@ module.exports = {
         ],
 
         messages: {
-            unexpected: "Empty {{type}} statement."
+            unexpected: "Empty {{type}} statement.",
+            suggestComment: "Add comment inside empty {{type}} statement."
         }
     },
 
@@ -52,6 +54,8 @@ module.exports = {
         return {
             BlockStatement(node) {
 
+                const range = [node.range[0] + 1, node.range[1] - 1];
+
                 // if the body is not empty, we can just return immediately
                 if (node.body.length !== 0) {
                     return;
@@ -71,13 +75,41 @@ module.exports = {
                     return;
                 }
 
-                context.report({ node, messageId: "unexpected", data: { type: "block" } });
+                context.report({
+                    node,
+                    messageId: "unexpected",
+                    data: { type: "block" },
+                    suggest: [
+                        {
+                            messageId: "suggestComment",
+                            data: { type: "block" },
+                            fix(fixer) {
+                                return fixer.replaceTextRange(range, " /* empty */ ");
+                            }
+                        }
+                    ]
+                });
             },
 
             SwitchStatement(node) {
 
+                const range = [node.range[0] + 1, node.range[1] - 1];
+
                 if (typeof node.cases === "undefined" || node.cases.length === 0) {
-                    context.report({ node, messageId: "unexpected", data: { type: "switch" } });
+                    context.report({
+                        node,
+                        messageId: "unexpected",
+                        data: { type: "switch" },
+                        suggest: [
+                            {
+                                messageId: "suggestComment",
+                                data: { type: "block" },
+                                fix(fixer) {
+                                    return fixer.replaceTextRange(range, " /* empty */ ");
+                                }
+                            }
+                        ]
+                    });
                 }
             }
         };