rootiest
1341e2559e
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).
81 lines
2.5 KiB
Fish
81 lines
2.5 KiB
Fish
# Copyright (C) 2026 Rootiest
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
# SYNOPSIS
|
|
# mkcd [-s | --silent] <dir>
|
|
#
|
|
# DESCRIPTION
|
|
# Creates a directory (including any missing parent directories) and
|
|
# immediately changes into it. Prints a tree of created directories by
|
|
# default, or suppresses output with -s. Delegates creation to
|
|
# _fish_mkdir_p.
|
|
#
|
|
# ARGUMENTS
|
|
# -h, --help Show usage help
|
|
# -s, --silent Suppress directory creation output
|
|
# <dir> Directory to create and enter
|
|
#
|
|
# RETURNS
|
|
# 0 Directory created (or already existed) and entered successfully
|
|
# 1 Directory creation or cd failed
|
|
#
|
|
# EXAMPLE
|
|
# mkcd ~/projects/myapp
|
|
function mkcd --description 'Create a directory (with parents) and cd into it'
|
|
set -l c_head (set_color --bold cyan)
|
|
set -l c_cmd (set_color --bold white)
|
|
set -l c_arg (set_color cyan)
|
|
set -l c_flag (set_color yellow)
|
|
set -l c_ok (set_color green)
|
|
set -l c_warn (set_color yellow)
|
|
set -l c_err (set_color red)
|
|
set -l c_dim (set_color brblack)
|
|
set -l c_rst (set_color normal)
|
|
|
|
if contains -- -h $argv; or contains -- --help $argv; or test (count $argv) -eq 0
|
|
echo "$c_head""Usage:$c_rst $c_cmd""mkcd$c_rst $c_arg""<dir>$c_rst"
|
|
echo
|
|
echo " Create $c_arg""<dir>$c_rst (including missing parents) and cd into it."
|
|
echo
|
|
echo "$c_head""Arguments:$c_rst"
|
|
echo " $c_arg""<dir>$c_rst Directory to create and enter"
|
|
echo
|
|
echo "$c_head""Flags:$c_rst"
|
|
echo " $c_flag-h$c_rst, $c_flag--help$c_rst Show this help message"
|
|
echo " $c_flag-s$c_rst, $c_flag--silent$c_rst Suppress directory creation output"
|
|
echo
|
|
echo "$c_head""Examples:$c_rst"
|
|
echo " $c_cmd""mkcd$c_rst $c_arg~/projects/myapp$c_rst"
|
|
echo " $c_cmd""mkcd$c_rst $c_arg~/projects/myapp$c_rst""$c_dim""; git init$c_rst"
|
|
return 0
|
|
end
|
|
|
|
set -l silent 0
|
|
set -l dir
|
|
for _arg in $argv
|
|
switch $_arg
|
|
case -s --silent
|
|
set silent 1
|
|
case '*'
|
|
set dir $_arg
|
|
end
|
|
end
|
|
|
|
set -l is_new 0
|
|
test -d $dir; or set is_new 1
|
|
if test $silent -eq 1
|
|
_fish_mkdir_p --silent $dir; or return $status
|
|
else
|
|
_fish_mkdir_p --tree $dir; or return $status
|
|
end
|
|
|
|
cd $dir
|
|
or return $status
|
|
|
|
if test $is_new -eq 1
|
|
echo "$c_ok""✔$c_rst Created and entered $c_arg$dir$c_rst"
|
|
else
|
|
echo "$c_warn""→$c_rst $c_arg$dir$c_rst already exists — entered"
|
|
end
|
|
end
|