Skip to content

Commit

Permalink
docs: Add a description of the customize format
Browse files Browse the repository at this point in the history
  • Loading branch information
MH4GF committed Oct 23, 2023
1 parent 5c8513d commit 9db294c
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,38 @@ $ github-nippou
* [Dockerize](https://github.com/masutaka/github-nippou/pull/66) by @[masutaka](https://github.com/masutaka) **merged!**
```

## Optional: Customize Output Format

Customize the list output format as needed. Configurations are stored in a Gist.
Running `github-nippou init` creates your Gist and adds its ID to `github-nippou.settings-gist-id`.

View the default configuration [here](https://github.com/masutaka/github-nippou/blob/master/config/settings.yml).

### Available Properties

#### `format.subject`

| Property | Type | Description |
| --- | --- | --- |
| `subject` | `string` | Represents the repository name. |

#### `format.line`

| Property | Type | Description |
| --- | --- | --- |
| `user` | `string` | Displays the username who interacted with the issue or pull request. |
| `title` | `string` | Displays the title of the issue or pull request. |
| `url` | `string` | Displays the URL of the issue or pull request. |
| `status` | `string \| nil` | Displays the status, utilizing the format in `dictionary.status`. |

#### `format.dictionary.status`

| Property | Type | Description |
| --- | --- | --- |
| `closed` | `string` | Displays when the issue or pull request is closed. |
| `merged` | `string` | Displays when the pull request is merged. Applicable to pull requests only. |


## Contributing

1. Fork it ( https://github.com/masutaka/github-nippou/fork )
Expand Down

0 comments on commit 9db294c

Please sign in to comment.