Bash-Lib

Developed for a Bash Template (BaT)

Bash-Lib is a library of common Bash shell routines used in projects based on the A-Bash-Template (BaT) project. This library is broken into two files:

• general

  • Routines created to:

    • Check program dependencies
    • Check file dependencies
    • From a JSON configuration file, dynamically format and display a program banner, e.g.:

    |
    | A bash template (BaT) to ease argument parsing and management
    |   1.2.0
    |
    | Usage:
    |   bash_template.sh -a alpha -b bravo [-c charlie] -d delta
    |
    |   -a, --alpha    alpha (something descriptive)
    |   -b, --bravo    bravo (something descriptive)
    |   -c, --charlie  charlie (this is optional)
    |   -d, --delta    delta (something descriptive)
    |
    

• args

  • Routines created to:

    • Scan command-line arguments for accuracy and completeness
    • Parse a JSON file for program configuration details, such as the following JSON configuration file (used in the A-Bash-Template (BaT) project):

    {
      "details":
        {
          "title": "A bash template (BaT) to ease argument parsing and management",
          "syntax": "bash_template.sh -a alpha -b bravo [-c charlie] -d delta",
          "version": "1.2.0"
        },
      "arguments":
        [
          {
            "short_form": "-a",
            "long_form": "--alpha",
            "text_string": "alpha",
            "description": "alpha (something descriptive)",
            "required": true
          },
          {
            "short_form": "-b",
            "long_form": "--bravo",
            "text_string": "bravo",
            "description": "bravo (something descriptive)",
            "required": true
          },
          {
            "short_form": "-c",
            "long_form": "--charlie",
            "text_string": "charlie",
            "description": "charlie (this is optional)",
            "required": false
          },
          {
            "short_form": "-d",
            "long_form": "--delta",
            "text_string": "delta",
            "description": "delta (something descriptive)",
            "required": true
          }
        ]
    }
    

For details on how the various routines of this library project are used, see the A-Bash-Template (BaT) project.

Yes, We Are Dogfooding This Project

Of course we are! Otherwise, what value does a BaT offer if it doesn't get used often enough to warrant the time to develop a BaT?

All of our bash scripts have been written to use this project. It's cut our development time, and made it easier to provide updates and added functionality without having to spend time reinventing the wheel every time. Check out all of our projects here on Github.

This Project Uses Git Submodules

This project is managed as a Git submodule project(s) to keep projects that use this library stable while this library is periodically updated.

License

This project is distributed under the MIT License