https://github.com/bnjjj/fixme_report

Tool to automate issues creation directly from // TODO and // FIXME comments in your code
https://github.com/bnjjj/fixme_report

cli code comment fixme git-diff hacktoberfest issue parser todo tool

Last synced: 3 months ago
JSON representation

Tool to automate issues creation directly from // TODO and // FIXME comments in your code

• Host: GitHub
• URL: https://github.com/bnjjj/fixme_report
• Owner: bnjjj
• License: mit
• Created: 2020-01-25T19:04:38.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-10-28T11:29:33.000Z (about 4 years ago)
• Last Synced: 2024-05-01T15:03:34.089Z (9 months ago)
• Topics: cli, code, comment, fixme, git-diff, hacktoberfest, issue, parser, todo, tool
• Language: Rust
• Homepage:
• Size: 159 KB
• Stars: 11
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FIXME report

FIXME report is a simple tool to automate your issues creation directly from `// TODO` and `// FIXME` comments in your codebase.

Too often you write these comments and forget to delete them or take them into account for your project's next milestone. Note that you can also assign your issues to an assignee by writing a comment with the following syntax `// TODO (@bnjjj): clean this function`

At the current stage FIXME report only supports GitHub issue creation, but take a look at our [roadmap](#roadmap) to know the next platforms supported.

## Configuration

Save your configuration in a JSON file:

```json

{

    "type": "github",

    "repository": "bnjjj/fixme_report",

    "token": "PERSONAL_TOKEN_FROM_GITHUB",

    "username": "bnjjj",

    "url": "https://github.com"

}

```

You can save it into a file named `fixme_settings.json` in the same directory of your project. If you want to have it somewhere else you can use a flag to indicate the path to your configuration file as following `fixme_report -c $HOME/my_settings.json`.

## Usage

The default behavior is to read a patchset (git diff) directly from stdin. If you want to specify a `.patch` file you can do it by adding the following parameter `-f=yourFile.patch` to the CLI.

Example: create issues based on your last commit:

```bash

$ git diff HEAD^1 HEAD | fixme_report

```

The purpose is to add this CLI to your CI/CD pipeline in order to launch it on every commit merged to master.

```bash

USAGE:

    fixme_report [FLAGS] [OPTIONS]

FLAGS:

    -d, --dry-run    display issues to create without creating them

    -h, --help       Prints help information

    -V, --version    Prints version information

OPTIONS:

    -c, --config                giving configuration file, default is fixme_settings.json in the current

                                             directory

    -f, --file                         giving patchset file instead of parsing it via stdin

    -m, --fixme-template     giving template (handlebars) file for fixme cases (OPTIONAL)

    -t, --todo-template       giving template (handlebars) file for todo cases (OPTIONAL)

```

Here is an example of an issue created with [this of git diff](samples/sample_with_todo):

![example issue](example_issue.png)

+ You can also give for each kind of comment (TODO, FIXME) create a template for to create description of issue as you want. [Here is an example file](./example_todo.tmpl). You just have to use `--todo-template` and/or `--fixme-template` to use your specified file. In these templates you can access 3 different variables as `file`, `line` and `details` to have the comment details. It must be a [handlebars](https://handlebarsjs.com/) compliant template.

## Roadmap

+ Add support of Bitbucket Cloud

+ Add support of Bitbucket Server

+ Add support of Gitlab

+ Add support of Jira

+ Add more tests

+ Better lib architecture