Fix regex tests and decide on final regex specification

todos-in / todohub

Github action to automatically create issues from TODOs in code

MIT License

2 stars 0 forks source link

Fix regex tests and decide on final regex specification #76

Open nigeisel opened 6 months ago

nigeisel commented 6 months ago

use same regex in eslint rules, vs code extensions, app and action
- publish as library?

github-actions[bot] commented 5 months ago

TODO

[ ] src/util/todo-match.ts:3: TODO #⁠76 refine regex (make simpler?) ^link

_{Tracked Branch: refs/heads/main | Tracked commit: 53f435447bd3125cf7f683ce47e73bb54365d587}

martin-lysk commented 5 months ago

I would also make the regex a bit sharper - todo comments are expected to be upper case `TODO, followed by a non alphabetic character:

Matching

// TODO 
// TODO(
// TODO@
// TODO:

Not matching

// TODOs
Todo

This would already eliminate all false positive todos found for this project - the only one not working would be: "https://github.com/todos-in/todohub/issues/105"

nigeisel commented 5 months ago

Not sure I agree with the Upper case. Maybe we should collect a little sample set of TODOs in some bigger OS repos to get an understanding how people usually write TODOs? I could imagine we would miss quite a lot of TODOs by enforcing upper case

Could also be helpful to better understand how and when Devs use todos

todos-in / todohub

Fix regex tests and decide on final regex specification #76

TODO

[ ] src/util/todo-match.ts:3: TODO #⁠76 refine regex (make simpler?) link

[ ] `src/util/todo-match.ts:3`: TODO #⁠76 refine regex (make simpler?) ^link