Issue-Tracker

A tool to track opened issues status for you

Overview

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.

Features

• 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.

Installation

npm install -g issue-tracker

Usage

Running the Tool

To run issue-tracker in your project, simply execute:

Usage: issue-tracker [options] <paths>

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 <string...>  Github API tokens for higher rate limit (provide multiple values to workaround the rate limit) (default: [])
  -h, --help                  display help for command

Comment Format

Add comments in your source code using the following format:

// FIXME: [Issue 1](https://github.com/angular/angular/issues/51683)
// Action: Upgrade Angular when available

or

/* TODO: [Issue 2](https://github.com/angular/angular/issues/51639) */

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)

Contributing

Contributions are welcome! If you have ideas for improvements or new features, feel free to open an issue or a merge request.

License

This project is licensed under the MIT License.

Start tracking your issues effortlessly with issue-tracker because staying informed should be simple. 🚀