todo-or-not 0.14.7

todoon integrates the TODOs in your codebase with your GitHub repository

• Quick Start
• Overview
• Example
• Workflow Inputs
• Contributing
• Help
• Fun Promo Video

Quick Start

Install the app on GitHub and use todoon in your workflows!

  - name: run-todoon
    uses: Start-Out/todo-or-not@v0.14.7           

Try it out locally! (see on PyPi)
Or, if you are using Arch Linux, there is an AUR Package maintained by @mward25.

pip install --upgrade todo-or-not
todoignore-util -pc .gitignore 
todoignore-util -ut .git
todoon

Overview

TODO or not to do, that is the question

TODO Or Not (todoon) is, in essence, a simple tool that checks your project for TODOs and FIXMEs and lets you know where they are.

You can also integrate this tool into your GitHub workflow via actions, and automate generating issues from the discovered TODOs and FIXMEs. These generated issues will include a link to the file in GitHub as well as the surrounding lines. Check out the wiki for more details on the GitHub Issues integration!

Example

Check out this example code and the issues that it yielded!

###########################
# Example usage of # todoon
###########################

def an_unfinished_function():
    # TODO Finish documenting todo-or-not
    print("Hello, I'm not quite done, there's more to do!")
    print("Look at all these things I have to do!")
    a = 1 + 1
    b = a * 2
    print("Okay I'm done!")


def a_broken_function():
    # This line might not show up in the generated issue because it's too far away
    #  from the line that triggered the issue.
    # The search for pertinent lines will stop when it hits a line break or the
    #  maximum number of lines, set by PERTINENT_LINE_LIMIT
    a = [
        1, 1, 2, 3
    ]
    b = sum(a)
    c = b * len(a)
    return c / 0  # FIXME I just don't know why this doesn't work!
    # Notice that this line will be collected

    # But this one won't, because there's some whitespace between it and the trigger!


def a_skipping_example():
    # Since the line below has `# todoon` in it, the checker will give it a pass even though it has the magic words!
    print("Sometimes you really have to write TODO or FIXME, like this!")  # todoon


def a_very_pretty_example():
    # TODO Titled Issue! | In this format, you can define a title and a body! Also labels like #example or #enhancement
    print("Check this out!")

Workflow Inputs

• region [default: "en_us"] Give an ISO code for todoon to report in your language (limited language support, see the wiki)
• issues [default: true] If true, will generate issues from TODO/FIXMEs found. Otherwise, TODO/FIXMEs will just be printed to workflow logs
• max_issues [default: 10] Maximum number of issues todoon may generate, if any more are attempted then the run will fail
• closed_issue_check [default: 0] todoon will fail if any more than the specified number of closed issues are found (set to -1 to allow any number of closed issues)
• silent [default: true] If true, todoon will NOT exit nonzero if any TODO/FIXMEs are found (good for generating issues when expected)
• verbosity [default: 2] 0. --very-quiet (none)
  1. --quiet (summary)
  2. (default)
  3. --verbose (all)
• python_version [default: "3.11.7"] Version of Python to use (defaults to 3.11.7)
• todoon_version [default: ""] Version of todoon to use ("" for the latest)

Contributing

Please target dev/contribute with your fork, and please use the appropriate PR template!

Help

See the wiki!

Fun Promo Video

https://github.com/Start-Out/todo-or-not/assets/10158233/d2c860f6-efd8-4ca4-b5d6-fcabe0bae6ce