Skip to content

Commit bb06c71

Browse files
author
Josh Goldberg
authored
Adjusted comment-format's check-space output for markers (#386)
* Adjusted comment-format's check-space output for markers * Update src/rules/converters/comment-format.ts
1 parent 64db064 commit bb06c71

File tree

2 files changed

+30
-51
lines changed

2 files changed

+30
-51
lines changed

src/rules/converters/comment-format.ts

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,8 @@ export const CapitalizedIgnoreMessage = "Only accepts a single string pattern to
99

1010
export const convertCommentFormat: RuleConverter = (tslintRule) => {
1111
const capitalizedRuleArguments: string[] = [];
12-
const spaceCommentRuleArguments: string[] = [];
1312
const capitalizedNotices: string[] = [];
14-
15-
if (!tslintRule.ruleArguments.includes("check-space")) {
16-
spaceCommentRuleArguments.push("never");
17-
}
13+
const checkSpace = tslintRule.ruleArguments.includes("check-space");
1814

1915
if (tslintRule.ruleArguments.includes("check-uppercase")) {
2016
capitalizedRuleArguments.push("always");
@@ -44,12 +40,19 @@ export const convertCommentFormat: RuleConverter = (tslintRule) => {
4440
...(capitalizedNotices.length !== 0 && { notices: capitalizedNotices }),
4541
},
4642
]),
47-
{
48-
ruleName: "spaced-comment",
49-
...(spaceCommentRuleArguments.length !== 0 && {
50-
ruleArguments: spaceCommentRuleArguments,
51-
}),
52-
},
43+
...(checkSpace
44+
? [
45+
{
46+
ruleName: "spaced-comment",
47+
ruleArguments: [
48+
"always",
49+
{
50+
markers: ["/"],
51+
},
52+
],
53+
},
54+
]
55+
: []),
5356
],
5457
};
5558
};

src/rules/converters/tests/comment-format.test.ts

Lines changed: 16 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,7 @@ describe(convertCommentFormat, () => {
77
});
88

99
expect(result).toEqual({
10-
rules: [
11-
{
12-
ruleArguments: ["never"],
13-
ruleName: "spaced-comment",
14-
},
15-
],
10+
rules: [],
1611
});
1712
});
1813

@@ -24,6 +19,12 @@ describe(convertCommentFormat, () => {
2419
expect(result).toEqual({
2520
rules: [
2621
{
22+
ruleArguments: [
23+
"always",
24+
{
25+
markers: ["/"],
26+
},
27+
],
2728
ruleName: "spaced-comment",
2829
},
2930
],
@@ -41,10 +42,6 @@ describe(convertCommentFormat, () => {
4142
ruleArguments: ["never"],
4243
ruleName: "capitalized-comments",
4344
},
44-
{
45-
ruleArguments: ["never"],
46-
ruleName: "spaced-comment",
47-
},
4845
],
4946
});
5047
});
@@ -61,10 +58,6 @@ describe(convertCommentFormat, () => {
6158
ruleArguments: ["always"],
6259
ruleName: "capitalized-comments",
6360
},
64-
{
65-
ruleArguments: ["never"],
66-
ruleName: "spaced-comment",
67-
},
6861
],
6962
});
7063
});
@@ -75,12 +68,7 @@ describe(convertCommentFormat, () => {
7568
});
7669

7770
expect(result).toEqual({
78-
rules: [
79-
{
80-
ruleArguments: ["never"],
81-
ruleName: "spaced-comment",
82-
},
83-
],
71+
rules: [],
8472
});
8573
});
8674

@@ -95,10 +83,6 @@ describe(convertCommentFormat, () => {
9583
ruleArguments: ["always"],
9684
ruleName: "capitalized-comments",
9785
},
98-
{
99-
ruleArguments: ["never"],
100-
ruleName: "spaced-comment",
101-
},
10286
],
10387
});
10488
});
@@ -109,12 +93,7 @@ describe(convertCommentFormat, () => {
10993
});
11094

11195
expect(result).toEqual({
112-
rules: [
113-
{
114-
ruleArguments: ["never"],
115-
ruleName: "spaced-comment",
116-
},
117-
],
96+
rules: [],
11897
});
11998
});
12099

@@ -130,10 +109,6 @@ describe(convertCommentFormat, () => {
130109
ruleArguments: ["always"],
131110
ruleName: "capitalized-comments",
132111
},
133-
{
134-
ruleArguments: ["never"],
135-
ruleName: "spaced-comment",
136-
},
137112
],
138113
});
139114
});
@@ -144,12 +119,7 @@ describe(convertCommentFormat, () => {
144119
});
145120

146121
expect(result).toEqual({
147-
rules: [
148-
{
149-
ruleArguments: ["never"],
150-
ruleName: "spaced-comment",
151-
},
152-
],
122+
rules: [],
153123
});
154124
});
155125

@@ -172,6 +142,12 @@ describe(convertCommentFormat, () => {
172142
ruleName: "capitalized-comments",
173143
},
174144
{
145+
ruleArguments: [
146+
"always",
147+
{
148+
markers: ["/"],
149+
},
150+
],
175151
ruleName: "spaced-comment",
176152
},
177153
],

0 commit comments

Comments
 (0)