search

jasonplatts / nova-todo

A Panic Nova extension for todo and fixme management.
https://extensions.panic.com/extensions/jasonplatts/jasonplatts.TODO/
MIT License
29 stars 7 forks source link

Topic tag support #19

Open danpalmer opened 3 years ago

danpalmer commented 3 years ago

A pattern that we use in code on my team, and that I find very useful, is to "tag" TODOs/FIXMEs/etc with a topic. In particular this can be useful during development of a feature on a large codebase where there may be many TODOs, but you want to be able to add some and then find them again more easily as you finish up the feature. They can also be used to tag those responsible for fixing them.

These TODOs look like this:

# TODO(my-feature): Remember to change this bit

...

# TODO(danpalmer): Remove this code supporting an A/B test

It would be great if nova-todo supported this!

Currently these do not match in nova-todo at all, so they are not visible in the TODO list. I suspect a quick change could solve this issue. For further support, formatting the topic/name, or even allowing grouping/filtering by them could be helpful.

jasonplatts commented 3 years ago

Thanks for explaining Dan. I can see how this would be useful. I will try to get this functionality into an update in the near future.

SuEric commented 3 years ago

@danpalmer , @jasonplatts ,

Jus wondering...

Wouldn't this more like being able to change the settings of the extension? That way you can add any "keywords" to be taken as TODOs?

jasonplatts commented 3 years ago

That could certainly be one approach @SuEric.

If I understand correctly, another possibility would be to separate these into two distinct features. 1) The ability to add additional custom keywords in the extension settings. 2) Dynamically detect features or names that are added between parenthesis after a keyword and add/remove these from filter options. For convenience, it would also likely be possible to provide autocompletion for these in the editor itself after typing a keyword.