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

Why restrict to certain tag syntax? #36

Closed agnesnutter closed 1 year ago

agnesnutter commented 2 years ago

Obviously, custom tags are a desirable feature — I see that "Add additional custom tags" is planned — but I'm a little confused as to why this tool doesn't just have tags be handled exactly the same way as ignored names/extensions? That seems to me like it would be even easier to implement.

I usually use tags at the end of a line, rather than preceding an explanation, so I'd like to be able to use tags like TODO and %% without following them with a colon.

jasonplatts commented 2 years ago

Hi @agnesnutter. Thanks for the suggestions.

Obviously, custom tags are a desirable feature — I see that "Add additional custom tags" is planned — but I'm a little confused as to why this tool doesn't just have tags be handled exactly the same way as ignored names/extensions? That seems to me like it would be even easier to implement.

I'm not quite sure I follow what you mean by "handled exactly the same way ignored names/extensions". Do you mean have the user enter their desired tags in the preferences, rather than offer a preconfigured list? If so, I don't think that would be all that user-friendly. The current tags cover a large number of scenarios.

I usually use tags at the end of a line, rather than preceding an explanation, so I'd like to be able to use tags like TODO and %% without following them with a colon.

Interesting. I agree that it would be nice to offer more customization, but unfortunately I haven't had the time to implement these features yet. I do hope to get these in the next release. In the meantime, PRs are always welcome if you or anyone else wishes to contribute.

Thanks again!

battis commented 2 years ago

+1 to this -- I had been baffled about why the plugin wasn't working for my usual:

// FIXME this is a terrible hack

...I had no idea that this was expecting a colon (never seen that, at least consciously, in any code before until I found this issue). A quick fix would probably be to include a few sample "tags" in the documentation so dummies like me know what we're aiming for:

// FIXME: this is a terrible hack
jasonplatts commented 1 year ago

Thanks @battis for the pull request. This has been added to the extension as of version 3.1.