bargs

What's Changed

• Fix calling with only flag argument yielidng "Empty argument" by @J-MR-T in https://github.com/unfor19/bargs/pull/36

New Contributors

• @J-MR-T made their first contribution in https://github.com/unfor19/bargs/pull/36

Full Changelog: https://github.com/unfor19/bargs/compare/v.1.1.4...v1.1.5

• Using recommended bash shebang
• Updated Dockerfile.example alpine version from 3.12 to 3.14
• Updated docs for easy copy-paste snippets of code

• Fixed breaking hidden prompts with CTRL+C

• Prettier example.sh, making it more readable

• Fixed getting the proper env var if already exists, for example, the following caused age to be empty

  GPG_AGENT_INFO=/run/user/1000/gnupg/S.gpg-agent:0:1 # agent contains "age"
  ...
  age=33
  

• Support CTRL+C to terminate

• [ADDED] Flexible Assignment enables passing arguments with the equal sign or a whitespace

example.sh --name "Willy Wonka"
example.sh --name="Willy Wonka"

• [ADDED] Reference to a specific bargs_vars file by setting the environment variable BARGS_VARS_PATH

In your application example.sh

export BARGS_VARS_PATH="$bargs_vars_path"
source "${PWD}"/"$(dirname ${BASH_SOURCE[0]})"/bargs.sh "$@"

This feature enables having a single bargs.sh file, with multiple bargs_vars in the same repository. It's now possible to embed bargs in multiple Bash scripts that reside in the same repository.

Version bumped from v1.0.14 to v1.1.0 🎉

• [BUGFIX] Environment variables are used only if not empty, otherwise, fallback to default

• [ADDED] Fallback to environment variables with allow_env_var=true

• [ADDED] Shellcheck on creating pull-requests
• [MODIFIED] Reorganized code to run in functions, this helps to avoid polluting the global scope

• [MODIFIED] Minor cleanup thanks to @toazd

• [ADDED] Definition flag=true, when using it, the value of the argument will be set to true

• [ADDED] Providing empty values is now possible! allow_empty=true
• [ADDED] Prompting for arguments is available! prompt=true, hidden=true and confirmation=true

Minor updates in pipeline

• Variables names are also exported as UPPERCASED, for example person_name is also available as PERSON_NAME
• Added update_testresults.sh script which updates the README.md file according to the results of tests.sh

• Whitespaces are supported for the default definitions in bargs_vargs; updated the docs and examples accordingly

• [MODIFIED] Previously, it was possible to use bargs only if you run your application from the same PWD. Now it's possible to use bargs, and execute your application from any directory
• [MODIFIED] Wording in README.md and updated examples according to test output
• [ADDED] Test for checking that bargs_vars is in the same folder as bargs.sh

• [ADDED] tests.sh - Function log_msg to avoid hardcoding the message
• [ADDED] tests.sh - Test for help message flag -h
• [MODIFIED] bargs.sh - Removed the exit command from usage function; makes it possible to be used in the -h case
• [FIXED] bargs.sh - Unknown Argument printed [ERROR] [ERROR]instead of printing[ERROR]` once

You can now define options, the values of options must be separated with a whitespace

bargs_vars snippet

---
name=gender
short=g
description='male or female?'
options=male female
---

Again, thanks to the community feedback, removed the use of eval when it's not absolutely necessary.

As part of the community feedback, you can now use quotes, " and ' in the bargs_vars file.

Even though it's not really necessary, it can lead to weird behavior to add quotes prior to this release.