2019-12-01 16:00:47 -05:00
zmodule() {
2022-10-23 20:34:14 -04:00
local -r ztarget=${ZIM_CONFIG_FILE:-<%= home %>/.zimrc}
2022-09-26 21:33:49 -04:00
local -r zusage="Usage: %B${0}%b <url> [%B-n%b|%B--name%b <module_name>] [%B-r%b|%B--root%b <path>] [options]
2019-12-01 16:00:47 -05:00
2022-10-23 20:34:14 -04:00
Add %Bzmodule%b calls to your %B${ztarget}%b file to define the modules to be initialized.
2022-09-26 21:33:49 -04:00
The initialization will be done in the same order it's defined.
2020-05-02 19:47:38 -04:00
2020-10-11 13:24:01 -04:00
<url> Module absolute path or repository URL. The following URL formats
2021-11-08 20:05:32 -05:00
are equivalent: %Bfoo%b, %Bzimfw/foo%b, %Bhttps://github.com/zimfw/foo.git%b.
2022-09-26 21:33:49 -04:00
If an absolute path is given, the module is considered externally
installed, and won't be installed or updated by zimfw.
2022-10-06 20:52:57 -04:00
%B-n%b|%B--name%b <module_name> Set a custom module name. Default: the last component in <url>.
Slashes can be used inside the name to organize the module into
subdirectories. The module will be installed at
2022-09-26 21:33:49 -04:00
%B${ZIM_HOME}/%b<module_name>.
2022-09-27 18:45:16 -04:00
%B-r%b|%B--root%b <path> Relative path to the module root.
2020-05-02 19:47:38 -04:00
2022-09-26 21:33:49 -04:00
Per-module options:
2020-10-11 13:24:01 -04:00
%B-b%b|%B--branch%b <branch_name> Use specified branch when installing and updating the module.
2021-11-08 20:05:32 -05:00
Overrides the tag option. Default: the repository default branch.
%B-t%b|%B--tag%b <tag_name> Use specified tag when installing and updating the module. Over-
rides the branch option.
2021-07-11 16:58:15 -04:00
%B-u%b|%B--use%b <%%Bgit%b|%Bdegit%b> Install and update the module using the defined tool. Default is
2021-11-08 20:05:32 -05:00
either defined by %Bzstyle ':zim:zmodule' use '%b<%%Bgit%b|%Bdegit%b>%B'%b, or %Bgit%b
if none is provided.
%Bgit%b requires git itself. Local changes are preserved on updates.
2021-08-10 10:56:25 -04:00
%Bdegit%b requires curl or wget, and currently only works with GitHub
2021-11-08 20:05:32 -05:00
URLs. Modules install faster and take less disk space. Local
changes are lost on updates. Git submodules are not supported.
2022-01-25 09:32:50 -05:00
%B--no-submodules%b Don't install or update git submodules.
2021-07-01 19:06:20 -04:00
%B-z%b|%B--frozen%b Don't install or update the module.
2022-09-26 21:33:49 -04:00
The per-module options above are carried over multiple zmodule calls for the same module.
Modules are uniquely identified by their name.
Per-module-root options:
2022-12-18 15:58:30 -05:00
%B--if%b <test> Will only initialize module root if specified test returns a zero
exit status. The test is evaluated at every new terminal startup.
2022-05-07 17:31:08 -04:00
%B--on-pull%b <command> Execute command after installing or updating the module. The com-
mand is executed in the module root directory.
2022-09-26 21:33:49 -04:00
%B-d%b|%B--disabled%b Don't initialize the module root or uninstall the module.
The per-module-root options above are carried over multiple zmodule calls for the same mod-
ule root.
Per-call initialization options:
%B-f%b|%B--fpath%b <path> Will add specified path to fpath. The path is relative to the
module root directory. Default: %Bfunctions%b, if the subdirectory
exists and is non-empty.
%B-a%b|%B--autoload%b <func_name> Will autoload specified function. Default: all valid names inside
the %Bfunctions%b subdirectory, if any.
%B-s%b|%B--source%b <file_path> Will source specified file. The path is relative to the module
root directory. Default: %Binit.zsh%b, if a non-empty %Bfunctions%b sub-
directory exists, else the largest of the files matching the glob
2022-10-06 20:52:57 -04:00
%B(init.zsh|%b<name>%B.(zsh|plugin.zsh|zsh-theme|sh))%b, if any.
<name> in the glob is resolved to the last component of the mod-
ule name, or the last component of the path to the module root.
2022-09-26 21:33:49 -04:00
%B-c%b|%B--cmd%b <command> Will execute specified command. Occurrences of the %B{}%b placeholder
in the command are substituted by the module root directory path.
2021-11-08 20:05:32 -05:00
I.e., %B-s 'foo.zsh'%b and %B-c 'source {}/foo.zsh'%b are equivalent.
2021-09-26 20:47:44 -04:00
2022-09-26 21:33:49 -04:00
Setting any per-call initialization option above will disable the default values from the
other per-call initialization options, so only your provided values will be used. I.e. these
values are either all automatic, or all manual in each zmodule call. To use default values
and also provided values, use separate zmodule calls."
2022-10-23 20:34:14 -04:00
if [[ ${${funcfiletrace[1]%:*}:A} != ${ztarget:A} ]]; then
print -u2 -PlR "%F{red}${0}: Must be called from %B${ztarget}%b%f" '' ${zusage}
2021-03-19 18:13:21 -04:00
return 2
2019-12-01 16:00:47 -05:00
fi
if (( ! # )); then
2021-11-08 11:38:56 -05:00
print -u2 -PlR "%F{red}<%= error %>${funcfiletrace[1]}: Missing zmodule url%f" '' ${zusage}
2019-12-01 16:00:47 -05:00
_zfailed=1
2021-03-19 18:13:21 -04:00
return 2
2019-12-01 16:00:47 -05:00
fi
2022-09-26 21:33:49 -04:00
local zurl=${1} zname=${1:t} zroot zarg
2022-05-17 19:43:59 -04:00
local -a zfpaths zfunctions zcmds
2019-12-01 16:00:47 -05:00
if [[ ${zurl} =~ ^[^:/]+: ]]; then
2022-05-17 19:43:59 -04:00
zname=${zname%.git}
2019-12-01 16:00:47 -05:00
elif [[ ${zurl} != /* ]]; then
# Count number of slashes
case ${#zurl//[^\/]/} in
2021-09-23 15:29:40 -04:00
0) zurl=https://github.com/zimfw/${zurl}.git ;;
1) zurl=https://github.com/${zurl}.git ;;
2019-12-01 16:00:47 -05:00
esac
fi
shift
2022-09-26 21:33:49 -04:00
while [[ ${1} == (-n|--name|-r|--root) ]]; do
2019-12-01 16:00:47 -05:00
if (( # < 2 )); then
2022-05-17 19:43:59 -04:00
print -u2 -PlR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zname}:%b Missing argument for zmodule option %B${1}%b%f" '' ${zusage}
2019-12-01 16:00:47 -05:00
_zfailed=1
2021-03-19 18:13:21 -04:00
return 2
2019-12-01 16:00:47 -05:00
fi
2022-09-26 21:33:49 -04:00
case ${1} in
-n|--name)
shift
zname=${${1%%/##}##/##}
;;
-r|--root)
shift
zroot=${${1%%/##}##/##}
;;
esac
2019-12-01 16:00:47 -05:00
shift
2022-05-17 19:43:59 -04:00
done
2020-06-05 23:09:23 -04:00
if [[ ${zurl} == /* ]]; then
2022-05-17 19:43:59 -04:00
_zdirs[${zname}]=${zurl%%/##}
2021-09-23 15:29:40 -04:00
zurl=
2020-06-05 23:09:23 -04:00
else
2022-05-17 19:43:59 -04:00
_zdirs[${zname}]=${ZIM_HOME}/modules/${zname}
fi
2022-09-26 21:33:49 -04:00
if [[ ${+_zurls[${zname}]} -ne 0 && ${_zurls[${zname}]} != ${zurl} ]]; then
print -u2 -PlR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zname}:%b Module already defined with a different URL. Expected %B${_zurls[${zname}]}%b%f" '' ${zusage}
_zfailed=1
return 2
fi
2022-05-17 19:43:59 -04:00
_zurls[${zname}]=${zurl}
2022-09-26 21:33:49 -04:00
local -r zroot_dir=${_zdirs[${zname}]}${zroot:+/${zroot}}
_zroot_dirs+=(${zroot_dir})
2022-05-17 19:43:59 -04:00
# Set default values
if (( ! ${+_ztools[${zname}]} )); then
zstyle -s ':zim:zmodule' use "_ztools[${zname}]" || _ztools[${zname}]=git
2020-06-05 23:09:23 -04:00
fi
2022-05-17 19:43:59 -04:00
if (( ! ${+_ztypes[${zname}]} )) _ztypes[${zname}]=branch
if (( ! ${+_zsubmodules[${zname}]} )) _zsubmodules[${zname}]=1
# Set values from options
2019-12-01 16:00:47 -05:00
while (( # > 0 )); do
case ${1} in
2022-10-06 20:52:57 -04:00
-b|--branch|-t|--tag|-u|--use|--on-pull|--if|-f|--fpath|-a|--autoload|-s|--source|-c|--cmd)
2019-12-01 16:00:47 -05:00
if (( # < 2 )); then
2022-05-17 19:43:59 -04:00
print -u2 -PlR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zname}:%b Missing argument for zmodule option %B${1}%b%f" '' ${zusage}
2019-12-01 16:00:47 -05:00
_zfailed=1
2021-03-19 18:13:21 -04:00
return 2
2019-12-01 16:00:47 -05:00
fi
;;
esac
2021-09-19 14:37:13 -04:00
case ${1} in
2022-01-25 09:32:50 -05:00
-b|--branch|-t|--tag|-u|--use|--no-submodules)
2022-05-17 19:43:59 -04:00
if [[ -z ${zurl} ]] _zimfw_print -u2 -PR "%F{yellow}<%= warn %>${funcfiletrace[1]}:%B${zname}:%b The zmodule option %B${1}%b has no effect for external modules%f"
2021-09-19 14:37:13 -04:00
;;
esac
2019-12-01 16:00:47 -05:00
case ${1} in
-b|--branch)
shift
2022-05-17 19:43:59 -04:00
_ztypes[${zname}]=branch
_zrevs[${zname}]=${1}
2019-12-01 16:00:47 -05:00
;;
-t|--tag)
shift
2022-05-17 19:43:59 -04:00
_ztypes[${zname}]=tag
_zrevs[${zname}]=${1}
2019-12-01 16:00:47 -05:00
;;
2021-04-03 10:35:28 -04:00
-u|--use)
shift
2022-05-17 19:43:59 -04:00
_ztools[${zname}]=${1}
2021-04-03 10:35:28 -04:00
;;
2022-05-17 19:43:59 -04:00
--no-submodules) _zsubmodules[${zname}]=0 ;;
-z|--frozen) _zfrozens[${zname}]=1 ;;
2022-05-07 17:31:08 -04:00
--on-pull)
shift
2022-09-26 21:33:49 -04:00
zarg=${1}
if [[ -n ${zroot} ]] zarg="(builtin cd -q ${zroot}; ${zarg})"
_zonpulls[${zname}]="${_zonpulls[${zname}]+${_zonpulls[${zname}]}; }${zarg}"
2022-05-07 17:31:08 -04:00
;;
2022-10-06 20:52:57 -04:00
--if)
shift
_zifs[${zroot_dir}]=${1}
;;
2019-12-01 16:00:47 -05:00
-f|--fpath)
shift
zarg=${1}
2022-09-26 21:33:49 -04:00
if [[ ${zarg} != /* ]] zarg=${zroot_dir}/${zarg}
2019-12-01 16:00:47 -05:00
zfpaths+=(${zarg})
;;
-a|--autoload)
shift
zfunctions+=(${1})
;;
-s|--source)
shift
zarg=${1}
2022-09-26 21:33:49 -04:00
if [[ ${zarg} != /* ]] zarg=${zroot_dir}/${zarg}
2023-03-30 09:38:12 -04:00
zcmds+=("source ${(q-)zarg:a}")
2020-07-02 18:16:44 -04:00
;;
-c|--cmd)
shift
2023-03-30 09:38:12 -04:00
zcmds+=(${1//{}/${(q-)zroot_dir:a}})
2019-12-01 16:00:47 -05:00
;;
2022-09-26 21:33:49 -04:00
-d|--disabled) _zdisabled_root_dirs+=(${zroot_dir}) ;;
2019-12-01 16:00:47 -05:00
*)
2022-05-17 19:43:59 -04:00
print -u2 -PlR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zname}:%b Unknown zmodule option %B${1}%b%f" '' ${zusage}
2019-12-01 16:00:47 -05:00
_zfailed=1
2021-03-19 18:13:21 -04:00
return 2
2019-12-01 16:00:47 -05:00
;;
esac
shift
done
2021-09-19 14:37:13 -04:00
if (( _zflags & 1 )); then
2022-05-17 19:43:59 -04:00
_znames+=(${zname})
2021-09-19 14:37:13 -04:00
fi
if (( _zflags & 2 )); then
2022-09-26 21:33:49 -04:00
if [[ ! -e ${zroot_dir} ]]; then
print -u2 -PR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zname}: ${zroot_dir}%b not found%f"
_zfailed=1
return 1
fi
if (( ! ${#zfpaths} && ! ${#zfunctions} && ! ${#zcmds} )); then
zfpaths=(${zroot_dir}/functions(NF))
# _* functions are autoloaded by compinit
# prompt_*_setup functions are autoloaded by promptinit
zfunctions=(${^zfpaths}/^(*~|*.zwc(|.old)|_*|prompt_*_setup)(N-.:t))
local -ra prezto_scripts=(${zroot_dir}/init.zsh(N))
if (( ${#zfpaths} && ${#prezto_scripts} )); then
# this follows the prezto module format, no need to check for other scripts
2023-03-30 09:38:12 -04:00
zcmds=('source '${(q-)^prezto_scripts:a})
2022-09-26 21:33:49 -04:00
else
# get script with largest size (descending `O`rder by `L`ength, and return only `[1]` first)
2022-10-06 20:52:57 -04:00
local -ra zscripts=(${zroot_dir}/(init.zsh|(${zname:t}|${zroot_dir:t}).(zsh|plugin.zsh|zsh-theme|sh))(NOL[1]))
2023-03-30 09:38:12 -04:00
zcmds=('source '${(q-)^zscripts:a})
2020-05-25 15:01:00 -04:00
fi
2019-12-01 16:00:47 -05:00
fi
2022-09-26 21:33:49 -04:00
if (( ! ${#zfpaths} && ! ${#zfunctions} && ! ${#zcmds} )); then
2022-10-06 20:52:57 -04:00
_zimfw_print -u2 -PlR "%F{yellow}<%= warn %>${funcfiletrace[1]}:%B${zname}:%b Nothing found to be initialized. Customize the module name, root or initialization with %Bzmodule%b options.%f" '' ${zusage}
2022-09-26 21:33:49 -04:00
fi
# Prefix is added to all _zfpaths, _zfunctions and _zcmds to distinguish the originating root dir
local -r zpre=${zroot_dir}$'\0'
_zfpaths+=(${zpre}${^zfpaths})
_zfunctions+=(${zpre}${^zfunctions})
_zcmds+=(${zpre}${^zcmds})
2019-12-01 16:00:47 -05:00
fi
}