]> arthur.barton.de Git - ax-zsh.git/blobdiff - bin/axzshctl
Correctly test XDG_CACHE_HOME for writability for "stamp files"
[ax-zsh.git] / bin / axzshctl
index 70b3ff2876fc5d309bd99b9d8c2019055864e637..943e4641bec19812fdb7a1ace1c7bb957aba4612 100755 (executable)
@@ -1,7 +1,7 @@
 #!/usr/bin/env zsh
 #
 # AX-ZSH: Alex' Modular ZSH Configuration
-# Copyright (c) 2015-2021 Alexander Barton <alex@barton.de>
+# Copyright (c) 2015-2023 Alexander Barton <alex@barton.de>
 #
 
 # Embedded ax-common compatibility functions ...
@@ -22,12 +22,23 @@ function ax_error {
 
 function Version {
        echo "ax-zsh -- Modular configuration system for the Z shell (ZSH)"
-       echo "Copyright (c) 2015-2019 Alexander Barton <alex@barton.de>."
+       echo "Copyright (c) 2015-2023 Alexander Barton <alex@barton.de>."
        echo "Licensed under the terms of the MIT license, see LICENSE.md for details."
        echo "Homepage: <https://github.com/alexbarton/ax-zsh>"
+       echo
+       echo "Installation prefix: $AXZSH"
+       echo -n "Version: "
        if [[ -d "$AXZSH/.git" && -n "$commands[git]" ]]; then
-               echo -n "Version: Git ID "
+               echo -n "Git Commit-ID "
                ( cd "$AXZSH" && git describe --always )
+       else
+               echo "unknown"
+       fi
+       echo -n "Active theme: "
+       if [[ -n "$AXZSH_THEME" ]]; then
+               echo "${AXZSH_THEME:A:t:r}"
+       else
+               echo "unknown"
        fi
        echo
        exit 0
@@ -47,6 +58,8 @@ function Usage {
        echo "    Disable plugin(s)."
        echo "  list-enabled"
        echo "    List enabled plugins."
+       echo "  plugin-help"
+       echo "    Show help text for a plugin (when provided by the plugin)."
        echo
        echo "  reset-plugins"
        echo "    Reset active plugins to the default set."
@@ -55,7 +68,7 @@ function Usage {
        echo "  check-plugins"
        echo "    Detect plugins which are \"useful\" on this system."
        echo
-       echo "  set-theme <name>|-"
+       echo "  set-theme {<name>|-}"
        echo "    Set active theme to <name>, or to the default."
        echo
        echo "  upgrade"
@@ -63,6 +76,11 @@ function Usage {
        echo "  update-caches"
        echo "    Force rebuild of all cache files."
        echo
+       echo "  help"
+       echo "    Show this help text."
+       echo "  version"
+       echo "    Show version and setup information."
+       echo
        exit 0
 }
 
@@ -86,11 +104,13 @@ function UpdatePluginCache {
                || return 1
 
        echo "Regenerating AX-ZSH cache ..."
-       AXZSH_PLUGIN_CHECK=1 zsh -ilc '' >/dev/null
+       [[ -z "$AXZSH_DEBUG" ]] \
+               && AXZSH_PLUGIN_CHECK=1 zsh -ilc '' >/dev/null \
+               || AXZSH_PLUGIN_CHECK=1 zsh -ilc ''
 }
 
 function NormalizedPluginName {
-       if [[ "$1" =~ "^[[:alnum:]-]+/[[:alnum:]_.-]+$" ]]; then
+       if [[ "$1" =~ "^@?[[:alnum:]-]+/[[:alnum:]_.-]+$" ]]; then
                echo "${1:gs/\//#}"
        elif [[ "$1" =~ "/" ]]; then
                echo "${1:t}"
@@ -104,6 +124,10 @@ function EnableAXZSH {
                ln -s "$AXZSH/ax.zsh" "$f" \
                        || ax_error "Failed to create symbolic link for \"$f\"!"
        done
+       if [[ -z "$AXZSH_FPATH" ]]; then
+               echo "AX-ZSH was enabled. Now you should restart your shell, for example like this:"
+               echo "$ exec -l \"\$SHELL\""
+       fi
 }
 
 function DisableAXZSH {
@@ -121,13 +145,27 @@ function DisableAXZSH {
 function EnablePlugin {
        local plugin=$(NormalizedPluginName "$1")
        local dir="$AXZSH/active_plugins"
+       local name="$plugin"
 
        if [[ -h "$dir/$plugin" ]]; then
                ax_msg 1 "Plugin \"$1\" already active!"
                return 1
        fi
 
-       if [[ "$1" =~ "^[[:alnum:]-]+/[[:alnum:]_.-]+$" ]]; then
+       if [[ "$1" =~ "^@[[:alnum:]-]+/[[:alnum:]_.+-]+$" ]]; then
+               # GitHub plugin repository (like OhMyZsh)
+               local repo="${1##@}"
+               repo="${repo%/*}"
+               mkdir -p "$AXZSH/repos/@$repo"
+               if [[ ! -d "$AXZSH/repos/@$repo/plugins" ]]; then
+                       ax_msg - "Cloning \"$repo\" from GitHub ..."
+                       git clone --depth=1 "https://github.com/$repo/$repo.git" \
+                        "$AXZSH/repos/@$repo" \
+                               || ax_error "Failed to clone \"$repo\" repository!"
+               fi
+               plugin="@$repo/plugins/${1#*/}"
+               echo "Trying to enable \"$1\" ..."
+       elif [[ "$1" =~ "^[[:alnum:]-]+/[[:alnum:]_.-]+$" ]]; then
                # GitHub plugin
                mkdir -p "$AXZSH/repos"
                if [[ ! -e "$AXZSH/repos/$plugin" ]]; then
@@ -146,6 +184,9 @@ function EnablePlugin {
                        return 0
                fi
                echo "Trying to enable \"$1\" as plugin ..."
+       elif ! [[ "$1" =~ "^[[:alnum:]_.-]+$" ]]; then
+               ax_error "Invalid plugin name!"
+               return 1
        fi
 
        for dname (
@@ -162,12 +203,12 @@ function EnablePlugin {
                mkdir -p "$dir"
                if ! (
                        cd "$dir" || exit 9
-                       ln -s "$dname" "$PWD"
+                       ln -s "$dname" "$PWD/$name"
                ); then
                        ax_error "Failed to create link!"
                        return 1
                fi
-               ax_msg 0 "Plugin \"$plugin\" enabled."
+               ax_msg 0 "Plugin \"$1\" enabled."
                return 0
        done
 
@@ -211,6 +252,35 @@ function ListEnabledPlugins {
        return 0
 }
 
+function PluginHelp {
+       local plugin=$(NormalizedPluginName "$1")
+       local repo_plugin=$(echo "$plugin" | sed -e 's|#|/plugins/|')
+       local plugin_found=
+
+       for plugin_d (
+               "$plugin:A"
+               "$AXZSH/active_plugins/$plugin"
+               "$AXZSH/active_plugins/$repo_plugin"
+               "$AXZSH_PLUGIN_D/$plugin"
+               "$ZSH_CUSTOM/$plugin"
+               "$AXZSH/custom_plugins/$plugin"
+               "$AXZSH/repos/$plugin"
+               "$AXZSH/repos/$repo_plugin"
+               "$AXZSH/plugins/$plugin"
+               "$AXZSH/default_plugins/$plugin"
+               "$AXZSH/core/$plugin"
+       ); do
+               [[ -e "$plugin_d" ]] && plugin_found=1
+               [[ -r "$plugin_d/README.md" ]] || continue
+               less "$plugin_d/README.md"
+               return 0
+       done
+       [[ -n "$plugin_found" ]] \
+               && echo "Plugin \"$1\" found, but no help available!" >&2 \
+               || echo "Plugin \"$1\" not found!" >&2
+       return 1
+}
+
 function ResetPlugins {
        local dir="$AXZSH/active_plugins"
        local r1=0, r2=0
@@ -345,9 +415,9 @@ function CheckPlugins {
        fi
        for p in $AXZSH/core/*/*.zshrc; do
                [[ "$(basename "$p")" == "01_zprofile.zshrc" ]] && continue
-               printf "# BEGIN: %s\nax_plugin_init()\n{\n" "$p" >>"$T"
+               printf "# BEGIN: %s\naxzsh_plugin_init()\n{\n" "$p" >>"$T"
                cat "$p" >>"$T"
-               printf "}\nax_plugin_init\n# END: %s\n\n" "$p" >>"$T"
+               printf "}\naxzsh_plugin_init\n# END: %s\n\n" "$p" >>"$T"
        done
 
        ax_msg - "Checking plugins ..."
@@ -370,8 +440,8 @@ function CheckPlugins {
                        (
                                AXZSH_PLUGIN_CHECK=1
                                source "$T"
-                               ax_plugin_fnc() { source "$script" }
-                               ax_plugin_fnc
+                               axzsh_plugin_fnc() { source "$script" }
+                               axzsh_plugin_fnc
                        ); r=$?
                        [[ $r -eq 0 ]] && new_plugin=$plugin
                        break
@@ -456,6 +526,10 @@ case "$cmd" in
                [[ $# -eq 0 ]] || Usage
                ListEnabledPlugins
                ;;
+       "plugin-help")
+               [[ $# -eq 1 ]] || Usage
+               PluginHelp "$1"
+               ;;
        "reset-plugins")
                [[ $# -eq 0 ]] || Usage
                ResetPlugins