A tool to track opened issues status for you
A tool to track opened issues status for you
---
issue-tracker is a tool designed to help developers track the status of issues referenced in their code comments. It integrates easily into your CI/CD pipeline, notifying you when a referenced issue is closed, prompting you to take necessary actions like upgrading dependencies or removing workarounds.
By scanning your source files for specially formatted comments, issue-tracker ensures that you're always up-to-date on the external issues that impact your project.
---
- Track Issue Status: Detect and monitor the status of issues linked in your source code.
- CI/CD Integration: Return an error exit code if any referenced issue is closed, making it perfect for automated workflows.
- Customizable Comment Format: Supports TODO and FIXME comment styles with issue links.
- Source-Aware: Scans source files for relevant comments to provide actionable insights.
---
``bash`
npm install -g issue-tracker
---
in your project, simply execute:`
Usage: issue-tracker [options] A tool to notify when tracking issue evolves and could be fixed in your project
Options:
-V, --version output the version number
--no-warning exit code != 0 on warnings
-a, --all Show all the issues found (default: false)
--github-token Github API tokens for higher rate limit (provide multiple values to workaround the rate limit) (default: [])
-h, --help display help for command
$3
Add comments in your source code using the following format:typescript
// FIXME: Issue 1
// Action: Upgrade Angular when available
`or
typescript
/ TODO: Issue 2 /
`The tool will parse these comments, check the status of the linked issues, and report any that have been closed.
---
Example Output
___ _ _
|_ _|___ ___ _ _ ___ | |_ _ __ __ _ ___| | _____ _ __
| |/ __/ __| | | |/ _ \ | __| '__/ _3 actions required on a total of 3 issues found:
ā angular/angular: #51616 have been closed (https://github.com/angular/angular/issues/51616)
message: Hello
ā angular/angular: #51683 have been closed (https://github.com/angular/angular/issues/51683)
action: upgrade angular when available
ā angular/angular: #51639 have been closed (https://github.com/angular/angular/issues/51639)
``
---
Contributions are welcome! If you have ideas for improvements or new features, feel free to open an issue or a merge request.
---
This project is licensed under the MIT License.
---
Start tracking your issues effortlessly with issue-tracker` because staying informed should be simple. š