tomocafe / bash-boost Goto Github PK

bb_expect "$(bb_relpath "/foo/bar/baz" "/foo/bar")" "baz"

fatal error: expected baz got /baz

Use printf

Use official bash Docker images to run make test

See:

• https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action
• https://stackoverflow.com/a/58521709/1566525
• https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainer
• https://stackoverflow.com/questions/64364989/github-actions-how-to-run-test-inside-container
• https://github.com/DannyBen/alf/blob/master/.github/workflows/test.yml
• https://github.com/DannyBen/rush-cli/blob/master/.github/workflows/test.yml

Currently returns after left side if right under

What constitutes a patch, minor, or major release.

Breaking changes or deprecation can only occur in major releases. Add latest link for each major release.

Already done for global opts, replicate for cli/arg (program opts)

Push, pop, and swap file extensions

Style, philosophy, logistics...

Camel to snake, capitalize sentence, etc.

For example, if bb_getx() prints the result to stdout, have bb_getx-v() yield the same result in the variable $BB_RESULT.

my_x="$(bb_getx)"
bb_getx-v
my_x2="$BB_RESULT"
bb_expect "$my_x" "$my_x2" # should be same

Supported in manual, Markdown and man page

For functions that do not add any functionality, but make using existing functionality more human-readable, less terse.

Example: bb_expressive_is_directory instead of test -d

Create tarball for uploading

Replace symbolic link with deep copy

Cleanup is at end of function, but there are conditions where we return early.

Use ${!varname} where varname=foo to get $foo.

Write window/tab title before returning if only left-hand prompt

Should handle the whole boilerplate:

bb_parseargs "$@"
set -- "${BB_POSARGS[@]}"
unset BB_POSARGS

Date and time utilities leveraging builtin printf interface to strftime.

Use _bb_result to print result of function to stdout.

getinput to poll for input, optional validation function
yn to ask yes/no

bb_unpack LISTVAR var1 var2 ...

would set var1=${LISTVAR[0]}, etc.

Stop assigning once the list is empty.

If called twice in a script, don't use previous map values, etc.

Spawn a new terminal instance inheriting the current shell's environment.

Now done on each check in as part of CI/CD 🎉

Use ^ to denote rounding up to the nearest, e.g. +0d^ means the upcoming 00:00, +1h^ at 06:30 means 08:00, -1h^ at 06:30 means 06:00, etc.

^d, ^h can be shorthand for +0d^, +0h^ (etc.)

see dependency list

• Public function : bb_ (e.g. bb_load)
• Public variable : BB_ (e.g. BB_ROOT)
• Internal function: _bb_ (e.g. _bb_on_first_load)
• Internal variable: __bb_ (e.g. __bb_true)

If you type bb<TAB>, we don't want it to show a bunch of internal functions that aren't useful to an end user. For example, bb_on_first_load

Allow customization of color, basic output format

Make sure no collision with function names between modules, packages, etc.

sort [SORT_OPTS --] ITEMS ...

Uses GNU coreutils sort with SORT_OPTS passed directly to sort.

If -- is omitted, sort is invoked without options (default).

Where should the scripts live in a distribution. /etc?

bb_requiredarg NAME DESCRIPTION

Retrieve with bb_getopt by name.

Issue bb_errusage during bb_parseargs if required arguments are unset.

Also should clarify in docs what keys are supported

Remove all variables, functions, etc.

Similar to bb_processargs

All of the information in the function contract (can be auto-extracted) plus more detailed explanation, examples, notes.

Display all terminal colors

Use alias for return, which returns in normal mode but does nothing in standalone mode.