Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fornever/todosaurus

IntelliJ Plaform plugin to manage TODO comments in the code.
https://github.com/fornever/todosaurus

intellij-plugin issues

Last synced: 11 days ago
JSON representation

IntelliJ Plaform plugin to manage TODO comments in the code.

Awesome Lists containing this project

README 

        



Todosaurus [![Status Enfer][status-enfer]][andivionian-status-classifier] [![Download][badge.plugin]][marketplace.plugin]

==========



**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`.



## Installation



- Using the IDE built-in plugin system:



  Settings/Preferences > Plugins > Marketplace > Search for "Todosaurus" >

  Install



- Manually:



  Download the [latest release](https://github.com/ForNeVeR/Todosaurus/releases/latest) and install it manually using

  Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...



How to Use

----------

Currently, plugin only supports one TODO pattern, namely `TODO:` (case-insensitive) that will be converted to `TODO[#]` by the plugin action.



1. 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.)_

2. Check you have a GitHub auth token registered in the **File | Settings | Version Control | GitHub**.

3. 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).

4. Open the **TODO** tool window.

5. 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).

6. Invoke the **Create Issue** action.

7. 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).

8. 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][issues].



Documentation

-------------

- [Changelog][docs.changelog]

- [Contributor Guide][docs.contributing]

- [Maintainer Guide][docs.maintainer-guide]

- [Code of Conduct (adapted from the Contributor Covenant)][docs.code-of-conduct]



License

-------

The project is distributed under the terms of [the MIT license][docs.license]

(unless a particular file states otherwise).



The license indication in the project's sources is compliant with the [REUSE specification v3.2][reuse.spec].



[andivionian-status-classifier]: https://andivionian.fornever.me/v1/#status-enfer-

[badge.plugin]: https://img.shields.io/jetbrains/plugin/v/23838.svg

[docs.changelog]: CHANGELOG.md

[docs.code-of-conduct]: CODE_OF_CONDUCT.md

[docs.contributing]: CONTRIBUTING.md

[docs.license]: LICENSE.md

[docs.maintainer-guide]: MAINTAINERSHIP.md

[issues]: https://github.com/ForNeVeR/Todosaurus/issues

[marketplace.plugin]: https://plugins.jetbrains.com/plugin/23838

[reuse.spec]: https://reuse.software/spec-3.2/

[status-enfer]: https://img.shields.io/badge/status-enfer-orange.svg