https://github.com/aludirk/bash
A collection of handy functions for the shell script writing.
https://github.com/aludirk/bash
bash
Last synced: 2 months ago
JSON representation
A collection of handy functions for the shell script writing.
- Host: GitHub
- URL: https://github.com/aludirk/bash
- Owner: Aludirk
- License: mit
- Created: 2016-12-14T13:40:17.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-06T13:13:49.000Z (over 9 years ago)
- Last Synced: 2025-04-23T19:58:34.071Z (about 1 year ago)
- Topics: bash
- Language: Shell
- Size: 162 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# General library for Bash shell script (0.9.0)
A collection of handy functions for the shell script writing, it aims for Bash 3+.
* [Prerequisite](#prerequisite)
* [Modules](#modules)
* [Configuration](#configuration)
* [Debug mode](#debug-mode)
* [Error message colors](#error-message-colors)
* [Information message color](#information-message-color)
* [Question message color](#question-message-color)
* [Error codes](#error-codes)
* [Version History](#version-history)
## Prerequisite
Some features are based on [Perl5](https://www.perl.org) to implement (use for [PCRE](http://www.pcre.org/)).
## Modules
All modules are tested in macOS and linux.
Module | File | Description
----- | ----- | -----
[Command](doc/command.md) | [command.sh](command.sh) | Command/Function utility.
[Dictionary](doc/dictionary.md) | [dictionary.sh](dictionary.sh) | Bash dictionary.
[Environment File](doc/env.md) | [env.sh](env.sh) | Environment file reader.
[Message](doc/message.md) | [message.sh](message.sh) | Show color message in shell.
[Network](doc/network.md) | [network.sh](network.sh) | Network utility.
[String](doc/string.md) | [string.sh](string.sh) | String manipulation.
## Configuration
The following environment variables can be used to configure the behaviour of the library.
### Debug mode
Set environment variable `LIB_BASH_DEBUG` to true to show error message in `stderr` when function get error.
### Error message colors
Set environment variable `LIB_BASH_ERROR_FG` and `LIB_BASH_ERROR_BG` to change the foreground and background color respectively of error message, default is white and red, see [ANSI escape code#Colors](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors).
### Information message color
Set environment variable `LIB_BASH_INFO_COLOR` to change the color of infomration message, default is green, see [ANSI escape code#Colors](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors).
### Question message color
Set environment variable `LIB_BASH_QUESTION_COLOR` to change the color of question message, default is cyan, see [ANSI escape code#Colors](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors).
## Error codes
All functions may return the following error codes.
Code | Error
----- | -----
65 | Invalid parameters.
66 | Invalid options.
67 | No outputs.
68 | File does not exist.
69 | Internal error.
70 | Invalid regular expression.
71 | Command not found.
## Version History
### 0.9.0
* `local_ip` for getting the IPv4 IP from command `ifconfig`
* Dictionary for Bash 3.x and up.
### 0.7.0
* `select_option` to let user to choose option from given array.
### 0.6.0
* `match_string` for testing string that matches give regular expression.
* `regex_string` for finding the matched pattern and capture groups.
* `replace_string` for replacing string with regular expression.
* Fix wrong output for newline character.
* Fix wrong output for trailing newline.
* Fix wrong output for empty string input.
* Fix wrong output for UTF-8.
### 0.5.2
* `implode_string` for imploding array to string and `explode_string` for exploding string to array.
* `load_env_file` to read environment variables file.
* Add `escape_string`.
* Message module for printing colour string.
* Fix skipping the unexpected options for `get_option`.
* Fix `get_option` cannot handle special characters ‘“\$’.
* Fix cannot print colour string.
### 0.1.0
* Add `get_option` to simulate the built-in function `getopt`.