bashlets

Build Status Read the Docs

/’baʃlɪt/

noun: A tiny piece of shell code.

Introduction

Bashlets is a new modular extensible toolbox for Bash, written in Bash.

The project is still in its early days, yet it is quite usable and the core features are already there: smart loading of modules, integration with git, partial OO support, and more.

The project has a threefold aim:

I want to stress the fact that this is not a generically-compliant POSIX shell project; on the contrary, the aim of the project is to write code that will run on (and require) Bash. As to the rest of the environment, however, the long-term goal is to get rid of dependencies on external tools as far as it is possible (or reasonable) to do so, even though at present the code does assume a reasonably standard GNU/Linux system.

Rationale

TODO

Contributing

Of course there is so much work to do, and I’d be delighted if somebody is willing to step in with code, enhancements, suggestions, and of course test cases and bug reports!

Requirements

A reasonably sane GNU environment is assumed to be at hand. More specifically, you need:

To run the test suite, you need Sam Stephenson’s Bash Automated Testing System.

To check for proper programming, you need ShellCheck.

Extension packages may have additional requirements.

Installing

$ git clone https://github.com/reale/bashlets.git
$ cd bashlets
$ make install

That’s all!

To run the test suite:

$ make test

If you want to check for proper programming:

$ make lint

Extensions

There is a growing corpus of additional packages available. To install package package just do

$ bashlets install -D package

Examples

Basic interaction

$ source bashlets core::library::interact
$ bash$$ interact say_hello

Hello, this is bashlets 1.0 speaking!

Data types: generating a random printable string of arbitrary length

$ source bashlets core::datatype::string

$ bash$$ string random 32
6J-%.v(M)`N_de&2fvdVd;yy R;FRt=[

Data types: generating and validating UUIDs

$ source bashlets core::datatype::uuid

$ bash$$ uuid random
2fc83419-df73-4cfd-bf9d-85634c8370fd

$ bash$$ uuid validate 2fc83419-df73-4cfd-bf9d-85634c8370fd || echo INVALID
$ bash$$ uuid validate 2fc83419-df73-4cfd-_f9d-85634c8370fd || echo INVALID
INVALID

Data types: comparing version strings

$ source bashlets core::datatype::semver

$ bash$$ semver sort 1.44 1.4 1.4.4 1.4.4a 1.4-1234
1.4
1.4-1234
1.4.4
1.4.4a
1.44

Cache: passing data around

$ source bashlets core::cache::fs

$ cache=$(bash$$ fs create)

$ # set key/value in a subshell...
$ ( bash$$ fs set $cache question 'To be, or not to be...' )

$ # read value in the parent shell
$ bash$$ fs get $cache question
To be, or not to be...

$ bash$$ fs destroy $cache

Character streams: converting formats without external tools

$ source bashlets core::stream::convert

$ cat << ??? | bash$$ convert unix2dos | file -
> Shall I compare thee to a summer's day?
> Thou art more lovely and more temperate.
> Rough winds do shake the darling buds of May,
> And summer's lease hath all too short a date...
> ???
/dev/stdin: ASCII text, with CRLF line terminators

Math: manipulating complex numbers

$ source bashlets core::math::icomplex

$ i=$(bash$$ icomplex create 0 1)
$ bash$$ icomplex to_real $(bash$$ icomplex square $i)
-1

User eXperience: enjoying a basic REPL cycle

$ source bashlets core::ux::repl

$ bash$$ repl start
> quit
$

Design Notes

TODO

Style Guide

TODO

Bibliography

Reference Works

Bash Hacking

Bash Criticism

Special Topics

Tools

Collections of scripts

Frameworks

Special-purpose libraries