Files
fish-config/functions/__config_settings_get_val.fish
T
rootiest e651566e14 docs(functions): split RETURNS into EXIT STATUS and stdout RETURNS
RETURNS previously conflated fish's $status exit code with genuine
stdout/printed output, e.g. rm listing "0/1" as if they were print
values rather than exit codes. Rename RETURNS to EXIT STATUS across
all 83 documented functions, and reintroduce RETURNS as a distinct
label reserved for the 15 functions that actually print to stdout.

Update build-manual.py's ENTRY_HEADS to render Exit Status before
Returns, manualtools.py's SECTIONS constant, and AGENTS.md's label
order and label-usage guidance to match. Add two verify-manual.py
regression tests: EXIT STATUS bodies must never contain stray
stdout/printed language, and Returns: must always render after
Exit Status: when both are present. Regenerate docs/fish-config.md.
2026-07-26 16:41:57 -04:00

54 lines
1.4 KiB
Fish

# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# SYNOPSIS
# __config_settings_get_val <varname> <scope>
#
# DESCRIPTION
# Returns the current value of a named variable in the specified scope by
# parsing `set --show` output. Outputs "on", "off", or "DEFAULT" (when
# the variable is not set in that scope). Scope "session" maps to "global"
# in fish's internal terminology.
#
# ARGUMENTS
# varname Variable name without $ prefix
# scope "universal" or "session"
#
# EXIT STATUS
# 0 Always
#
# RETURNS
# "on", "off", or "DEFAULT", printed to stdout
#
# EXAMPLE
# set result (__config_settings_get_val __fish_config_op_aliases universal)
# # result == "on" | "off" | "DEFAULT"
function __config_settings_get_val
set -l varname $argv[1]
set -l scope $argv[2]
set -l scope_kw $scope
if test $scope = session
set scope_kw global
end
set -l found 0
for line in (set --show $varname 2>/dev/null)
if string match -q "*$scope_kw scope*" $line
set found 1
continue
end
if test $found -eq 1
set found 0
set -l val (string replace -r '^\$[^\[]+\[1\]: \|(.+)\|$' '$1' $line 2>/dev/null)
if test -n "$val" -a "$val" != $line
echo $val
return 0
end
end
end
echo DEFAULT
return 0
end