Incomplete attempt at @todo capitalization enforcement. #174
Conversation
|
On the d.o. issue you said
Yes I agree. If I can help with anything, let me know |
|
Thanks, can you make an issue in the Coder issue queue? Then we can track credit and work there aside from the Drupal core issue. |
| @@ -7,9 +7,9 @@ | |||
| * These are valid examples. | |||
| * | |||
| * @todo Valid. | |||
| * @todo valid with lower-case first letter | |||
| * @todo $can start with a $ | |||
There was a problem hiding this comment.
this should be valid, one could document a variable name like "@todo $entity could be NULL here, fix this later in foo_fcuntion()."
| @@ -7,9 +7,9 @@ | |||
| * These are valid examples. | |||
| * | |||
| * @todo Valid. | |||
| * @todo valid with lower-case first letter | |||
| * @todo $can start with a $ | |||
| * @todo \also with backslash | |||
There was a problem hiding this comment.
Same here, backslash should be valid. "@todo \Drupal should not be used here, implement dependency injection later".
| @@ -142,7 +142,7 @@ private function checkTodoFormat(File $phpcsFile, int $stackPtr, string $comment | |||
| (?-i) # Reset to case-sensitive | |||
| (?! # Start another non-consuming look-ahead, this time negative | |||
| @todo\s # It has to match lower-case @todo followed by one space | |||
| (?!-|:)\S # and then any non-space except "-" or ":". | |||
| (?!-|:)[A-Z] # and then any capital letter except "-" or ":". | |||
There was a problem hiding this comment.
this is tricky. We want to warn about lower case characters, but allow everything else. Even lower case characters should be allowed in some cases, for example @todo some_function() is not a good name, refactor it to a better name.
I think we have code somewhere else in Coder that checks for such things in some comment standard, we should check that.
|
Yes, in response to @klausi's points above, I think the logic could be reverted to allow |
|
I have created an issue to facilitate further discussion as requested. I tried to summarize the consensus there, but if others could chime in with their understanding of the requirements that would be great. Then I can begin working on implementing it. |
This might end up being closed.
Discussion here:
Issue: