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

One screenshot #18

Closed Indexhibit closed 3 years ago

Indexhibit commented 3 years ago

One screenshot, at least, showing how this actually works, would be nice.

Vaska commented 3 years ago

Also very dumb of me that I was logged in on the wrong account. ;)

jasonplatts commented 3 years ago

Hi @Vaska. Thank you for your suggestion. I will keep this in mind when I publish the next update. Is there anything in particular you find needs explanation?

Vaska commented 3 years ago

Perhaps, I'm being daft, but for the life of me I can't figure out how to use your extension. Is there a context-menu interface, is there something in the pull-down menus, are their special tags, I don't know. I've tried adding a TODO in code comments - but nothing works. I'd love to use this...

jasonplatts commented 3 years ago

I don't think you're being daft at all. The extension is available as a Nova sidebar, which I didn't find intuitive initially.

Firstly, if the sidebar isn't open in the editor itself, it can be opened by clicking the "Show Sidebar" button within the "View" menu. Once the sidebar is visible, the animated gif below shows how the TODO sidebar can be accessed and added to the sidebar toolbar.

Nova TODO Add Sidebar

Keep in mind the extension will not work if you are working with a remote project, but it should otherwise work without any configuration. If you still have trouble, let me know.

Vaska commented 3 years ago

I knew how to find that part already - it simply will not display my TODO's, etc. I see a .nova folder in your files - is that something that should be there?

jasonplatts commented 3 years ago

Hmm…

No, it is not necessary to have the .nova directory in the project in order to detect "TODO" and "FIXME" tags.

Could you provide some information about your workspace?

  1. What type of files contain the tags? php, js, etc.
  2. Are you working on a project that is saved locally on your computer?
  3. Can you give me an example of how you are formatting your tags within your code? If you could include an entire line of code that contains a tag, that would be really helpful.
Vaska commented 3 years ago
  1. php
  2. Yes
  3. # TODO this and that

I haven't changed any configuration settings. So far I've simply added some TODO's, saved the file and checked if it works. I'm not sure what more I can do. It just doesn't want to work on my setup...

jasonplatts commented 3 years ago

Try formatting your tags by ending them with a colon, or surrounding them in square brackets. For example:

# TODO: This and that. or # [TODO] This and that.

I think that should do the trick!

Vaska commented 3 years ago

I had already tried TODO: Bracket also do not work.

jasonplatts commented 3 years ago

That's interesting. Sorry to hear the extension still isn't working for you. If you have the time, there are a couple of other troubleshooting steps we could try…

  1. What versions of Nova and the TODO extension are you using?
  2. If you open the extensions console ("Extensions" menu, then "Show Extensions Console"), do you see any errors?
  3. If possible, could you provide a screenshot of a sample workspace? Particularly the project directory structure, like in the animated gif I showed above.
  4. If you save a php file with a TODO tag to your desktop, close Nova completely, then drag and drop that same file onto the Nova app icon, does anything then appear in the TODO sidebar?
jasonplatts commented 3 years ago

Without additional information, I will close this issue. Please feel free to open another issue if there are ongoing problems with the extension.