Giter Site home page Giter Site logo

bookuha / todosaurus Goto Github PK

View Code? Open in Web Editor NEW

This project forked from fornever/todosaurus

0.0 0.0 0.0 1.91 MB

IntelliJ Plaform plugin to manage TODO comments in the code.

Home Page: https://plugins.jetbrains.com/plugin/23838

License: MIT License

Kotlin 100.00%

todosaurus's Introduction

Todosaurus Status Enfer Download

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 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[#<issue-number>] 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.

Documentation

todosaurus's People

Contributors

fornever avatar dependabot[bot] avatar renovate[bot] avatar y0ung3r avatar bookuha avatar actions-user avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.