Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-common/bash-script-templates
(MIRRORED FROM GITLAB) Ready-to-use bash shell script templates at your fingertips!
https://github.com/the-common/bash-script-templates
bash scripting templates
Last synced: about 2 months ago
JSON representation
(MIRRORED FROM GITLAB) Ready-to-use bash shell script templates at your fingertips!
- Host: GitHub
- URL: https://github.com/the-common/bash-script-templates
- Owner: the-common
- Created: 2022-04-27T18:41:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T16:49:34.000Z (8 months ago)
- Last Synced: 2024-05-16T18:00:05.682Z (8 months ago)
- Topics: bash, scripting, templates
- Language: Shell
- Homepage: https://gitlab.com/the-common/bash-script-templates
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSES/CC-BY-SA-4.0.txt
Awesome Lists containing this project
README
# The common GNU Bash shell script templates
Ready-to-use bash shell script templates at your fingertips!
[](https://gitlab.com/the-common/bash-script-templates/-/pipelines) [](https://github.com/the-common/bash-script-templates/actions/workflows/check-potential-problems.yml) [](https://pre-commit.com/) [](https://api.reuse.software/info/gitlab.com/the-common/bash-script-templates)
## Flavors
This product provides several _flavors_ of the Bash script template to satisfy different needs:
### [BARE-MINIMUM](bare-minimum.sh)
The considered to be the bare-minimum for bash scripting:
* Shebang/Hashbang file header
* Script description and copyright declaration header
* Defensive interpreter behavior settings
### [BASIC](basic.sh)
Inherited from the [BARE-MINIMUM](#bare-minimum) flavor, but with the following additions:
* Runtime dependency detection(check whether all the required commands are available from the command search PATHs
* The following convenience variable definitions:
+ `script`: The absolute path of the shell script
+ `script_dir`: The absolute path of the directory that contains the shell script
+ `script_filename`: The full filename of the shell script
+ `script_name`: The name of the shellscript, excluding the filename suffixes
+ `script_basecommand`: The base command(without arguments) when running the script
+ `script_args`: An array containing all the command-line arguments when running the script
## [MODULAR](modular.sh)
Inherited from the [BASIC](#basic) flavor, but with the following additions:
* The introduction of the `init` function, which enables the moving of the program's main logic to the start of the script file, increases readability.
* A new `trap_err` function has being implemented to handle the ERR trap so one can immediately recognize that an error has occurred when the `errexit` interpreter behavior is triggered.
## References
* [The Common / The common GNU Bash shell script templates · GitLab](https://gitlab.com/the-common/bash-script-templates)
The project's main site
* [Issues · The Common / The common GNU Bash shell script templates · GitLab](https://gitlab.com/the-common/bash-script-templates/-/issues)
The project's issue tracker
* [the-common/bash-script-templates: (MIRRORED FROM GITLAB) Ready-to-use bash shell script templates at your fingertips!](https://github.com/the-common/bash-script-templates)
The GitHub Git repository mirror project
* [GNU Bash manual - GNU Project - Free Software Foundation](https://www.gnu.org/software/bash/manual/)
For references of the language and syntax used in the Bash scripts
## Licensing
Unless otherwise noted(individual file's header/[REUSE DEP5](.reuse/dep5)), this product is licensed under [the 4.0 International version of the Creative Commons Attribution-ShareAlike license](https://creativecommons.org/licenses/by-sa/4.0/), or any of its recent versions you would prefer, with an exception that the template is actually being used in a different kind of product(i.e. not a template), in that case feel free to use any license you prefer(an attribution to our project would be appreciated).
This work complies to the [REUSE Specification](https://reuse.software/spec/), refer [REUSE - Make licensing easy for everyone](https://reuse.software/) for info regarding the licensing of this product.