Added converter for no-suspicious-comment (#1069)

* Added converter for no-suspicious-comment

* match, not ignore

Author: Josh Goldberg

src/converters/lintConfigs/rules/ruleConverters.ts

@@ -93,6 +93,7 @@ import { convertNoSparseArrays } from "./ruleConverters/no-sparse-arrays";
 import { convertNoStringLiteral } from "./ruleConverters/no-string-literal";
 import { convertNoStringThrow } from "./ruleConverters/no-string-throw";
 import { convertNoSubmoduleImports } from "./ruleConverters/no-submodule-imports";
+import { convertNoSuspiciousComment } from "./ruleConverters/no-suspicious-comment";
 import { convertNoSwitchCaseFallThrough } from "./ruleConverters/no-switch-case-fall-through";
 import { convertNoThisAssignment } from "./ruleConverters/no-this-assignment";
 import { convertNoTrailingWhitespace } from "./ruleConverters/no-trailing-whitespace";
@@ -361,6 +362,7 @@ export const ruleConverters = new Map([
     ["no-string-literal", convertNoStringLiteral],
     ["no-string-throw", convertNoStringThrow],
     ["no-submodule-imports", convertNoSubmoduleImports],
+    ["no-suspicious-comment", convertNoSuspiciousComment],
     ["no-switch-case-fall-through", convertNoSwitchCaseFallThrough],
     ["no-this-assignment", convertNoThisAssignment],
     ["no-trailing-whitespace", convertNoTrailingWhitespace],

src/converters/lintConfigs/rules/ruleConverters/no-suspicious-comment.ts

@@ -0,0 +1,20 @@
+import { RuleConverter } from "../ruleConverter";
+
+export const convertNoSuspiciousComment: RuleConverter = (tslintRule) => {
+    return {
+        rules: [
+            {
+                ...(tslintRule.ruleArguments.length !== 0
+                    ? { notices: ["ESLint's no-warning-comments does not allow an array of terms to match."] }
+                    : {}),
+                ruleArguments: [
+                    {
+                        location: "anywhere",
+                        terms: ['BUG', 'HACK', 'FIXME', 'LATER', 'LATER2', 'TODO']
+                    }
+                ],
+                ruleName: "no-warning-comments",
+            },
+        ],
+    };
+};

src/converters/lintConfigs/rules/ruleConverters/tests/no-suspicious-comment.test.ts

@@ -0,0 +1,44 @@
+import { convertNoSuspiciousComment } from "../no-suspicious-comment";
+
+describe(convertNoSuspiciousComment, () => {
+    test("conversion without arguments", () => {
+        const result = convertNoSuspiciousComment({
+            ruleArguments: [],
+        });
+
+        expect(result).toEqual({
+            rules: [
+                {
+                    ruleArguments: [
+                        {
+                            location: "anywhere",
+                            terms: ['BUG', 'HACK', 'FIXME', 'LATER', 'LATER2', 'TODO']
+                        }
+                    ],
+                    ruleName: "no-warning-comments",
+                },
+            ],
+        });
+    });
+
+    test("conversion with terms argument", () => {
+        const result = convertNoSuspiciousComment({
+            ruleArguments: ["https://github.com/my-org/my-project/(.*)"],
+        });
+
+        expect(result).toEqual({
+            rules: [
+                {
+                    notices: ["ESLint's no-warning-comments does not allow an array of terms to match."],
+                    ruleArguments: [
+                        {
+                            location: "anywhere",
+                            terms: ['BUG', 'HACK', 'FIXME', 'LATER', 'LATER2', 'TODO']
+                        }
+                    ],
+                    ruleName: "no-warning-comments",
+                },
+            ],
+        });
+    });
+});