KingDownloads

todocheck

by presmihaylov 439 stars MITProductivity
Download

About todocheck

todocheck is a static code analyzer designed to manage annotated TODO comments in codebases. It links TODO comments to issues in supported issue trackers, ensuring they are actionable and documented. The tool checks if linked issues are open and reports errors for closed or non-existent issues, as well as unannotated TODOs.

It integrates with development workflows and CI pipelines to prevent outdated or undocumented TODOs from lingering in the code. The tool supports multiple issue trackers and programming languages, offering flexibility for different project environments.

Key features

  • Validates TODO comments by linking them to issue trackers
  • Supports multiple issue trackers including Github, Gitlab, Jira, and more
  • Reports errors for closed or non-existent linked issues
  • Flags unannotated TODOs as malformed
  • Configurable via a .todocheck.yaml file
  • Can be integrated into CI pipelines
  • Supports authentication for private repositories

Download v0.6.1

Oct 14, 2023
View all 8 versions

Frequently asked questions

Is todocheck free?
Yes. todocheck is free and open-source software, distributed under the MIT license.
Which platforms does todocheck support?
todocheck provides downloads for Windows.
What is the latest version of todocheck?
The latest version is v0.6.1, released on Oct 14, 2023.
What issue trackers does todocheck support?
todocheck supports Github, Gitlab, Jira, Pivotal Tracker, Redmine, YouTrack, and Azure Boards.
How do I install todocheck?
todocheck can be installed via homebrew, by downloading a prebuilt binary from the latest release, or by using a prebuilt container image from the GitHub container registry.
How does todocheck handle authentication for private repositories?
For private repositories, todocheck requires an API token, which can be provided via a prompt on first run or through environment variables. The token is cached for subsequent runs.
What programming languages does todocheck support?
The README does not specify supported programming languages, but it is implied that todocheck works with any language that supports TODO comments, given its static analysis nature.

More Productivity