Commit d7b15340 authored by Emeric Verschuur's avatar Emeric Verschuur
Browse files

Improve the help display for big size values

parent 83ec9852

CHANGELOG.md

+3 −0
Original line number Diff line number Diff line 
# Changelog



## 2.0.1

* Improve the help display for big size values



## 2.0.0

* Add version and Changelog

* Add enum type

VERSION

+1 −1
Original line number Diff line number Diff line 
2.0.0
 
2.0.1

bashopts.sh

+32 −29
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ 


set -e



BASHOPTS_VERSION=2.0.0

BASHOPTS_VERSION=2.0.1



bashopts_exit_handle() {

  local err=$?
@@ -428,20 +428,21 @@ bashopts_dump_value() { 
bashopts_diplay_help() {

    local elts optargs_max_len=8 val ncol line

    declare -A optargs

    ncol=$(tput cols || true) 2> /dev/null

    ncol=$(tput cols 2> /dev/null || true)

    ncol=${ncol:-160}

    local value_max_len=$(( $ncol / 4 ))

    # compute the good arguments comumn size

    for op in "${bashopts_optlist[@]}"; do

        elts=()

        unset val

        if ! [[ $op =~ ^__.*__$ ]] && [[ -v $op ]]; then

            val=" $(bashopts_dump_value $op)"

            val=" $(bashopts_dump_value $op | tr -d '\n')"

        fi

        if [[ -v bashopts_optprop_short_opt[$op] ]]; then elts+=("-${bashopts_optprop_short_opt[$op]}"); fi

        if [[ -v bashopts_optprop_long_opt[$op] ]]; then elts+=("--${bashopts_optprop_long_opt[$op]}"); fi

        optargs[$op]="$(bashopts_join_by , ${elts[@]})$val"

        optargs[$op]="$(bashopts_join_by , ${elts[@]})${val:0:${value_max_len}}"

        optargs_max_len=$(bashopts_math_max $optargs_max_len ${#optargs[$op]})

    done

    ncol=${ncol:-160}

    optargs_max_len=$(bashopts_math_min $optargs_max_len $(( $ncol / 3 )) )

    # display global info

    echo
@@ -454,18 +455,18 @@ bashopts_diplay_help() { 
    echo "OPTIONS:"

    for op in "${bashopts_optlist[@]}"; do

        # display arguments, value if available, description, and additional info if available

        printf "    %-${optargs_max_len}s        %s\n" "${optargs[$op]}" "${bashopts_optprop_description[$op]} $(

        printf "    %-${optargs_max_len}s    ${bashopts_optprop_description[$op]}" "${optargs[$op]}"

        if ! [[ $op =~ ^__.*__$ ]]; then

            # display additional information the each properties

            # discarding special options like --help

            echo -n " - [\$$op] (type:${bashopts_optprop_type[$op]}"

            if [[ -v bashopts_optprop_expression[$op] ]]; then

                    echo -n ", default:\"${bashopts_optprop_expression[$op]//\"/\\\"}\""

                printf ", default: \"%.${value_max_len}s\"" "$(tr -d '\n' <<< "${bashopts_optprop_expression[$op]//\"/\\\"}")"

            elif [[ -v bashopts_optprop_default[$op] ]]; then

                if [[ "${bashopts_optprop_type[$op]}" =~ ^(string|enumeration)$ ]]; then

                        echo -n ", default:\"${bashopts_optprop_default[$op]//\"/\\\"}\""

                    printf ", default: \"%.${value_max_len}s\"" "$(tr -d '\n' <<< "${bashopts_optprop_default[$op]//\"/\\\"}")"

                else

                        echo -n ", default:${bashopts_optprop_default[$op]}"

                    printf ", default: %.${value_max_len}s" "$(tr -d '\n' <<< "${bashopts_optprop_default[$op]}")"

                fi

            else

                elts=")"
@@ -477,9 +478,10 @@ bashopts_diplay_help() { 
                    done <<< "${bashopts_optprop_enum_values[$op]}"

                )"

            fi

                echo -n ")"

            echo ")"

        else

            echo ""

        fi

        )"

    done

    test "$1" != "-e" || exit $2

}
@@ -492,13 +494,14 @@ bashopts_diplay_help_delayed() { 
# display all otions values and properties

bashopts_diplay_summary() {

    local elts desc_max_len=0 val dval

    local value_max_len=$(( $ncol / 4 ))

    declare -A optargs

    for op in "${bashopts_optlist[@]}"; do

        desc_max_len=$(bashopts_math_max $desc_max_len ${#bashopts_optprop_description[$op]})

    done

    for op in "${bashopts_optlist[@]}"; do

        if ! [[ $op =~ ^__.*__$ ]]; then

            printf "* %-${desc_max_len}s : $(bashopts_dump_value $op)\n" "${bashopts_optprop_description[$op]}"

            printf "* %-${desc_max_len}.${value_max_len}s : $(bashopts_dump_value $op | tr -d '\n')\n" "${bashopts_optprop_description[$op]}"

        fi

    done

}

test.sh

+1 −1

File changed.

Contains only whitespace changes.