slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Apply naming convention for function and variable name

Browse Source 
It seems to be convention to start the completion function name with an
underscore. I also prepend an underscore to the global variable.

(I still don't understand why  env  does not show this global variable
defined in the hledger-completion.bash script.)
This commit is contained in:
Jakob Schöttl 2019-01-12 13:41:53 +01:00 committed by Simon Michael
parent ae060d9f13
commit 65ec51c3d9
2 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
shell-completion/hledger-completion.bash
View File

@ -13,17 +13,17 @@ set -o pipefail
# for example grepping an array or mapping a substitution on it. # for example grepping an array or mapping a substitution on it.
# Therefore, we create temp files in RAM for completion suggestions (see below). # Therefore, we create temp files in RAM for completion suggestions (see below).
readonly HLEDGER_COMPLETION_TEMPDIR=$(mktemp -d) readonly _HLEDGER_COMPLETION_TEMPDIR=$(mktemp -d)
hledgerCompletionFunction() { _hledger_completion_function() {
#declare cmd=$1 #declare cmd=$1
declare wordToComplete=$2 declare wordToComplete=$2
declare precedingWord=$3 declare precedingWord=$3
declare subcommand declare subcommand
for subcommand in "${COMP_WORDS[@]}"; do for subcommand in "${COMP_WORDS[@]}"; do
if grep -Fxqe "$subcommand" "$HLEDGER_COMPLETION_TEMPDIR/commands.txt"; then if grep -Fxqe "$subcommand" "$_HLEDGER_COMPLETION_TEMPDIR/commands.txt"; then
COMPREPLY+=( $(grep -h "^$wordToComplete" -- "$HLEDGER_COMPLETION_TEMPDIR/options-$subcommand.txt") ) COMPREPLY+=( $(grep -h "^$wordToComplete" -- "$_HLEDGER_COMPLETION_TEMPDIR/options-$subcommand.txt") )
break break
fi fi
subcommand= subcommand=
@ -53,7 +53,7 @@ hledgerCompletionFunction() {
COMPREPLY=( "${files[@]}" ) COMPREPLY=( "${files[@]}" )
else else
COMPREPLY+=( $(grep -h "^$wordToComplete" -- "$HLEDGER_COMPLETION_TEMPDIR/commands.txt" "$HLEDGER_COMPLETION_TEMPDIR/generic-options.txt") ) COMPREPLY+=( $(grep -h "^$wordToComplete" -- "$_HLEDGER_COMPLETION_TEMPDIR/commands.txt" "$_HLEDGER_COMPLETION_TEMPDIR/generic-options.txt") )
fi fi
else else
@ -78,13 +78,13 @@ hledgerCompletionFunction() {
} }
# Register completion function for hledger: # Register completion function for hledger:
complete -F hledgerCompletionFunction hledger complete -F _hledger_completion_function hledger
# Include lists of commands and options generated by the Makefile using the # Include lists of commands and options generated by the Makefile using the
# m4 macro processor. # m4 macro processor.
# Included files must have exactly one newline at EOF to prevent weired errors. # Included files must have exactly one newline at EOF to prevent weired errors.
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/commands.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/commands.txt"
add add
import import
balancesheet balancesheet
@ -119,7 +119,7 @@ is
a a
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/generic-options.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/generic-options.txt"
-f -f
-I -I
-b -b
@ -176,7 +176,7 @@ TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-add.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-add.txt"
-f -f
-I -I
-h -h
@ -193,7 +193,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-add.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-import.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-import.txt"
-f -f
-I -I
-b -b
@ -248,7 +248,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-import.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-balancesheet.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-balancesheet.txt"
-H -H
-N -N
-A -A
@ -322,7 +322,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-balancesheet.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-balancesheetequity.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-balancesheetequity.txt"
-H -H
-N -N
-A -A
@ -396,7 +396,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-balancesheetequity.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-cashflow.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-cashflow.txt"
-H -H
-N -N
-A -A
@ -470,7 +470,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-cashflow.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-incomestatement.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-incomestatement.txt"
-H -H
-N -N
-A -A
@ -544,7 +544,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-incomestatement.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-accounts.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-accounts.txt"
-f -f
-I -I
-b -b
@ -601,7 +601,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-accounts.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-activity.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-activity.txt"
-f -f
-I -I
-b -b
@ -653,7 +653,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-activity.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-balance.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-balance.txt"
-H -H
-A -A
-T -T
@ -730,7 +730,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-balance.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-prices.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-prices.txt"
-f -f
-I -I
-b -b
@ -786,7 +786,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-prices.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-print.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-print.txt"
-m -m
-x -x
-O -O
@ -848,7 +848,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-print.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-register.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-register.txt"
-H -H
-A -A
-r -r
@ -916,7 +916,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-register.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-stats.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-stats.txt"
-o -o
-f -f
-I -I
@ -970,7 +970,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-stats.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-tags.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-tags.txt"
-f -f
-f -f
-I -I
@ -1023,7 +1023,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-tags.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-ui.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-ui.txt"
-F -F
-T -T
-f -f
@ -1084,7 +1084,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-ui.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-web.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-web.txt"
-f -f
-I -I
-b -b
@ -1143,7 +1143,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-web.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-close.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-close.txt"
-f -f
-I -I
-b -b
@ -1204,7 +1204,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-close.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-rewrite.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-rewrite.txt"
-f -f
-I -I
-b -b
@ -1281,7 +1281,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-rewrite.txt"
--auto --auto
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-api.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-api.txt"
-h -h
-f -f
-d -d
@ -1297,7 +1297,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-api.txt"
--help --help
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-check-dates.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-check-dates.txt"
-f -f
-f -f
-I -I
@ -1353,7 +1353,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-check-dates.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-check-dupes.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-check-dupes.txt"
-f -f
-I -I
-b -b
@ -1405,7 +1405,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-check-dupes.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-print-unique.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-print-unique.txt"
-f -f
-I -I
-b -b
@ -1457,7 +1457,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-print-unique.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-register-match.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-register-match.txt"
-f -f
-I -I
-b -b
@ -1509,7 +1509,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-register-match.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-roi.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-roi.txt"
-f -f
-I -I
-b -b
@ -1564,19 +1564,19 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-roi.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-test.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-test.txt"
-h -h
--help --help
--debug --debug
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-outlet.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-outlet.txt"
-n -n
-h -h
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-help.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-help.txt"
-h -h
--info --info
--man --man
@ -1585,7 +1585,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-help.txt"
--help --help
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-bs.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-bs.txt"
-H -H
-N -N
-A -A
@ -1659,7 +1659,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-bs.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-bse.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-bse.txt"
-H -H
-N -N
-A -A
@ -1733,7 +1733,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-bse.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-cf.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-cf.txt"
-H -H
-N -N
-A -A
@ -1807,7 +1807,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-cf.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-is.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-is.txt"
-H -H
-N -N
-A -A
@ -1881,7 +1881,7 @@ cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-is.txt"
--version --version
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-a.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-a.txt"
-f -f
-I -I
-b -b

18
shell-completion/hledger-completion.bash.m4
View File

@ -13,17 +13,17 @@ set -o pipefail
# for example grepping an array or mapping a substitution on it. # for example grepping an array or mapping a substitution on it.
# Therefore, we create temp files in RAM for completion suggestions (see below). # Therefore, we create temp files in RAM for completion suggestions (see below).
readonly HLEDGER_COMPLETION_TEMPDIR=$(mktemp -d) readonly _HLEDGER_COMPLETION_TEMPDIR=$(mktemp -d)
hledgerCompletionFunction() { _hledger_completion_function() {
#declare cmd=$1 #declare cmd=$1
declare wordToComplete=$2 declare wordToComplete=$2
declare precedingWord=$3 declare precedingWord=$3
declare subcommand declare subcommand
for subcommand in "${COMP_WORDS[@]}"; do for subcommand in "${COMP_WORDS[@]}"; do
if grep -Fxqe "$subcommand" "$HLEDGER_COMPLETION_TEMPDIR/commands.txt"; then if grep -Fxqe "$subcommand" "$_HLEDGER_COMPLETION_TEMPDIR/commands.txt"; then
COMPREPLY+=( $(grep -h "^$wordToComplete" -- "$HLEDGER_COMPLETION_TEMPDIR/options-$subcommand.txt") ) COMPREPLY+=( $(grep -h "^$wordToComplete" -- "$_HLEDGER_COMPLETION_TEMPDIR/options-$subcommand.txt") )
break break
fi fi
subcommand= subcommand=
@ -53,7 +53,7 @@ hledgerCompletionFunction() {
COMPREPLY=( "${files[@]}" ) COMPREPLY=( "${files[@]}" )
else else
COMPREPLY+=( $(grep -h "^$wordToComplete" -- "$HLEDGER_COMPLETION_TEMPDIR/commands.txt" "$HLEDGER_COMPLETION_TEMPDIR/generic-options.txt") ) COMPREPLY+=( $(grep -h "^$wordToComplete" -- "$_HLEDGER_COMPLETION_TEMPDIR/commands.txt" "$_HLEDGER_COMPLETION_TEMPDIR/generic-options.txt") )
fi fi
else else
@ -78,24 +78,24 @@ hledgerCompletionFunction() {
} }
# Register completion function for hledger: # Register completion function for hledger:
complete -F hledgerCompletionFunction hledger complete -F _hledger_completion_function hledger
# Include lists of commands and options generated by the Makefile using the # Include lists of commands and options generated by the Makefile using the
# m4 macro processor. # m4 macro processor.
# Included files must have exactly one newline at EOF to prevent weired errors. # Included files must have exactly one newline at EOF to prevent weired errors.
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/commands.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/commands.txt"
include(`commands.txt')dnl include(`commands.txt')dnl
TEXT TEXT
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/generic-options.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/generic-options.txt"
include(`generic-options.txt')dnl include(`generic-options.txt')dnl
TEXT TEXT
include(`foreach2.m4') include(`foreach2.m4')
foreach(`cmd', (include(`commands-list.txt')), ` foreach(`cmd', (include(`commands-list.txt')), `
cat <<TEXT > "$HLEDGER_COMPLETION_TEMPDIR/options-cmd.txt" cat <<TEXT > "$_HLEDGER_COMPLETION_TEMPDIR/options-cmd.txt"
include(options-cmd.txt)dnl include(options-cmd.txt)dnl
TEXT TEXT
') ')