Add reportUnusedDisableDirectives option to svelte/comment-directive rule (#171)

Author: ota-meshi

docs/rules/comment-directive.md

@@ -64,7 +64,41 @@ The `eslint-disable`-like comments can include descriptions to explain why the c
 
 ## :wrench: Options
 
-Nothing.
+```json
+{
+  "svelte/comment-directive": [
+    "error",
+    {
+      "reportUnusedDisableDirectives": false
+    }
+  ]
+}
+```
+
+- `reportUnusedDisableDirectives` ... If `true`, to report unused `eslint-disable` HTML comments. default `false`
+
+### `{ "reportUnusedDisableDirectives": true }`
+
+<ESLintCodeBlock>
+
+<!--eslint-skip-->
+
+```svelte
+<script>
+  /* eslint svelte/comment-directive: ["error", { "reportUnusedDisableDirectives": true }], no-undef: "error" */
+  import DefinedComponent from "./DefinedComponent.svelte"
+</script>
+
+<!-- ✓ GOOD -->
+<!-- eslint-disable-next-line no-undef -->
+<UndefComponent />
+
+<!-- ✗ BAD -->
+<!-- eslint-disable-next-line no-undef -->
+<DefinedComponent />
+```
+
+</ESLintCodeBlock>
 
 ## :books: Further Reading
 

src/rules/comment-directive.ts

@@ -44,7 +44,14 @@ export default createRule("comment-directive", {
         additionalProperties: false,
       },
     ],
-    messages: {},
+    messages: {
+      unused: "Unused {{kind}} directive (no problems were reported).",
+      unusedRule:
+        "Unused {{kind}} directive (no problems were reported from '{{rule}}').",
+      unusedEnable: "Unused {{kind}} directive (reporting is not suppressed).",
+      unusedEnableRule:
+        "Unused {{kind}} directive (reporting from '{{rule}}' is not suppressed).",
+    },
     type: "problem",
   },
   create(context) {
@@ -121,7 +128,7 @@ export default createRule("comment-directive", {
                   data: { rule: rule.ruleId, kind: parsed.type },
                 })
               }
-              directives.disableBlock(comment.loc.start, rule.ruleId, {
+              directives.disableBlock(comment.loc.end, rule.ruleId, {
                 loc: rule.loc.start,
               })
             }
@@ -133,7 +140,7 @@ export default createRule("comment-directive", {
                 data: { kind: parsed.type },
               })
             }
-            directives.disableBlock(comment.loc.start, ALL_RULES, {
+            directives.disableBlock(comment.loc.end, ALL_RULES, {
               loc: comment.loc.start,
             })
           }
@@ -143,7 +150,7 @@ export default createRule("comment-directive", {
               if (reportUnusedDisableDirectives) {
                 context.report({
                   loc: rule.loc,
-                  messageId: "unusedRule",
+                  messageId: "unusedEnableRule",
                   data: { rule: rule.ruleId, kind: parsed.type },
                 })
               }
@@ -155,7 +162,7 @@ export default createRule("comment-directive", {
             if (reportUnusedDisableDirectives) {
               context.report({
                 loc: comment.loc,
-                messageId: "unused",
+                messageId: "unusedEnable",
                 data: { kind: parsed.type },
               })
             }