Question 1

How to set up todocheck for a private Jira instance?

Accepted Answer

Configure a .todocheck.yaml file with your Jira origin and issue tracker, then use offline or API token authentication. The first run prompts for the token, which is cached securely for future use.

Question 2

Can todocheck work with Bitbucket issues?

Accepted Answer

No, todocheck does not natively support Bitbucket; it only integrates with the listed trackers like GitHub, GitLab, and Jira, so you'd need custom development or an alternative tool.

Question 3

todocheck vs simple grep for TODO checking – what's better?

Accepted Answer

todocheck validates TODOs against open issues in trackers, ensuring traceability, while grep only finds text. Use todocheck for actionable TODOs, but it requires more setup and network access.

Question 4

How to ignore vendor directories in todocheck?

Accepted Answer

Specify ignored patterns in the .todocheck.yaml configuration under the 'ignored' section using standard pattern-matching, such as 'vendor-folder/' or '*.sh', to exclude files from scanning.

Question 5

Does todocheck support custom TODO keywords like FIXME?

Accepted Answer

Yes, you can define custom todos in the configuration (e.g., '@fix' or 'ToDo'), and it will match them in addition to the default TODO, with optional case-insensitive settings.

Question 6

What output formats does todocheck support for CI/CD?

Accepted Answer

todocheck supports standard human-readable output and JSON format via the --format json flag, which is ideal for integrating with CI pipelines or IDE plugins for automated checks.

todocheck

What is todocheck?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions