From f88b65c4d79e5e4263e54222242daa0ce3093bf3 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Tue, 14 Apr 2020 01:28:44 -0400 Subject: [PATCH 1/2] Adjusted comment-format's check-space output for markers --- src/rules/converters/comment-format.ts | 27 +++++---- .../converters/tests/comment-format.test.ts | 56 ++++++------------- 2 files changed, 31 insertions(+), 52 deletions(-) diff --git a/src/rules/converters/comment-format.ts b/src/rules/converters/comment-format.ts index 265a5fbb0..b76dba189 100644 --- a/src/rules/converters/comment-format.ts +++ b/src/rules/converters/comment-format.ts @@ -7,14 +7,10 @@ type CommentFormatOptions = { export const CapitalizedIgnoreMessage = "Only accepts a single string pattern to be ignored."; -export const convertCommentFormat: RuleConverter = tslintRule => { +export const convertCommentFormat: RuleConverter = (tslintRule) => { const capitalizedRuleArguments: string[] = []; - const spaceCommentRuleArguments: string[] = []; const capitalizedNotices: string[] = []; - - if (!tslintRule.ruleArguments.includes("check-space")) { - spaceCommentRuleArguments.push("never"); - } + const checkSpace = tslintRule.ruleArguments.includes("check-space"); if (tslintRule.ruleArguments.includes("check-uppercase")) { capitalizedRuleArguments.push("always"); @@ -44,12 +40,19 @@ export const convertCommentFormat: RuleConverter = tslintRule => { ...(capitalizedNotices.length !== 0 && { notices: capitalizedNotices }), }, ]), - { - ruleName: "spaced-comment", - ...(spaceCommentRuleArguments.length !== 0 && { - ruleArguments: spaceCommentRuleArguments, - }), - }, + ...(checkSpace + ? [ + { + ruleName: "spaced-comment", + ruleArguments: [ + "always", + { + markers: ["/"], + }, + ], + }, + ] + : []), ], }; }; diff --git a/src/rules/converters/tests/comment-format.test.ts b/src/rules/converters/tests/comment-format.test.ts index 45c4cb040..8db2a15c8 100644 --- a/src/rules/converters/tests/comment-format.test.ts +++ b/src/rules/converters/tests/comment-format.test.ts @@ -7,12 +7,7 @@ describe(convertCommentFormat, () => { }); expect(result).toEqual({ - rules: [ - { - ruleArguments: ["never"], - ruleName: "spaced-comment", - }, - ], + rules: [], }); }); @@ -24,6 +19,12 @@ describe(convertCommentFormat, () => { expect(result).toEqual({ rules: [ { + ruleArguments: [ + "always", + { + markers: ["/"], + }, + ], ruleName: "spaced-comment", }, ], @@ -41,10 +42,6 @@ describe(convertCommentFormat, () => { ruleArguments: ["never"], ruleName: "capitalized-comments", }, - { - ruleArguments: ["never"], - ruleName: "spaced-comment", - }, ], }); }); @@ -61,10 +58,6 @@ describe(convertCommentFormat, () => { ruleArguments: ["always"], ruleName: "capitalized-comments", }, - { - ruleArguments: ["never"], - ruleName: "spaced-comment", - }, ], }); }); @@ -75,12 +68,7 @@ describe(convertCommentFormat, () => { }); expect(result).toEqual({ - rules: [ - { - ruleArguments: ["never"], - ruleName: "spaced-comment", - }, - ], + rules: [], }); }); @@ -95,10 +83,6 @@ describe(convertCommentFormat, () => { ruleArguments: ["always"], ruleName: "capitalized-comments", }, - { - ruleArguments: ["never"], - ruleName: "spaced-comment", - }, ], }); }); @@ -109,12 +93,7 @@ describe(convertCommentFormat, () => { }); expect(result).toEqual({ - rules: [ - { - ruleArguments: ["never"], - ruleName: "spaced-comment", - }, - ], + rules: [], }); }); @@ -130,10 +109,6 @@ describe(convertCommentFormat, () => { ruleArguments: ["always"], ruleName: "capitalized-comments", }, - { - ruleArguments: ["never"], - ruleName: "spaced-comment", - }, ], }); }); @@ -144,12 +119,7 @@ describe(convertCommentFormat, () => { }); expect(result).toEqual({ - rules: [ - { - ruleArguments: ["never"], - ruleName: "spaced-comment", - }, - ], + rules: [], }); }); @@ -172,6 +142,12 @@ describe(convertCommentFormat, () => { ruleName: "capitalized-comments", }, { + ruleArguments: [ + "always", + { + markers: ["/"], + }, + ], ruleName: "spaced-comment", }, ], From 965eaa6535b98a0521b4d4a8ba1e1441b63d1728 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Tue, 14 Apr 2020 01:33:43 -0400 Subject: [PATCH 2/2] Update src/rules/converters/comment-format.ts --- src/rules/converters/comment-format.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/rules/converters/comment-format.ts b/src/rules/converters/comment-format.ts index b76dba189..d5d24f62f 100644 --- a/src/rules/converters/comment-format.ts +++ b/src/rules/converters/comment-format.ts @@ -7,7 +7,7 @@ type CommentFormatOptions = { export const CapitalizedIgnoreMessage = "Only accepts a single string pattern to be ignored."; -export const convertCommentFormat: RuleConverter = (tslintRule) => { +export const convertCommentFormat: RuleConverter = tslintRule => { const capitalizedRuleArguments: string[] = []; const capitalizedNotices: string[] = []; const checkSpace = tslintRule.ruleArguments.includes("check-space");