ivuorinen/dotfiles
1
0
Fork 0
mirror of https://github.com/ivuorinen/dotfiles.git synced 2026-03-06 11:00:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(utils): improve get_function_description file resolution (#122)

Browse Source
This commit is contained in:
Ismo Vuorinen
2025-06-11 21:16:42 +03:00
parent 6155891fa4
commit 5a832d1478
1 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
local/dfm/lib/utils.sh
View File

@@ -663,19 +663,27 @@ main::get_command_functions()
# the description text. If no description is found, nothing is printed. # the description text. If no description is found, nothing is printed.
# #
# Arguments: # Arguments:
# cmd_file - Path to the file containing the function definitions. # cmd - Command name or path to the file containing the function definitions.
# func - Name of the function whose description is to be extracted. # func - Name of the function whose description is to be extracted.
# #
# Outputs: # Outputs:
# The extracted description text is printed to STDOUT. # The extracted description text is printed to STDOUT.
# #
# Example: # Example:
# desc=$(main::get_function_description "/path/to/commands.sh" "my_function") # desc=$(main::get_function_description "install" "my_function")
main::get_function_description() main::get_function_description()
{ {
local cmd_file="$1" local cmd="$1"
local cmd_file="${DFM_CMD_DIR}/${cmd}.sh"
local func="$2" local func="$2"
local cmd_file="${DFM_CMD_DIR}/${cmd}.sh"
if [[ ! -f "$cmd_file" && -f "$cmd" ]]; then
cmd_file="$cmd"
fi
if [[ ! -f "$cmd_file" ]]; then
return 1
fi
grep -B1 "^[[:space:]]*\(function[[:space:]]*\)\{0,1\}$func().*{" "$cmd_file" \ grep -B1 "^[[:space:]]*\(function[[:space:]]*\)\{0,1\}$func().*{" "$cmd_file" \
| grep "@description" \ | grep "@description" \