X-Git-Url: https://arthur.barton.de/gitweb/?p=ax-zsh.git;a=blobdiff_plain;f=ax.zsh;h=1936327986e8e241bea0880b6e06ab20447c4c9a;hp=a841af58ccd0d10eb5aea4ccb8580e4ca141a128;hb=HEAD;hpb=d1529bb40528aafd9bdb98ba5a03d4ecb79d82bb diff --git a/ax.zsh b/ax.zsh index a841af5..05f2002 100644 --- a/ax.zsh +++ b/ax.zsh @@ -1,9 +1,119 @@ # AX-ZSH: Alex' Modular ZSH Configuration -# Copyright (c) 2015-2017 Alexander Barton +# Copyright (c) 2015-2024 Alexander Barton script_name="${${(%):-%N}:t}" script_type="$script_name[2,-1]" +# Handle "initialization stage", load all plugins of that stage, either from an +# existing cache file or individually, optionally creating the cache. +# - $1: Script name +# - $2: Stage name (ax-io, zprofile, zshrc, zlogin, zlogout) +function axzsh_handle_stage { + local name="$1" + local type="$2" + + [[ -n "$AXZSH_DEBUG" ]] && echo "» $name ($type):" + + # Look for some 3rd-party integrations ... + + # --- Powerlevel10k --- + # Enable instant prompt. Should stay close to the top of ~/.zshrc. + # Initialization code that may require console input (password prompts, + # [y/n] confirmations, etc.) must be executed before this, so all ax-zsh + # plugins should do output in their "ax-io" stage only! + # Read the initialization script in the "zprofile" stage for login + # shells, and in the "zshrc" stage for non-login sub-shells (which have + # the profile already read in and therefore will skip the "ax-io" and + # "zprofile" stages and not catch up). + if [[ \ + ( "$type" == "zprofile" ) || \ + ( ! -o login && "$type" == "zshrc" && -n "$AXZSH_ZPROFILE_READ" ) \ + ]]; then + p10k_instant_prompt="${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh" + if [[ -r "$p10k_instant_prompt" ]]; then + [[ -n "$AXZSH_DEBUG" ]] && echo " Reading \"$p10k_instant_prompt\" ..." + source "$p10k_instant_prompt" + fi + unset p10k_instant_prompt + fi + # Read in Powerlevel10k configuration file, if not already read: + [[ -z "$POWERLEVEL9K_CONFIG_FILE" && -r ~/.p10k.zsh ]] && source ~/.p10k.zsh + + # Initialize cache + [[ -d "$AXZSH/cache" ]] || mkdir -p "$AXZSH/cache" + local cache_file="$AXZSH/cache/$type.cache" + + local cat_cmd=${commands[cat]:-cat} + + if [[ -r "$cache_file" ]]; then + # Cache file exists, use it! + # But when in the "zshrc" stage, make sure that the "zprofile" stage + # has already been handled (this uses the "01_zprofile" plugin which + # is used in the "zshrc.cache" as well, but can't be used successfully + # there because it becomes sourced inside of a ZSH function; so we have + # to source it here in the global context manually ...): + [[ -z "$AXZSH_ZPROFILE_READ" && "$type" = "zshrc" ]] \ + && source "$AXZSH/core/01_zprofile/01_zprofile.zshrc" + [[ -n "$AXZSH_DEBUG" ]] \ + && echo " - Reading cache file \"$cache_file\" ..." + source "$cache_file" + (( $+functions[axzsh_plugin_init] )) && unfunction axzsh_plugin_init + else + # No cache file available. + local new_cache_file="$cache_file.NEW" + + # Setup list of plugins to load: + local plugin_list + typeset -U plugin_list + plugin_list=( + "$AXZSH/core/"[0-4]* + "$AXZSH/active_plugins/"*(N) + "$AXZSH/core/"[5-9]* + ) + + # Create new cache file: + [[ -n "$AXZSH_DEBUG" ]] \ + && echo " (Writing new cache file to \"$new_cache_file\" ...)" + if ! printf "# %s\n\n" "$(LC_ALL=C date)" >"$new_cache_file"; then + unset new_cache_file + else + # New cache file successfully created ... + if [[ "$type" = "ax-io" ]]; then + # AX-IO Stage: + # Write an initial PATH variable to the cache + # file, which becomes overwritten by the path + # plugin at the "zprofile" stage later on, but + # this way "ax-io" stage plugins have a somewhat + # saner PATH to begin with ... + printf 'export PATH="%s"\n\n' "$PATH" >>"$new_cache_file" + fi + fi + + # Read in all the plugins for the current "type": + for plugin ($plugin_list); do + # Read the "theme file", if any and in "zshrc" stage. + # This must be done before 99_cleanup is run! + if [[ "$plugin:t" == "99_cleanup" && "$type" = "zshrc" ]]; then + if [[ -r "$AXZSH_THEME" ]]; then + source "$AXZSH_THEME" + if [[ -n "$new_cache_file" ]]; then + # Source the theme in the new cache file: + echo "# BEGIN Theme" >>"$new_cache_file" + echo 'source "$AXZSH_THEME"' >>"$new_cache_file" + echo "# END Theme" >>"$new_cache_file" + fi + fi + fi + axzsh_load_plugin "$plugin" "$type" "$new_cache_file" + done + + if [[ -n "$cache_file" && -n "$new_cache_file" && -r "$new_cache_file" ]]; then + # Move newly created cache file in place: + mv "$new_cache_file" "$cache_file" + fi + fi +} + # Load plugin code of a given type. # - $1: plugin name # - $2: plugin type (optional; defaults to "zshrc") @@ -34,19 +144,33 @@ function axzsh_load_plugin { fi if [[ ! -r "$fname" && "$type" == "zshrc" ]]; then - if [[ -r "$dname/$plugin.zprofile" || -r "$dname/$plugin.zlogout" ]]; then + zsh_themes=("$dname/"*.zsh-theme(NY1)) + if [[ -r "$dname/$plugin.ax-io" || -r "$dname/$plugin.zprofile" || -r "$dname/$plugin.zlogout" ]]; then # Native AX-ZSH plugin, but for different stage. Skip it! : elif [[ -r "$dname/${plugin_short}.plugin.zsh" ]]; then # Oh My ZSH plugin type="plugin.zsh" fname="$dname/${plugin_short}.plugin.zsh" + elif [[ -r "$dname/${plugin_short##zsh-}.plugin.zsh" ]]; then + # Oh My ZSH plugin with "zsh-" prefix stripped + type="plugin.zsh" + fname="$dname/${plugin_short##zsh-}.plugin.zsh" + elif [[ -r "$dname/${plugin%.plugin.zsh}.plugin.zsh" ]]; then + # Oh My ZSH plugin with ".plugin.zsh" suffix in its name + type="plugin.zsh" + fname="$dname/${plugin}" elif [[ -r "$dname/init.zsh" ]]; then # Prezto module type="init.zsh" fname="$dname/init.zsh" + elif [[ ${#zsh_themes} -gt 0 ]]; then + # ZSH "theme plugin", ignore here! + : else echo "AX-ZSH plugin type of \"$plugin\" unknown, skipped!" >&2 + echo "Contents of \"$dname\":" >&2 + ls -lh "$dname/" >&2 return 0 fi fi @@ -56,27 +180,46 @@ function axzsh_load_plugin { [[ -n "$AXZSH_DEBUG" ]] \ && echo " - $plugin ($type): functions ..." axzsh_fpath+=("$dname/functions") + + # Add function path to cache file. + [[ -n "$cache_file" ]] \ + && echo "axzsh_fpath+=('$dname/functions')" >>$cache_file fi if [[ -r "$fname" ]]; then # Read plugin ... [[ -n "$AXZSH_DEBUG" ]] \ && echo " - $plugin ($type) ..." - source "$fname" + + # Note for "external" ("repo/*") plugins and unusual ("not so + # modern") terminals: These (modern?) plugins most probably + # don't expect such a terminal configuration and don't behave + # well (echo color sequences, for example). Therefore we DON'T + # load any external plugins at all in that case: this results in + # reduced/disabled functionality, but hopefully in readable + # output ... + + case "$fname" in + *"/repos/"*) + axzsh_is_modern_terminal && source "$fname" + ;; + *) + source "$fname" + esac if [[ -n "$cache_file" ]]; then # Add plugin data to cache - printf "# BEGIN: %s\ninit()\n{\n" "$fname" >>"$cache_file" + printf "# BEGIN: %s\naxzsh_plugin_init()\n{\n" "$fname" >>"$cache_file" case "$fname" in *"/repos/"*) echo "[[ -n \"\$AXZSH_DEBUG\" ]] && echo ' - $plugin ($type): \"$fname\" ...'" >>$cache_file - echo "source '$fname'" >>$cache_file + echo "axzsh_is_modern_terminal && source '$fname'" >>$cache_file ;; *) echo "[[ -n \"\$AXZSH_DEBUG\" ]] && echo ' - $plugin ($type, cached) ...'" >>$cache_file "$cat_cmd" "$fname" >>"$cache_file" esac - printf "}\ninit\n# END: %s\n\n" "$fname" >>"$cache_file" + printf "}\naxzsh_plugin_init\n# END: %s\n\n" "$fname" >>"$cache_file" fi fi @@ -96,62 +239,29 @@ fi [[ -n "$SHELL" ]] || export SHELL=$(command -v zsh) # Make sure that "AXZSH" variable is set and exported -if [[ -z "$AXZSH" ]]; then - export AXZSH="$HOME/.axzsh" - if [[ -f "$HOME/.axzsh.debug" ]]; then - export AXZSH_DEBUG=1 - echo "AXZSH=$AXZSH" - echo "AXZSH_DEBUG=$AXZSH_DEBUG" - echo "AXZSH_PLUGIN_D=$AXZSH_PLUGIN_D" - fi -fi +[[ -n "$AXZSH" ]] || export AXZSH="${ZDOTDIR:-$HOME}/.axzsh" -[[ -n "$AXZSH_DEBUG" ]] && echo "» $script_name:" - -# Initialize cache -mkdir -p "$AXZSH/cache" -cache_file="$AXZSH/cache/$script_type.cache" - -cat_cmd=${commands[cat]:-cat} - -if [[ -r "$cache_file" ]]; then - # Cache file exists, use it! - # But when in the "zshrc" stage, make sure that the "zprofile" stage - # has already been handled (this uses the "01_zprofile" plugin which - # is used in the "zshrc.cache" as well, but can't be used successfully - # there because it becomes sourced inside of a ZSH function; so we have - # to source it here in the global context manually ...): - [[ -z "$AXZSH_ZPROFILE_READ" && "$script_type" = "zshrc" ]] \ - && source "$AXZSH/core/01_zprofile/01_zprofile.zshrc" - [[ -n "$AXZSH_DEBUG" ]] \ - && echo " - Reading cache file \"$cache_file\" ..." - source "$cache_file" -else - # No cache file available. - # Setup list of plugins to load: - typeset -U plugin_list - plugin_list=( - "$AXZSH/core/"[0-5]* - "$AXZSH/active_plugins/"*(N) - "$AXZSH/core/"[6-9]* - ) - - # Create new cache file: - if [[ -n "$cache_file" ]]; then - [[ -n "$AXZSH_DEBUG" ]] \ - && echo " (Writing new cache file to \"$cache_file\" ...)" - printf "# %s\n\n" "$(LC_ALL=C date)" >"$cache_file" - fi +# Check for "debug mode" ... +if [[ -f "$AXZSH/debug" || -f "$HOME/.axzsh.debug" ]]; then + export AXZSH_DEBUG=1 + export POWERLEVEL9K_INSTANT_PROMPT=quiet + echo "AXZSH=$AXZSH" + echo "AXZSH_DEBUG=$AXZSH_DEBUG" + echo "AXZSH_PLUGIN_D=$AXZSH_PLUGIN_D" + echo "AXZSH_ZLOGIN_READ=$AXZSH_ZLOGIN_READ" + echo "AXZSH_ZPROFILE_READ=$AXZSH_ZPROFILE_READ" +fi - # Read in all the plugins for the current "type": - for plugin ($plugin_list); do - axzsh_load_plugin "$plugin" "$script_type" "$cache_file" - done +if [[ "$script_type" = "zprofile" ]]; then + # Load all "output" plugins first, that is, before the "zprofile stage": + axzsh_handle_stage "$script_name" "ax-io" fi +axzsh_handle_stage "$script_name" "$script_type" + # Clean up ... -unfunction axzsh_load_plugin -unset script_name script_type plugin -unset plugin_list -unset cache_file -unset cat_cmd +unfunction axzsh_handle_stage axzsh_load_plugin +unset script_name script_type + +# Hints for external installers: +# - iTerm2: DON'T install "iterm2_shell_integration"!