-
Couldn't load subscription status.
- Fork 3.8k
Using the tdc (todo‐comment) CLI
cor edited this page Sep 7, 2023
·
2 revisions
We want every // TODO comment to have an associated GitHub issue, but creating an issue can kill your flow while coding. That's why we've created the tdc CLI as part of your devShell.
It works as follows:
- Imagine you're here in your editor, and want to insert a TODO:
- Use your editors command to execute a command and insert the output. (for example: in Helix this is done by pressing
!in normal mode). Then typetdc "Your issue title":
-
tdcwill create the issue for you, and create a comment in the format ofTODO(org/repo#issue): issue title. This way it is easy to search the codebase for the line of code that inspired the issues' creation.
- The issue will be created with your specified title, you as an assignee, and a special
todo commentlabel.
- Enjoy staying in the flow without interruptions!