diff --git a/src/rules/converters/comment-format.ts b/src/rules/converters/comment-format.ts index 6567555a9..265a5fbb0 100644 --- a/src/rules/converters/comment-format.ts +++ b/src/rules/converters/comment-format.ts @@ -35,13 +35,15 @@ export const convertCommentFormat: RuleConverter = tslintRule => { return { rules: [ - { - ruleName: "capitalized-comments", - ...(capitalizedRuleArguments.length !== 0 && { - ruleArguments: capitalizedRuleArguments, - }), - ...(capitalizedNotices.length !== 0 && { notices: capitalizedNotices }), - }, + ...(capitalizedRuleArguments.length === 0 + ? [] + : [ + { + ruleName: "capitalized-comments", + ruleArguments: capitalizedRuleArguments, + ...(capitalizedNotices.length !== 0 && { notices: capitalizedNotices }), + }, + ]), { ruleName: "spaced-comment", ...(spaceCommentRuleArguments.length !== 0 && { diff --git a/src/rules/converters/tests/comment-format.test.ts b/src/rules/converters/tests/comment-format.test.ts index 0ffed9f39..45c4cb040 100644 --- a/src/rules/converters/tests/comment-format.test.ts +++ b/src/rules/converters/tests/comment-format.test.ts @@ -8,9 +8,6 @@ describe(convertCommentFormat, () => { expect(result).toEqual({ rules: [ - { - ruleName: "capitalized-comments", - }, { ruleArguments: ["never"], ruleName: "spaced-comment", @@ -26,9 +23,6 @@ describe(convertCommentFormat, () => { expect(result).toEqual({ rules: [ - { - ruleName: "capitalized-comments", - }, { ruleName: "spaced-comment", }, @@ -57,13 +51,14 @@ describe(convertCommentFormat, () => { test("conversion with ignore-pattern argument", () => { const result = convertCommentFormat({ - ruleArguments: [{ "ignore-pattern": "STD\\w{2,3}\\b" }], + ruleArguments: ["check-uppercase", { "ignore-pattern": "STD\\w{2,3}\\b" }], }); expect(result).toEqual({ rules: [ { notices: [CapitalizedIgnoreMessage], + ruleArguments: ["always"], ruleName: "capitalized-comments", }, { @@ -74,14 +69,30 @@ describe(convertCommentFormat, () => { }); }); + test("conversion with ignore-pattern argument (no check-{lower,upper}case)", () => { + const result = convertCommentFormat({ + ruleArguments: [{ "ignore-pattern": "STD\\w{2,3}\\b" }], + }); + + expect(result).toEqual({ + rules: [ + { + ruleArguments: ["never"], + ruleName: "spaced-comment", + }, + ], + }); + }); + test("conversion with empty ignore-words argument", () => { const result = convertCommentFormat({ - ruleArguments: [{ "ignore-words": [] }], + ruleArguments: ["check-uppercase", { "ignore-words": [] }], }); expect(result).toEqual({ rules: [ { + ruleArguments: ["always"], ruleName: "capitalized-comments", }, { @@ -92,15 +103,31 @@ describe(convertCommentFormat, () => { }); }); + test("conversion with empty ignore-words argument (no check-{lower,upper}case)", () => { + const result = convertCommentFormat({ + ruleArguments: [{ "ignore-words": [] }], + }); + + expect(result).toEqual({ + rules: [ + { + ruleArguments: ["never"], + ruleName: "spaced-comment", + }, + ], + }); + }); + test("conversion with ignore-words argument", () => { const result = convertCommentFormat({ - ruleArguments: [{ "ignore-words": ["TODO", "HACK"] }], + ruleArguments: ["check-uppercase", { "ignore-words": ["TODO", "HACK"] }], }); expect(result).toEqual({ rules: [ { notices: [CapitalizedIgnoreMessage], + ruleArguments: ["always"], ruleName: "capitalized-comments", }, { @@ -111,6 +138,21 @@ describe(convertCommentFormat, () => { }); }); + test("conversion with ignore-words argument (no check-{lower,upper}case)", () => { + const result = convertCommentFormat({ + ruleArguments: [{ "ignore-words": ["TODO", "HACK"] }], + }); + + expect(result).toEqual({ + rules: [ + { + ruleArguments: ["never"], + ruleName: "spaced-comment", + }, + ], + }); + }); + test("conversion with all arguments", () => { const result = convertCommentFormat({ ruleArguments: [