Skip to content

Fix comment-format (capitalized-comments) #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 22, 2019
Merged

Fix comment-format (capitalized-comments) #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions src/rules/converters/comment-format.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 && {
Expand Down
60 changes: 51 additions & 9 deletions src/rules/converters/tests/comment-format.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ describe(convertCommentFormat, () => {

expect(result).toEqual({
rules: [
{
ruleName: "capitalized-comments",
},
{
ruleArguments: ["never"],
ruleName: "spaced-comment",
Expand All @@ -26,9 +23,6 @@ describe(convertCommentFormat, () => {

expect(result).toEqual({
rules: [
{
ruleName: "capitalized-comments",
},
{
ruleName: "spaced-comment",
},
Expand Down Expand Up @@ -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",
},
{
Expand All @@ -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",
},
{
Expand All @@ -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",
},
{
Expand All @@ -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: [
Expand Down