feat: Strip new lines and excess spaces

cartant · Mar 14, 2021 · 16d19d0 · 16d19d0
1 parent 43ad121
commit 16d19d0
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 3 deletions.
diff --git a/source/rules/no-deprecated.ts b/source/rules/no-deprecated.ts
@@ -92,10 +92,13 @@ const rule = ruleCreator({
         ) {
           return;
         }
-        const comment = getTag("deprecated", identifier, typeChecker);
-        if (comment !== undefined) {
+        const tag = getTag("deprecated", identifier, typeChecker);
+        if (tag !== undefined) {
           context.report({
-            data: { comment, name: identifier.text },
+            data: {
+              comment: tag.replace(/[\n\r\s\t]+/g, " "),
+              name: identifier.text,
+            },
             messageId: "forbidden",
             node,
           });

diff --git a/tests/rules/no-deprecated.ts b/tests/rules/no-deprecated.ts
@@ -325,5 +325,29 @@ ruleTester({ comments: true, types: true }).run("no-deprecated", rule, {
         ],
       }
     ),
+    fromFixture(
+      stripIndent`
+        // Multi-line comments
+        /**
+         * @deprecated Don't
+         * use this
+         * function
+         */
+        declare function func(): void;
+        func();
+        ~~~~ [forbidden { "comment": "Don't use this function", "name": "func" }]
+      `
+    ),
+    fromFixture(
+      stripIndent`
+        // Multi-space comments
+        /**
+         * @deprecated Don't use  this   function
+         */
+        declare function func(): void;
+        func();
+        ~~~~ [forbidden { "comment": "Don't use this function", "name": "func" }]
+      `
+    ),
   ],
 });