Suggestions

[m29corey]

Suggestions

[staabm]

1. Make the code case-insensitive. This would include changing the pattern by adding an "i" after the closing slash, and change other string comparison sections to make the subject match case of the comparison.

I did this intentionally to reduce the performance impact of the rule. it might make sense make it configurable so people which prefer e.g. lowercase // todo can be supported

2. Add an optional "@" to the start of the pattern.
I preface my todo comments with "@" for IDE highlighting reasons.

how do your comments look like, please provde a example

3. Use named capture groups in the regular expression:

I am fine with the code as is right now

4. Make your variable interpolation consistent.

feel free to provide a PR if this is something important to you :-)

[voku]

2. Add an optional "@" to the start of the pattern.
   I preface my todo comments with "@" for IDE highlighting reasons.

I also add "@" for the same reason, it looks like this: https://www.jetbrains.com/help/phpstorm/using-todo.html#add_pattern_filter_todo

e.g. TODO@lars -> ...

[apfelbox]

I would love support for @todo, as that is the format we typically use.

[staabm]

I would love support for @todo, as that is the format we typically use.

could you give a complete example of how your comment looks like?

looks like some of you guys are talking about // @todo and some are talking about // TODO@xy

[m29corey]

Here is a couple of examples of an @todo from one of my projects:

/**
 * @todo - Convert to standard Drupal $content code.
 */
...
// @todo Decide to fix all the broken instances of class as a string

Some comments have the hyphen, some don't.

[m29corey]

I made a pull request with my suggested changes, and added in support for php doc comments.
I tested this on a large project and saw no significant performance loss compared to PHPStan not using this plugin.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.