Skip to content

Commit 46bc17b

Browse files
bouzuyaJosh Goldberg
authored andcommitted
fix comment-format (capitalized-comments) (#297)
1 parent 49c15f5 commit 46bc17b

File tree

2 files changed

+60
-16
lines changed

2 files changed

+60
-16
lines changed

src/rules/converters/comment-format.ts

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,15 @@ export const convertCommentFormat: RuleConverter = tslintRule => {
3535

3636
return {
3737
rules: [
38-
{
39-
ruleName: "capitalized-comments",
40-
...(capitalizedRuleArguments.length !== 0 && {
41-
ruleArguments: capitalizedRuleArguments,
42-
}),
43-
...(capitalizedNotices.length !== 0 && { notices: capitalizedNotices }),
44-
},
38+
...(capitalizedRuleArguments.length === 0
39+
? []
40+
: [
41+
{
42+
ruleName: "capitalized-comments",
43+
ruleArguments: capitalizedRuleArguments,
44+
...(capitalizedNotices.length !== 0 && { notices: capitalizedNotices }),
45+
},
46+
]),
4547
{
4648
ruleName: "spaced-comment",
4749
...(spaceCommentRuleArguments.length !== 0 && {

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

Lines changed: 51 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ describe(convertCommentFormat, () => {
88

99
expect(result).toEqual({
1010
rules: [
11-
{
12-
ruleName: "capitalized-comments",
13-
},
1411
{
1512
ruleArguments: ["never"],
1613
ruleName: "spaced-comment",
@@ -26,9 +23,6 @@ describe(convertCommentFormat, () => {
2623

2724
expect(result).toEqual({
2825
rules: [
29-
{
30-
ruleName: "capitalized-comments",
31-
},
3226
{
3327
ruleName: "spaced-comment",
3428
},
@@ -57,13 +51,14 @@ describe(convertCommentFormat, () => {
5751

5852
test("conversion with ignore-pattern argument", () => {
5953
const result = convertCommentFormat({
60-
ruleArguments: [{ "ignore-pattern": "STD\\w{2,3}\\b" }],
54+
ruleArguments: ["check-uppercase", { "ignore-pattern": "STD\\w{2,3}\\b" }],
6155
});
6256

6357
expect(result).toEqual({
6458
rules: [
6559
{
6660
notices: [CapitalizedIgnoreMessage],
61+
ruleArguments: ["always"],
6762
ruleName: "capitalized-comments",
6863
},
6964
{
@@ -74,14 +69,30 @@ describe(convertCommentFormat, () => {
7469
});
7570
});
7671

72+
test("conversion with ignore-pattern argument (no check-{lower,upper}case)", () => {
73+
const result = convertCommentFormat({
74+
ruleArguments: [{ "ignore-pattern": "STD\\w{2,3}\\b" }],
75+
});
76+
77+
expect(result).toEqual({
78+
rules: [
79+
{
80+
ruleArguments: ["never"],
81+
ruleName: "spaced-comment",
82+
},
83+
],
84+
});
85+
});
86+
7787
test("conversion with empty ignore-words argument", () => {
7888
const result = convertCommentFormat({
79-
ruleArguments: [{ "ignore-words": [] }],
89+
ruleArguments: ["check-uppercase", { "ignore-words": [] }],
8090
});
8191

8292
expect(result).toEqual({
8393
rules: [
8494
{
95+
ruleArguments: ["always"],
8596
ruleName: "capitalized-comments",
8697
},
8798
{
@@ -92,15 +103,31 @@ describe(convertCommentFormat, () => {
92103
});
93104
});
94105

106+
test("conversion with empty ignore-words argument (no check-{lower,upper}case)", () => {
107+
const result = convertCommentFormat({
108+
ruleArguments: [{ "ignore-words": [] }],
109+
});
110+
111+
expect(result).toEqual({
112+
rules: [
113+
{
114+
ruleArguments: ["never"],
115+
ruleName: "spaced-comment",
116+
},
117+
],
118+
});
119+
});
120+
95121
test("conversion with ignore-words argument", () => {
96122
const result = convertCommentFormat({
97-
ruleArguments: [{ "ignore-words": ["TODO", "HACK"] }],
123+
ruleArguments: ["check-uppercase", { "ignore-words": ["TODO", "HACK"] }],
98124
});
99125

100126
expect(result).toEqual({
101127
rules: [
102128
{
103129
notices: [CapitalizedIgnoreMessage],
130+
ruleArguments: ["always"],
104131
ruleName: "capitalized-comments",
105132
},
106133
{
@@ -111,6 +138,21 @@ describe(convertCommentFormat, () => {
111138
});
112139
});
113140

141+
test("conversion with ignore-words argument (no check-{lower,upper}case)", () => {
142+
const result = convertCommentFormat({
143+
ruleArguments: [{ "ignore-words": ["TODO", "HACK"] }],
144+
});
145+
146+
expect(result).toEqual({
147+
rules: [
148+
{
149+
ruleArguments: ["never"],
150+
ruleName: "spaced-comment",
151+
},
152+
],
153+
});
154+
});
155+
114156
test("conversion with all arguments", () => {
115157
const result = convertCommentFormat({
116158
ruleArguments: [

0 commit comments

Comments
 (0)