Files
fish-config/functions/cat.fish
T
rootiest 1341e2559e docs(functions): standardize all function doc blocks to UNIX man-page style
Replace all ad-hoc inline comments between license headers and function
declarations with consistent SYNOPSIS / DESCRIPTION / ARGUMENTS / RETURNS /
EXAMPLE blocks across all 99 project-owned functions/ files. No executable
logic, variable names, or exit codes were modified.

Completes Task #6 from AGENTS.md (Retroactive Function Documentation
Standardization).
2026-06-05 20:18:49 -04:00

45 lines
1.4 KiB
Fish

# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# SYNOPSIS
# cat [args...]
#
# DESCRIPTION
# Enhanced cat replacement that uses bat for file display, runs ls when given
# a directory, falls back to raw cat for ANSI-colored log files, and finally
# falls back to standard cat if bat is not installed.
#
# ARGUMENTS
# args... Files or directories to display
#
# EXAMPLE
# cat README.md
function cat --wraps='bat' --description 'Use bat for files, ls for directories, and raw cat for ANSI logs'
# If no arguments are provided, cat usually waits for stdin.
# We'll maintain that behavior by skipping the directory check if $argv is empty.
if set -q argv[1]
if test -d $argv[1]
# If it's a directory, run your custom ls function
ls $argv
return
end
# NEW: Check if the target file lives in your scrollback snapshot directory OR
# contains raw terminal ANSI color escape sequences.
if test -f $argv[1]
if string match -q "$SCROLLBACK_HISTORY_DIR/*" $argv[1]
or string match -qr '\e\[[0-9;]*m' (head -n 5 $argv[1] 2>/dev/null)
command cat $argv
return
end
end
end
# Fallback to bat or standard cat
if type -q bat
bat --plain --no-pager $argv
else
command cat $argv
end
end