https://github.com/moshloop/bash-plus
https://github.com/moshloop/bash-plus
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/moshloop/bash-plus
- Owner: moshloop
- Created: 2019-02-10T14:18:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-18T08:28:01.000Z (almost 7 years ago)
- Last Synced: 2024-12-28T20:26:31.030Z (over 1 year ago)
- Language: Shell
- Size: 12.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bash-plus
`bash-plus` is a preprocesser for shell scripts that provides the following:
* Argument handling using [argbash.io](https://argbash.io)
* Common utility functions.
example:
```
bash-plus script.sh > sponge script.sh
```
Bash plus will then run argbash and embed the common functions into the result.
The processing of bash-plus can be reversed using:
```bash
bash-plus script.sh clean > sponge script.sh
```
This is useful to run before commiting into git and only running compile step during build.
## Common Functions
| Function | Args | Description |
| ---------------------------- | ----- | -------------------------------------- |
| epoch | | time in milliseconds |
| stopwatch | epoch | |
| error | msg | |
| success | msg | |
| info | msg | |
| fatal | msg | Logs an error and then exits with `1` |
| logv | msg | Log only if `$debug == 'true'` |
| log | msg | Log to `stderr` with a running time |
| delete_on_exit | file | Deletes the file when the script exits |
| hr, hr1, hr2 | | Prints a horizontal rule |
| strict_mode, strict_mode_off | | Turn strict mode on or off |
| is_linux, is_mac | | |
| is_jenkins, is_travis, is_ci | | |
| | | |