Skip to content

EXAMPLES.md

Latest commit

 

History

History
111 lines (82 loc) · 2.06 KB

EXAMPLES.md

File metadata and controls

111 lines (82 loc) · 2.06 KB

zconfig: Examples & Use Cases

This is a part of zconfig documentation. Code examples and common patterns.

OS-Specific Configuration

# apps/mytool.zsh
#!/bin/zsh
zfile_track_start ${0:A}

if is_installed mytool; then
    if is_macos; then
        export MYTOOL_PATH=/opt/homebrew/opt/mytool
    elif is_debian_based; then
        export MYTOOL_PATH=/usr/local/mytool
    fi
    export PATH=$MYTOOL_PATH/bin:$PATH
fi

zfile_track_end ${0:A}

Optional File Loading

# Source file only if it exists
[[ -f "$HOME/.secrets" ]] && source "$HOME/.secrets"
[[ -f "$HOME/.local.zsh" ]] && source "$HOME/.local.zsh"

Custom Autoloaded Function

# functions/devinfo
local python_ver node_ver git_ver

python_ver=$(python3 --version 2>&1 | get_version)
node_ver=$(node --version 2>&1 | get_version)
git_ver=$(git --version 2>&1 | get_version)

print "Development Environment:"
print "  Python: ${y}${python_ver}${x}"
print "  Node.js: ${y}${node_ver}${x}"
print "  Git: ${y}${git_ver}${x}"

Performance Measurement

# Measure startup time
$ time zsh -lic "exit"

# Detailed breakdown
$ ZSH_DEBUG=1 zsh -lic "exit"

# Full report
$ zfiles

Lazy Loading Pattern

# apps/heavytool.zsh
if is_installed heavytool; then
    heavytool() {
        unfunction heavytool
        eval "$(command heavytool init zsh)"
        heavytool "$@"
    }
fi

Plugin with Configuration

# plugins/zsh-autosuggestions.zsh
#!/bin/zsh
zfile_track_start ${0:A}

# Configuration before loading
ZSH_AUTOSUGGEST_STRATEGY=(history completion)
ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE=20

load_plugin zsh-autosuggestions

# Keybinding after loading
bindkey '^[[Z' autosuggest-accept

zfile_track_end ${0:A}

Manual Compilation

# Compile entire configuration
compile_zsh_config

# Compile quietly (as done automatically on startup)
compile_zsh_config -q

# Compile single directory
compile_dir "$ZSH_LIB_DIR"

# Clean all compiled files
clean_zsh_config

# Check if file needs recompilation
needs_compile lib/strings.zsh && echo "needs compile"