https://github.com/torlenor/issuefer
Turns TODOs into GitHub or GitLab issues
https://github.com/torlenor/issuefer
github-issues gitlab-issues rust rust-lang todos-to-issues
Last synced: 8 months ago
JSON representation
Turns TODOs into GitHub or GitLab issues
- Host: GitHub
- URL: https://github.com/torlenor/issuefer
- Owner: torlenor
- License: mit
- Created: 2020-05-08T12:07:11.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-11-13T12:26:00.000Z (over 5 years ago)
- Last Synced: 2025-01-11T10:16:06.599Z (over 1 year ago)
- Topics: github-issues, gitlab-issues, rust, rust-lang, todos-to-issues
- Language: Rust
- Homepage:
- Size: 135 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# issuefer
## What it does
This program finds all TODOs in the source code and reports them as issues to GitHub or GitLab.
1. Write a TODO somewhere in your source code in the form
```
// TODO: Some test
```
2. Run `issuefer -r` which will present you with the opportunity to automatically create a issue out of the found TODOs.
3. Issuefer will add the assigned issue number to the TODO and will automatically create a commit (it will not automatically push, you have to do that yourself).
## How to build it
Build it in the standard Rust way with
```
cargo build --release
```
The resulting binary can be found at `target/release/issuefer`.
## Configuration
### From config file
Issuefer supports reading its configuration from `/issuefer` (preferred) or `/.issuefer`.
is defined as
|Platform | Value | Example |
| ------- | -------------------- | -------------- |
| Linux | `$HOME` | /home/alice |
| macOS | `$HOME` | /Users/Alice |
| Windows | `{FOLDERID_Profile}` | C:\Users\Alice |
is defined as
|Platform | Value | Example |
| ------- | ------------------------------------- | -------------------------------- |
| Linux | `$XDG_CONFIG_HOME` or `$HOME`/.config | /home/alice/.config |
| macOS | `$HOME`/Library/Preferences | /Users/Alice/Library/Preferences |
| Windows | `{FOLDERID_RoamingAppData}` | C:\Users\Alice\AppData\Roaming |
The config is a simple ini file in the format
```ini
[github.com]
token = github_token
[gitlab.com]
token = gitlab_token
[some.gitlab.host]
token = other_gitlab_token
[some.other.gitlab.host]
token = yet_another_gitlab_token
```
In addition you can tell issuefer to ignore file by extension in the following way:
```ini
[general]
ignored_extensions = md;png;exe
```
### From environment
If no config file can be found, issuefer tries to find its config from environment variables.
#### GitHub token
Issuefer needs a GitHub token to work. You can find out how to create [here](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
It will read the token from the environment variable `GITHUB_TOKEN`, so you can either run issuefer with
```bash
export GITHUB_TOKEN=YOUR_TOKEN /path/to/issuefer
```
or the easier way (maybe not the safest) is to add it to your ~/.profile:
```bash
echo 'export GITHUB_TOKEN="YOUR_TOKEN"' >> ~/.profile
```
You have to login again to apply that change.
#### GitLab token
Issuefer needs a GitLab token when working with a GitLab repo. Create it on your GitLab page and set it with
```bash
export GITLAB_TOKEN=YOUR_HOST:YOUR_TOKEN;ANOTHER_HOST:ANOTHER_TOKEN;GITLAB_COM_TOKEN /path/to/issuefer
```
or with
```bash
echo 'export GITLAB_TOKEN="YOUR_HOST:YOUR_TOKEN;ANOTHER_HOST:ANOTHER_TOKEN;GITLAB_COM_TOKEN"' >> ~/.profile
```
to make it permanent, as it is done for GitHub. The syntax is `host:token` and they are separated by `;`. If no host part is specified, it is assumed to be a gitlab.com token.
#### How to set environment variables on Windows with PowerShell
If you want to use issuefer on Windows and you want to use environment variables here is an example for `GITLAB_TOKEN` in PowerShell.
To set the environment variable use
```powershell
$env:GITLAB_TOKEN = 'YOUR_HOST:YOUR_TOKEN;ANOTHER_HOST:ANOTHER_TOKEN;GITLAB_COM_TOKEN'
```
or to persist it to your user profile use
```powershell
[System.Environment]::SetEnvironmentVariable('GITLAB_TOKEN', 'YOUR_HOST:YOUR_TOKEN;ANOTHER_HOST:ANOTHER_TOKEN;GITLAB_COM_TOKEN', [System.EnvironmentVariableTarget]::User)
```
## Run it
When typing
```bash
./issuefer
```
it will report the untracked TODOs and TODOs where the corresponding issue has been closed.
To actually report new TODOs type
```bash
./issuefer -r
```
and to cleanup the sources from TODOs which correspond to already closed issues type
```bash
./issuefer -c
```
## Supported TODO formats
Currently issuefer only supports TODOs in the format
```CPP
// TODO: some text
```
and they have the stand in a separate line (with optional whitespaces/tabs in front).
In the future we will hopefully support also C like comments (`/* */`) and multi line TODOs (which will then add the additional lines as body to the issue).