Feature Request: TODO Output


#1

Ok, I’m sorry if anyone thinks this is a stupid idea. I personally would love to see this.

I would like Hugo to create a todo.txt (or any extension you like) with a list of the TODO’s for the project.

For example.

On page-one.md I have:

# TODO: Add picture
# TODO: Create Links to new section...

and page-two.md I have:

# TODO: include references

when Hugo renders the site, it would get all the todo’s in the files and add them to one file (todo.txt), so the output would be something like:

page-one.md ['Add picture', 'Create Links to new section...']
page-two.md ['include references']

What do you guys thinks? Good idea? Possible to do?


#2

You can already use Hugo with GFM syntax for todos:

https://hugodocs.info/content-management/formats/#task-lists

Do you mean whether it will help you as a writer spit out individual text files? There are lots of other cool programs for this, even plain-text-based ones. You’re also talking about a utility for you as a developer rather than the user, right?

If you’re looking for this feature, you might also just look into extensions for your editor. I’m a Sublime Text user and haven’t looked into this, but I know that Webstorm and a bunch of others have this functionality. I’ve never heard of something like this in a static site generator…


#3

I never considered having an extension for my editor.

I am also a sublime text user. Here is a package I just found if this would be useful to you too:

https://packagecontrol.io/packages/TodoReview


#4

Thanks @jamesgdev I’ll definitely check this out:)


#5

I use Atom for Hugo development. It has a similar package called ‘Todo Show’ which will scour your code for 'TODO’s, 'FIXME’s, etc. and export these as a list. I have a [fairly old, but most of it still valid] post about some useful packages for Atom here.


#6

Your can create taxonomy ‘todo’ and add in front matter:

todo:
  - task1
  - task2

Hugo will generate for you list of tasks as list of terms.


#7

In case anybody wants another solution to this, I simply use a command line program called grep.

From the command line, if you run grep -r TODO . it will find everywhere where it says TODO.

I even have set up an alias for it, so after you run alias todo="grep -r TODO ." all you have to do is type todo and it will tell you where all of your TODOs are.

I like this approach because it is totally independent upon language, environment, build status, IDE or anything. It simply finds the “TODO” string in files :slight_smile: Hope this helps!


#8

todo as taxonomy also is totally independent upon language, environment, build status, IDE or anything.