[new-rule-option] no-space-keywords for comment-format

[Shinigami92]

PR checklist

• Addresses an existing issue: [Feature Request] comment-format - no check-space on special patterns/keywords #3951
• New feature, bugfix, or enhancement
  • Includes tests
• Documentation update

Overview of change:

You can add a new object in comment-format to add some exceptions for checking special keywords that can ignore the check-space option

e.g.:

{"comment-format": [true, "check-space", {"no-space-keywords": ["TODO", "FIXME"]}]}

// some comment
//TODO: my todo

There is a check that allows an optional colon at the end of the keyword

Is there anything you'd like reviewers to focus on?

• Using of in on line 183
• Line 241 to 248

CHANGELOG.md entry:

• [new-rule-option] no-space-keywords in comment-format

[Shinigami92]

The formatting in my last push was prettier #4012

[JoshuaKGoldberg]

Seems generally good. Needs documentation on the new option, and I think the hardcoded : should be removed.

[Shinigami92]

Will look into the conflict in the next few days

[JoshuaKGoldberg]

Hmm, looks like the changes in this PR are actually already resolved by the ignore-pattern option in #3583. There are some pretty substantial merge conflicts here that are otherwise nontrivial to resolve as well. Closing this PR for housekeeping.

Please comment here or in #3951 if you think that's a mistake and you'd like this PR to be re-opened!

[Shinigami92]

I'm with your desicion.