mirror of https://github.com/kvz/bash3boilerplate.git synced 2024-12-18 22:27:51 +00:00

Templates to write better Bash scripts

Go to file

Kevin van Zonneveld df0ad9fe25 Merge pull request #2 from jokajak/patch-1 Update main.sh		2015-02-20 07:40:30 +01:00
src	Add ini_val, megamount, parse_url	2014-11-04 13:19:50 +01:00
.gitignore	Use npm for distribution	2014-11-04 12:59:22 +01:00
LICENSE	Add License	2014-07-23 11:27:35 +02:00
main.sh	Update main.sh	2015-02-19 19:51:00 -05:00
Makefile	Use npm for distribution	2014-11-04 12:59:22 +01:00
package.json	Update package.json	2014-11-04 14:55:37 +01:00
README.md	Update README.md	2014-11-04 15:23:05 +01:00

README.md

bash3boilerplate

When hacking up BASH scripts, I often find there are some higherlevel things like logging, configuration, commandline argument parsing that:

I need everytime
Take quite some effort to get right
Keep you from your actual work

Here's an attempt to bundle those things in a generalized way so that they are reusable as-is in most of my (and hopefully your, if not ping me) programs.

An up to date intro is found on my blog.

Installation

There are 3 ways you can install (parts of) b3bp:

Just get the main template: wget https://raw.githubusercontent.com/kvz/bash3boilerplate/master/main.sh
Clone the entire project: git clone git@github.com:kvz/bash3boilerplate.git
As of v1.0.3, b3bp can be installed as a package.json dependency via: npm install --save bash3boilerplate

Although 3 introduces a node.js dependency, this does allow for easy version pinning & distrubtions in environments that already have this prerequisite. But nothing prevents you from just using curl and keep your project or build system low on external dependencies.

Versioning

This project implements the Semantic Versioning guidelines.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

Breaking backward compatibility bumps the major (and resets the minor and patch)
New additions without breaking backward compatibility bumps the minor (and resets the patch)
Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit http://semver.org.

Best practices

As of v1.0.3, b3bp adds some nice re-usable libraries in ./src. Later on we'll be using snippets inside this directory to build custom packages. In order to make the snippets in ./src more useful, we recommend these guidelines.

Library exports

It's nice to have a bash package that can be used in the terminal and also be invoked as a command line function. To achieve this the exporting of your functionality should follow this pattern:

if [ "${BASH_SOURCE[0]}" != ${0} ]; then
  export -f my_script
else
  my_script "${@}"
  exit $?
fi

This allows a user to source your script or invoke as a script.

# Running as a script
$ ./my_script.sh some args --blah
# Sourcing the script
$ source my_script.sh
$ my_script some more args --blah

(taken from the bpkg project)

Todo

Make src libs adhere to Best practices
make build system for generating custom builds
tests & releases via Travis