hans/pure-bash-bible
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update

Browse Source
This commit is contained in:
Dylan Araps
2018-06-15 11:40:50 +10:00
parent 992d8dd8c1
commit 69b9bb5924
1 changed files with 33 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@@ -19,10 +19,16 @@ tips and discovered a few while developing
[pxltrm](https://github.com/dylanaraps/pxltrm) and some other smaller [pxltrm](https://github.com/dylanaraps/pxltrm) and some other smaller
projects. projects.
This repository is open to contribution. If you see something that is The snippets below are linted using `shellcheck` and tests have been
incorrectly described, buggy or outright wrong, open an issue or send a written where applicable. If you're looking to contribute, have a read of
pull request. If you know a handy snippet that is not included in this the
list, send a pull request! [CONTRIBUTING.md](https://github.com/dylanaraps/pure-bash-bible/blob/master/CONTRIBUTING.md).
It outlines how the unit tests work and what's required when adding
snippets.
If you see something that is incorrectly described, buggy or outright
wrong, open an issue or send a pull request. If you know a handy snippet
that is not included in this list, contribute!
**NOTE**: Error handling (*checking if a file exists, etc*) is not **NOTE**: Error handling (*checking if a file exists, etc*) is not
included. These are meant to be snippets you can incorporate into your included. These are meant to be snippets you can incorporate into your
@@ -103,6 +109,11 @@ scripts and not full blown utilities.
## Trim leading and trailing white-space from string. ## Trim leading and trailing white-space from string.
This is an alternative to `sed`, `awk`, `perl` and other tools. The
function below works by finding all leading and trailing white-space and
removing it from the start and end of the string. The `:` built-in is used
in place of a temporary variable.
**Example Function:** **Example Function:**
```sh ```sh
@@ -128,6 +139,10 @@ John Black
## Trim all white-space from string and truncate spaces. ## Trim all white-space from string and truncate spaces.
This is an alternative to `sed`, `awk`, `perl` and other tools. The
function below works by abusing word splitting to create a new string
without leading/trailing white-space and with truncated spaces.
**Example Function:** **Example Function:**
```sh ```sh
@@ -154,14 +169,14 @@ John Black is my name.
## Use REGEX on a string. ## Use REGEX on a string.
We can use the result of `bash`'s regex matching to create a simple `sed` We can use the result of `bash`'s regex matching to replace `sed` for a
replacement. large number of use-cases.
**NOTE**: This is one of the few platform dependant `bash` features. **CAVEAT**: This is one of the few platform dependant `bash` features.
`bash` will use whatever regex engine is installed on the user's system. `bash` will use whatever regex engine is installed on the user's system.
Stick to POSIX regex features if aiming for compatibility. Stick to POSIX regex features if aiming for compatibility.
**NOTE**: This example only prints the first matching group. When using **CAVEAT**: This example only prints the first matching group. When using
multiple capture groups some modification will be needed. multiple capture groups some modification will be needed.
**Example Function:** **Example Function:**
@@ -210,6 +225,8 @@ is_hex_color "$color" || color="#FFFFFF"
## Split a string on a delimiter. ## Split a string on a delimiter.
This is an alternative to `cut`, `awk` and other tools.
```shell ```shell
string="1,2,3" string="1,2,3"
@@ -222,7 +239,7 @@ IFS=, read -ra vars <<< "$string"
## Change a string to lowercase. ## Change a string to lowercase.
**NOTE:** Requires `bash` 4+ **CAVEAT:** Requires `bash` 4+
**Example Function:** **Example Function:**
@@ -248,7 +265,7 @@ hello
## Change a string to uppercase. ## Change a string to uppercase.
**NOTE:** Requires `bash` 4+ **CAVEAT:** Requires `bash` 4+
**Example Function:** **Example Function:**
@@ -430,7 +447,7 @@ Create a temporary associative array. When setting associative array
values and a duplicate assignment occurs, bash overwrites the key. This values and a duplicate assignment occurs, bash overwrites the key. This
allows us to effectively remove array duplicates. allows us to effectively remove array duplicates.
**NOTE:** Requires `bash` 4+ **CAVEAT:** Requires `bash` 4+
**Example Function:** **Example Function:**
@@ -521,7 +538,7 @@ mapfile -t file_data < "file"
Alternative to the `head` command. Alternative to the `head` command.
**NOTE:** Requires `bash` 4+ **CAVEAT:** Requires `bash` 4+
**Example Function:** **Example Function:**
@@ -548,7 +565,7 @@ $ head 1 ~/.bashrc
Alternative to the `tail` command. Alternative to the `tail` command.
**NOTE:** Requires `bash` 4+ **CAVEAT:** Requires `bash` 4+
**Example Function:** **Example Function:**
@@ -575,7 +592,7 @@ $ tail 1 ~/.bashrc
Alternative to `wc -l`. Alternative to `wc -l`.
**NOTE:** Requires `bash` 4+ **CAVEAT:** Requires `bash` 4+
**Example Function:** **Example Function:**
@@ -818,7 +835,7 @@ $ get_term_size
## Get the terminal size in pixels. ## Get the terminal size in pixels.
**NOTE**: This does not work in some terminal emulators. **CAVEAT**: This does not work in some terminal emulators.
**Example Function:** **Example Function:**
@@ -1061,7 +1078,7 @@ This is an alternative to the `pwd` built-in.
Bash’s `printf` has a built-in method of getting the date which we can use Bash’s `printf` has a built-in method of getting the date which we can use
in place of the `date` command in a lot of cases. in place of the `date` command in a lot of cases.
**NOTE:** Requires `bash` 4+ **CAVEAT:** Requires `bash` 4+
**Example Function:** **Example Function:**