Todosaurus is an IntelliJ plugin that helps you to manage the TODO comments. It allows quickly creating a new GitHub issue from a TODO comment, and update the comment with the issue number.
For example, if you have a comment // TODO: Fix this code in your sources, then the plugin will allow to create an issue linking the line of code including this comment, and update it to // TODO[#123]: Fix this code.
-
Using the IDE built-in plugin system:
Settings/Preferences > Plugins > Marketplace > Search for "Todosaurus" > Install
-
Manually:
Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...
Currently, plugin only supports one TODO pattern, namely TODO: (case-insensitive) that will be converted to TODO[#<issue-number>] by the plugin action.
-
Make sure you have enabled the
\btodo\b.*pattern in the Settings | Editor | TODO settings page.(It is enabled by default, so if you didn't touch these settings, then it's enabled for you.)
-
Check you have a GitHub auth token registered in the File | Settings | Version Control | GitHub.
-
Open a Git repository that's available on GitHub (currently, the plugin will auto-detect any GitHub repositories linked by either SSH or HTTPS remotes in the VCS roots of the current project).
-
Open the TODO tool window.
-
Open context menu for any TODO item that isn't yet linked to GitHub (i.e., an item like
TODO: something, with no issue number). -
Invoke the Create Issue action.
-
The dialog will ask you for
- the account you want to file the issue from,
- the repository you want to file the issue for,
- the issue title,
- the issue text (pattern
${GITHUB_CODE_URL}will be automatically replaced by the link to the line of code containing the TODO comment).
-
Click the Create Issue button. An issue will be created, you'll receive a notification, and the code will be updated to have a link to the issue.
If you have some advanced usage scenarios, do not hesitate to leave your feedback at the issue tracker.