octoleo/telegram-bot-bash
1
1
Fork 0
mirror of https://github.com/octoleo/telegram-bot-bash.git synced 2024-11-22 15:35:09 +00:00
Code Issues Projects Releases Wiki Activity

update to to factored out info / help

Browse Source
This commit is contained in:
Kay Marquardt (Gnadelwartz) 2019-04-11 14:08:14 +02:00
parent db64978965
commit aeb9a6a749
5 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/1_firstbot.md
View File

@ -70,5 +70,5 @@ git clone --recursive https://github.com/topkecleon/telegram-bot-bash
``` ```
3. Change to directory ```telegram-bot.bash```, run ```./bashbot.sh init``` and follow the instructions. At this stage you are asked for your Bots token given by botfather. 3. Change to directory ```telegram-bot.bash```, run ```./bashbot.sh init``` and follow the instructions. At this stage you are asked for your Bots token given by botfather.
#### $$VERSION$$ v0.6-dev2-8-g649fe44 #### $$VERSION$$ v0.6-dev2-10-gdb64978

2
doc/2_usage.md
View File

@ -147,6 +147,6 @@ Allowed values: typing for text messages, upload_photo for photos, record_video
send_action "${CHAT[ID]}" "action" send_action "${CHAT[ID]}" "action"
``` ```
#### $$VERSION$$ v0.6-dev2-8-g649fe44 #### $$VERSION$$ v0.6-dev2-10-gdb64978

2
doc/3_advanced.md
View File

@ -97,5 +97,5 @@ To send stickers through an *inline query*:
answer_inline_query "$iQUERY_ID" "cached_sticker" "identifier for the sticker" answer_inline_query "$iQUERY_ID" "cached_sticker" "identifier for the sticker"
``` ```
#### $$VERSION$$ v0.6-dev2-8-g649fe44 #### $$VERSION$$ v0.6-dev2-10-gdb64978

2
doc/4_expert.md
View File

@ -102,5 +102,5 @@ An example crontab is provided in ```bashbot.cron```.
- if you run bashbot as an other user or a system service edit ```bashbot.cron``` to fit your needs and replace username```nobody``` with the username you want to run bashbot. copy the modified file to ```/etc/cron.d/bashbot``` - if you run bashbot as an other user or a system service edit ```bashbot.cron``` to fit your needs and replace username```nobody``` with the username you want to run bashbot. copy the modified file to ```/etc/cron.d/bashbot```
#### $$VERSION$$ v0.6-dev2-8-g649fe44 #### $$VERSION$$ v0.6-dev2-10-gdb64978

25
doc/5_practice.md
View File

@ -1,8 +1,8 @@
## Best Practices ## Best Practices
### Customizing commands.sh ### Customizing commands.sh
To ease Updates never change ```bashbot.sh```, all changes should be done in ```commands.sh``` .
To ease Updates never change ```bashbot.sh```, all changes should be done in ```commands.sh``` .
Insert your own Bot commands in the ```case ... esac``` block in commands.sh: Insert your own Bot commands in the ```case ... esac``` block in commands.sh:
```bash ```bash
case "$MESSAGE" in case "$MESSAGE" in
@ -13,20 +13,18 @@ Insert your own Bot commands in the ```case ... esac``` block in commands.sh:
################################################ ################################################
# DEFAULT commands start here, edit messages only # DEFAULT commands start here, edit messages only
'/info') '/info')
send_markdown_message "${CHAT[ID]}" "This is bashbot, the *Telegram* bot written entirely in *bash*." bashbot_info "${CHAT[ID]}"
;; ;;
'/start')
send_action "${CHAT[ID]}" "typing"
send_markdown_message "${CHAT[ID]}" "This is bashbot, the Telegram bot written entirely in bash."
;;
[...]
esac esac
``` ```
after editing commands.sh restart Bot. after editing commands.sh restart Bot.
### Seperate Bot logic from command ### Seperate Bot logic from command
If a Bot command needs more than 2-3 lines of code I recommend to factor it out to a bash function in a seperate file, e.g. If a Bot command needs more than 2-3 lines of code I recommend to factor it out to a bash function in a seperate file, e.g.
```mybotcommands.inc.sh``` and source the file from bashbot.sh. ```mybotcommands.inc.sh``` and source the file from bashbot.sh. ```bashbot_info and bashbot_help``` are examples how to use
bash functions to make customisation easy and keep case block small. ```process_message``` is an example for a complex
processing logic as a bash funtcion in a seperate file.
```bash ```bash
source mybotcommands.inc.sh source mybotcommands.inc.sh
@ -38,16 +36,15 @@ If a Bot command needs more than 2-3 lines of code I recommend to factor it out
################################################ ################################################
# DEFAULT commands start here, edit messages only # DEFAULT commands start here, edit messages only
'/info') '/info')
send_markdown_message "${CHAT[ID]}" "This is bashbot, the *Telegram* bot written entirely in *bash*." bashbot_info "${CHAT[ID]}"
;; ;;
'/start') '/start')
send_action "${CHAT[ID]}" "typing" send_action "${CHAT[ID]}" "typing"
send_markdown_message "${CHAT[ID]}" "This is bashbot, the Telegram bot written entirely in bash." bashbot_help "${CHAT[ID]}"
;; ;;
#[...]
esac esac
``` ```
Doing it this way keeps commands.sh small and clean, while allowing complex tasks to be done in the included function. example ```mybotcommands.inc.sh```: Example ```mybotcommands.inc.sh```:
```bash ```bash
#!/bin/bash #!/bin/bash
# #
@ -79,10 +76,10 @@ process_message() {
} }
``` ```
Doing it this way keeps commands.sh small and clean, while allowing complex tasks to be done in the included function.
### Test your Bot with shellcheck ### Test your Bot with shellcheck
Shellcheck is a static linter for shell scripts providing excellent tips and hints for shell coding pittfalls. You can [use it online](https://www.shellcheck.net/) or [install it on your system](https://github.com/koalaman/shellcheck#installing). Shellcheck is a static linter for shell scripts providing excellent tips and hints for shell coding pittfalls. You can [use it online](https://www.shellcheck.net/) or [install it on your system](https://github.com/koalaman/shellcheck#installing).
All bashbot scripts are linted by shellcheck. All bashbot scripts are linted by shellcheck.
Shellcheck examples: Shellcheck examples:
@ -114,5 +111,5 @@ In bashbot.sh line 490:
``` ```
As you can see there are only two warnings in bashbots scripts. The first is a hint you may use shell substitions instead of sed, but this is only possible for simple cases. The second warning is about an unused variable, this is true because in our examples CONTACT is not used but assigned in case you want to use it :-) As you can see there are only two warnings in bashbots scripts. The first is a hint you may use shell substitions instead of sed, but this is only possible for simple cases. The second warning is about an unused variable, this is true because in our examples CONTACT is not used but assigned in case you want to use it :-)
#### $$VERSION$$ v0.6-dev2-8-g649fe44 #### $$VERSION$$ v0.6-dev2-10-gdb64978