jriou/flexassistant
Archived
1
0
Fork 0
Code Issues Pull requests Activity

feat: Add notification templates (#2)

Browse source 
Signed-off-by: Julien Riou <julien@riou.xyz>
This commit is contained in:
Julien Riou 2021-10-13 14:38:31 +02:00
commit 632da28954
No known key found for this signature in database
GPG key ID: FF42D23B580C89F7
11 changed files with 154 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -78,6 +78,33 @@ Reference:
* `token`: token of the Telegram bot
* `chat-id` (optional if `channel-name` is present): chat identifier to send Telegram notifications
* `channel-name` (optional if `chat-id` is present): channel name to send Telegram notifications
* `notification-templates` (optional): path to [template](https://pkg.go.dev/text/template) files for each notification type
* `balance` (optional): path to template file to format balance notifications
* `payment` (optional): path to template file to format payment notifications
* `block` (optional): path to template file to format block notifications
* `offline-worker` (optional): path to template file to format offline worker notifications
## Templating
Notifications can be customized with [templating](https://pkg.go.dev/text/template).
The following **functions** are available to templates:
* `upper(str string)`: convert string to upper case
* `lower(str string)`: convert string to lower case
* `convertCurrency(coin string, value int64)`: convert the smallest unit of a coin to a human readable unit
* `convertAction(coin string)`: return "Farmed" word for Chia coin or "Mined" for other coins
* `formatBlockURL(coin string, hash string)`: return the URL on the explorer website of the coin of the block identified by its hash
* `formatTransactionURL(coin string, hash string)`: return the URL on the explorer website of the coin of the transaction identified by its hash
The following **data** is available to templates:
* balance: `.Miner`
* payment: `.Miner`, `.Payment`
* block: `.Pool`, `.Block`
* offline-worker: `.Worker`
Default templates are available in the [templates](templates) directory.
Custom template files can be used with the `notification-templates` settings (see _Configuration_ section).
## Usage