false issue created if comment matches identifier in a substring #234
Comments
rgalonso
added a commit
to rgalonso/todo-to-issue-action
that referenced
this issue
Nov 12, 2024
…ng of TODOs Some parts of the code were using case-insensitive matches when searching for an identifier (i.e. TODO and todo would both be acceptable) whereas other parts of the code would search for a strict case-sensitive match (only TODO, not todo). This inconsistency led to many issues, among them - alstr#216 - alstr#224 - alstr#225 Further, the identifier match wasn't being done using word breaks, meaning an identifier of "FIX" would match (case-insensitively) with "suffix" or "prefix" if those words happened to appear in a comment. (See alstr#234). Issue alstr#230 was also preventing issue labels from being applied properly if the identifier case did not match exactly the canonical version. i.e. "todo" would generate an issue, but the associated labels wouldn't be applied because the exact identifier used wasn't "TODO". This commit resolves all of these issues.
rgalonso
added a commit
to rgalonso/todo-to-issue-action
that referenced
this issue
Nov 12, 2024
Earlier commit resolved issue alstr#234
rgalonso
added a commit
to rgalonso/todo-to-issue-action
that referenced
this issue
Nov 12, 2024
…ng of TODOs Some parts of the code were using case-insensitive matches when searching for an identifier (i.e. TODO and todo would both be acceptable) whereas other parts of the code would search for a strict case-sensitive match (only TODO, not todo). This inconsistency led to many issues, among them - alstr#216 - alstr#224 - alstr#225 Further, the identifier match wasn't being done using word breaks, meaning an identifier of "FIX" would match (case-insensitively) with "suffix" or "prefix" if those words happened to appear in a comment. (See alstr#234). Issue alstr#230 was also preventing issue labels from being applied properly if the identifier case did not match exactly the canonical version. i.e. "todo" would generate an issue, but the associated labels wouldn't be applied because the exact identifier used wasn't "TODO". This commit resolves all of these issues.
rgalonso
added a commit
to rgalonso/todo-to-issue-action
that referenced
this issue
Nov 12, 2024
Earlier commit resolved issue alstr#234
|
I think this stems from the earliest version of the action, which didn't support other identifiers, where I must have been like "nothing can ever feature the word todo in". 😆 |
|
Haha, yeah, I would've thought so too. Imagine my surprise when it actually happened to me: "autodocumentation". I wouldn't consider that one word, but evidently someone does because there it is in my project!
|
|
Yeah, I'm sure there are cases, word boundaries are definitely the way to go. |
|
I think the changes of v5.1.2 (and then refined in v5.1.3) have closed this. Feel free to re-open if there's a corner case I haven't considered. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The identifier matching is not done using word breaks. Rather, it looks for either a whitespace character or a colon to follow the identifier. i.e.
TODO issue_titleandTODO: issue_titlewill both match, butTODOat the end of the line will not. However, this doesn't consider the possibility that non-whitespace characters precede the identifier. In other words, this means that due to this pattern match and case-insensitivity, usingFIXas an identifier leads to the following comment being matchedThe
fixofsuffixis seen as an identifier andafter the base stringis considered the issue title.Word breaks should be used for pattern matching the identifier. i.e.
\b{identifier}\bThe text was updated successfully, but these errors were encountered: