1
0
Fork 0
mirror of synced 2024-12-25 23:43:20 -05:00

Add --on-pull option to zmodule

Fixes #456
This commit is contained in:
Eric Nielsen 2022-05-07 16:31:08 -05:00
parent e0fe8ef9c9
commit 741bb78a04
No known key found for this signature in database
GPG key ID: 47D1DBFA0765A1FB
11 changed files with 119 additions and 52 deletions

View file

@ -7,7 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
_No unreleased changes._ ### Added
- `--on-pull` option to `zmodule`, which allows setting a command that is always triggered
after the module is installed or updated.
## [1.8.0] - 2022-01-25 ## [1.8.0] - 2022-01-25

View file

@ -194,6 +194,8 @@ Below are some usage examples:
`zmodule sindresorhus/pure --source async.zsh --source pure.zsh` `zmodule sindresorhus/pure --source async.zsh --source pure.zsh`
* A module with a custom initialization command: * A module with a custom initialization command:
`zmodule skywind3000/z.lua --cmd 'eval "$(lua {}/z.lua --init zsh enhanced once)"'` `zmodule skywind3000/z.lua --cmd 'eval "$(lua {}/z.lua --init zsh enhanced once)"'`
* A module with an on-pull command. It can be used to create a cached initialization script:
`zmodule skywind3000/z.lua --on-pull 'lua z.lua --init zsh enhanced once >! init.zsh'`
* A module with a big git repository: `zmodule romkatv/powerlevel10k --use degit` * A module with a big git repository: `zmodule romkatv/powerlevel10k --use degit`
<details id="zmodule-usage"> <details id="zmodule-usage">
@ -224,6 +226,8 @@ Repository options:
changes are lost on updates. Git submodules are not supported. changes are lost on updates. Git submodules are not supported.
<b>--no-submodules</b> Don&apos;t install or update git submodules. <b>--no-submodules</b> Don&apos;t install or update git submodules.
<b>-z</b>|<b>--frozen</b> Don&apos;t install or update the module. <b>-z</b>|<b>--frozen</b> Don&apos;t install or update the module.
<b>--on-pull</b> &lt;command&gt; Execute command after installing or updating the module. The com-
mand is executed in the module root directory.
Initialization options: Initialization options:
<b>-f</b>|<b>--fpath</b> &lt;path&gt; Add specified path to fpath. The path is relative to the module <b>-f</b>|<b>--fpath</b> &lt;path&gt; Add specified path to fpath. The path is relative to the module

View file

@ -24,7 +24,8 @@ Repository options:
changes are lost on updates. Git submodules are not supported. changes are lost on updates. Git submodules are not supported.
%B--no-submodules%b Don't install or update git submodules. %B--no-submodules%b Don't install or update git submodules.
%B-z%b|%B--frozen%b Don't install or update the module. %B-z%b|%B--frozen%b Don't install or update the module.
%B--on-pull%b <command> Execute command after installing or updating the module. The com-
mand is executed in the module root directory.
Initialization options: Initialization options:
%B-f%b|%B--fpath%b <path> Add specified path to fpath. The path is relative to the module %B-f%b|%B--fpath%b <path> Add specified path to fpath. The path is relative to the module
root directory. Default: %Bfunctions%b, if the subdirectory exists. root directory. Default: %Bfunctions%b, if the subdirectory exists.
@ -53,7 +54,7 @@ Initialization options:
fi fi
local zurl=${1} zmodule=${1:t} ztool zdir ztype zrev zarg local zurl=${1} zmodule=${1:t} ztool zdir ztype zrev zarg
local -i zsubmodules=1 zfrozen=0 zdisabled=0 local -i zsubmodules=1 zfrozen=0 zdisabled=0
local -a zfpaths zfunctions zcmds local -a zonpulls zfpaths zfunctions zcmds
zstyle -s ':zim:zmodule' use 'ztool' || ztool=git zstyle -s ':zim:zmodule' use 'ztool' || ztool=git
if [[ ${zurl} =~ ^[^:/]+: ]]; then if [[ ${zurl} =~ ^[^:/]+: ]]; then
zmodule=${zmodule%.git} zmodule=${zmodule%.git}
@ -83,7 +84,7 @@ Initialization options:
fi fi
while (( # > 0 )); do while (( # > 0 )); do
case ${1} in case ${1} in
-b|--branch|-t|--tag|-u|--use|-f|--fpath|-a|--autoload|-s|--source|-c|--cmd) -b|--branch|-t|--tag|-u|--use|--on-pull|-f|--fpath|-a|--autoload|-s|--source|-c|--cmd)
if (( # < 2 )); then if (( # < 2 )); then
print -u2 -PlR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zmodule}:%b Missing argument for zmodule option %B${1}%b%f" '' ${zusage} print -u2 -PlR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zmodule}:%b Missing argument for zmodule option %B${1}%b%f" '' ${zusage}
_zfailed=1 _zfailed=1
@ -113,6 +114,10 @@ Initialization options:
;; ;;
--no-submodules) zsubmodules=0 ;; --no-submodules) zsubmodules=0 ;;
-z|--frozen) zfrozen=1 ;; -z|--frozen) zfrozen=1 ;;
--on-pull)
shift
zonpulls+=(${1})
;;
-f|--fpath) -f|--fpath)
shift shift
zarg=${1} zarg=${1}
@ -143,7 +148,7 @@ Initialization options:
shift shift
done done
if (( _zflags & 1 )); then if (( _zflags & 1 )); then
_zmodules_zargs+=("${ztool}" "${_zargs_action}" "${zmodule}" "${zdir}" "${zurl}" "${ztype}" "${zrev}" "${zsubmodules}" "${zfrozen}" "${zdisabled}") _zmodules_zargs+=("${ztool}" "${_zargs_action}" "${zmodule}" "${zdir}" "${zurl}" "${ztype}" "${zrev}" "${zsubmodules}" "${(j:; :)zonpulls}" "${zfrozen}" "${zdisabled}")
fi fi
if (( _zflags & 2 )); then if (( _zflags & 2 )); then
if (( zdisabled )); then if (( zdisabled )); then

View file

@ -1,3 +1,3 @@
_zimfw_install_update() { _zimfw_install_update() {
_zimfw_source_zimrc 1 ${1} && zargs -n 10 -P 0 -- "${_zmodules_zargs[@]}" -- _zimfw_run_tool _zimfw_source_zimrc 1 ${1} && zargs -n 11 -P 0 -- "${_zmodules_zargs[@]}" -- _zimfw_run_tool
} }

View file

@ -1,6 +1,6 @@
_zimfw_run_list() { _zimfw_run_list() {
local -r ztool=${1} zmodule=${3} zdir=${4} zurl=${5} ztype=${6} zrev=${7} local -r ztool=${1} zmodule=${3} zdir=${4} zurl=${5} ztype=${6} zrev=${7} zonpull=${9}
local -ri zsubmodules=${8} zfrozen=${9} zdisabled=${10} local -ri zsubmodules=${8} zfrozen=${10} zdisabled=${11}
print -PnR "%B${zmodule}:%b ${zdir}" print -PnR "%B${zmodule}:%b ${zdir}"
if [[ -z ${zurl} ]] print -Pn ' (external)' if [[ -z ${zurl} ]] print -Pn ' (external)'
if (( ${zfrozen} )) print -Pn ' (frozen)' if (( ${zfrozen} )) print -Pn ' (frozen)'
@ -17,6 +17,7 @@ _zimfw_run_list() {
print -nR ", using ${ztool}" print -nR ", using ${ztool}"
if (( ! zsubmodules )) print -nR ', no git submodules' if (( ! zsubmodules )) print -nR ', no git submodules'
print print
if [[ -n ${zonpull} ]] print -R " On-pull: ${zonpull}"
fi fi
# Match and remove the current module prefix from _zfpaths, _zfunctions and _zcmds # Match and remove the current module prefix from _zfpaths, _zfunctions and _zcmds
local -r zpre=${zmodule}$'\0' local -r zpre=${zmodule}$'\0'

View file

@ -4,7 +4,7 @@ _zimfw_run_tool() {
if (( _zprintlevel > 1 )) print -u2 -PR <%= clear_line %>"<%= okay %>%B${zmodule}:%b Skipping external module" if (( _zprintlevel > 1 )) print -u2 -PR <%= clear_line %>"<%= okay %>%B${zmodule}:%b Skipping external module"
return 0 return 0
fi fi
local -ri zfrozen=${9} local -ri zfrozen=${10}
if (( zfrozen )); then if (( zfrozen )); then
if (( _zprintlevel > 1 )) print -u2 -PR <%= clear_line %>"<%= okay %>%B${zmodule}:%b Skipping frozen module" if (( _zprintlevel > 1 )) print -u2 -PR <%= clear_line %>"<%= okay %>%B${zmodule}:%b Skipping frozen module"
return 0 return 0
@ -37,5 +37,5 @@ _zimfw_run_tool() {
return 1 return 1
;; ;;
esac esac
zsh -c ${zcmd} ${ztool} ${_zprintlevel} "${@[2,8]}" zsh -c ${zcmd} ${ztool} ${_zprintlevel} "${@[2,9]}"
} }

View file

@ -16,10 +16,10 @@ Actions:
Use %B-v%b to also see the modules details. Use %B-v%b to also see the modules details.
%Binit%b Same as %Binstall%b, but with output tailored to be used at terminal startup. %Binit%b Same as %Binstall%b, but with output tailored to be used at terminal startup.
%Binstall%b Install new modules. Also does %Bbuild%b, %Bcheck-dumpfile%b and %Bcompile%b. Use %B-v%b to %Binstall%b Install new modules. Also does %Bbuild%b, %Bcheck-dumpfile%b and %Bcompile%b. Use %B-v%b to
also see their output, and see skipped modules. also see their output, any on-pull output, and see skipped modules.
%Buninstall%b Delete unused modules. Prompts for confirmation. Use %B-q%b for quiet uninstall. %Buninstall%b Delete unused modules. Prompts for confirmation. Use %B-q%b for quiet uninstall.
%Bupdate%b Update current modules. Also does %Bbuild%b, %Bcheck-dumpfile%b and %Bcompile%b. Use %B-v%b %Bupdate%b Update current modules. Also does %Bbuild%b, %Bcheck-dumpfile%b and %Bcompile%b. Use %B-v%b
to also see their output, and see skipped modules. to also see their output, any on-pull output, and see skipped modules.
%Bupgrade%b Upgrade zimfw. Also does %Bcompile%b. Use %B-v%b to also see its output. %Bupgrade%b Upgrade zimfw. Also does %Bcompile%b. Use %B-v%b to also see its output.
%Bversion%b Print zimfw version. %Bversion%b Print zimfw version.
@ -61,7 +61,7 @@ Options:
help) print -PR ${zusage} ;; help) print -PR ${zusage} ;;
info) _zimfw_info ;; info) _zimfw_info ;;
list) list)
_zimfw_source_zimrc 3 && zargs -n 10 -- "${_zmodules_zargs[@]}" -- _zimfw_run_list && \ _zimfw_source_zimrc 3 && zargs -n 11 -- "${_zmodules_zargs[@]}" -- _zimfw_run_list && \
_zimfw_list_unuseds ' (unused)' _zimfw_list_unuseds ' (unused)'
;; ;;
init) init)

View file

@ -1,7 +1,7 @@
# This runs in a new shell # This runs in a new shell
builtin emulate -L zsh -o EXTENDED_GLOB builtin emulate -L zsh -o EXTENDED_GLOB
readonly -i PRINTLEVEL=${1} SUBMODULES=${8} readonly -i PRINTLEVEL=${1} SUBMODULES=${8}
readonly ACTION=${2} MODULE=${3} DIR=${4} URL=${5} REV=${7} TEMP=.zdegit_${RANDOM} readonly ACTION=${2} MODULE=${3} DIR=${4} URL=${5} REV=${7} ONPULL=${9} TEMP=.zdegit_${RANDOM}
readonly TARBALL_TARGET=${DIR}/${TEMP}_tarball.tar.gz INFO_TARGET=${DIR}/.zdegit readonly TARBALL_TARGET=${DIR}/${TEMP}_tarball.tar.gz INFO_TARGET=${DIR}/.zdegit
print_error() { print_error() {
@ -12,13 +12,25 @@ print_okay() {
if (( PRINTLEVEL > 0 )); then if (( PRINTLEVEL > 0 )); then
local -r log=${2:+${(F):- ${(f)^2}}} local -r log=${2:+${(F):- ${(f)^2}}}
if [[ ${SUBMODULES} -ne 0 && -e ${DIR}/.gitmodules ]]; then if [[ ${SUBMODULES} -ne 0 && -e ${DIR}/.gitmodules ]]; then
print -u2 -PlR <%= clear_line %>"%F{yellow}<%= warn %>%B${MODULE}:%b ${(C)1}. Module contains git submodules, which are not supported by Zim's degit and were not ${1}. Use zmodule option %B--no-submodules%b to disable this warning.%f" ${log} print -u2 -PlR <%= clear_line %>"%F{yellow}<%= warn %>%B${MODULE}:%b ${1}. Module contains git submodules, which are not supported by Zim's degit. Use zmodule option %B--no-submodules%b to disable this warning.%f" ${log}
else else
print -PlR <%= clear_line %>"<%= okay %>%B${MODULE}:%b ${(C)1}" ${log} print -PlR <%= clear_line %>"<%= okay %>%B${MODULE}:%b ${1}" ${log}
fi fi
fi fi
} }
handle() {
if [[ -n ${ONPULL} ]]; then
if ! ERR=$(builtin cd -q ${DIR} 2>&1 && eval ${ONPULL} 2>&1); then
print_error 'Error during on-pull' ${ERR}
return 1
elif [[ ${PRINTLEVEL} -gt 1 && -n ${ERR} ]]; then
set ${1} ${2:+${2}$'\n'}"On-pull output:"$'\n'${ERR}
fi
fi
print_okay "${@}"
}
download_tarball() { download_tarball() {
local host repo local host repo
if [[ ${URL} =~ <%= url_regex %> ]]; then if [[ ${URL} =~ <%= url_regex %> ]]; then
@ -98,7 +110,7 @@ create_dir() {
case ${ACTION} in case ${ACTION} in
install) install)
{ {
create_dir ${DIR} && download_tarball && untar_tarball ${DIR} && print_okay installed create_dir ${DIR} && download_tarball && untar_tarball ${DIR} && handle Installed
} always { } always {
# return 1 does not change ${TRY_BLOCK_ERROR}, only changes ${?} # return 1 does not change ${TRY_BLOCK_ERROR}, only changes ${?}
(( TRY_BLOCK_ERROR = ? )) (( TRY_BLOCK_ERROR = ? ))
@ -117,8 +129,8 @@ case ${ACTION} in
{ {
download_tarball || return 1 download_tarball || return 1
if [[ ! -e ${TARBALL_TARGET} ]]; then if [[ ! -e ${TARBALL_TARGET} ]]; then
if (( PRINTLEVEL > 0 )) print -PR <%= clear_line %>"<%= okay %>%B${MODULE}:%b Already up to date" handle 'Already up to date'
return 0 return ${?}
fi fi
create_dir ${DIR_NEW} && untar_tarball ${DIR_NEW} || return 1 create_dir ${DIR_NEW} && untar_tarball ${DIR_NEW} || return 1
if (( ${+commands[diff]} )); then if (( ${+commands[diff]} )); then
@ -130,7 +142,7 @@ case ${ACTION} in
print_error "Error updating ${DIR}" ${ERR} print_error "Error updating ${DIR}" ${ERR}
return 1 return 1
fi fi
print_okay updated ${LOG} handle Updated ${LOG}
} always { } always {
command rm -f ${TARBALL_TARGET} 2>/dev/null command rm -f ${TARBALL_TARGET} 2>/dev/null
command rm -rf ${DIR_NEW} 2>/dev/null command rm -rf ${DIR_NEW} 2>/dev/null

View file

@ -1,7 +1,7 @@
# This runs in a new shell # This runs in a new shell
builtin emulate -L zsh builtin emulate -L zsh
readonly -i PRINTLEVEL=${1} SUBMODULES=${8} readonly -i PRINTLEVEL=${1} SUBMODULES=${8}
readonly ACTION=${2} MODULE=${3} DIR=${4} URL=${5} TYPE=${6:=branch} readonly ACTION=${2} MODULE=${3} DIR=${4} URL=${5} TYPE=${6:=branch} ONPULL=${9}
REV=${7} REV=${7}
print_error() { print_error() {
@ -12,10 +12,22 @@ print_okay() {
if (( PRINTLEVEL > 0 )) print -PlR <%= clear_line %>"<%= okay %>%B${MODULE}:%b ${1}" ${2:+${(F):- ${(f)^2}}} if (( PRINTLEVEL > 0 )) print -PlR <%= clear_line %>"<%= okay %>%B${MODULE}:%b ${1}" ${2:+${(F):- ${(f)^2}}}
} }
handle() {
if [[ -n ${ONPULL} ]]; then
if ! ERR=$(builtin cd -q ${DIR} 2>&1 && eval ${ONPULL} 2>&1); then
print_error 'Error during on-pull' ${ERR}
return 1
elif [[ ${PRINTLEVEL} -gt 1 && -n ${ERR} ]]; then
set ${1} ${2:+${2}$'\n'}"On-pull output:"$'\n'${ERR}
fi
fi
print_okay "${@}"
}
case ${ACTION} in case ${ACTION} in
install) install)
if ERR=$(command git clone ${REV:+-b} ${REV} -q --config core.autocrlf=false ${${SUBMODULES:#0}:+--recursive} -- ${URL} ${DIR} 2>&1); then if ERR=$(command git clone ${REV:+-b} ${REV} -q --config core.autocrlf=false ${${SUBMODULES:#0}:+--recursive} -- ${URL} ${DIR} 2>&1); then
print_okay Installed handle Installed
else else
print_error 'Error during git clone' ${ERR} print_error 'Error during git clone' ${ERR}
return 1 return 1
@ -38,8 +50,8 @@ case ${ACTION} in
fi fi
if [[ ${TYPE} == tag ]]; then if [[ ${TYPE} == tag ]]; then
if [[ ${REV} == $(command git -C ${DIR} describe --tags --exact-match 2>/dev/null) ]]; then if [[ ${REV} == $(command git -C ${DIR} describe --tags --exact-match 2>/dev/null) ]]; then
print_okay 'Already up to date' handle 'Already up to date'
return 0 return ${?}
fi fi
elif [[ -z ${REV} ]]; then elif [[ -z ${REV} ]]; then
# Get HEAD remote branch # Get HEAD remote branch
@ -80,6 +92,6 @@ case ${ACTION} in
return 1 return 1
fi fi
fi fi
print_okay ${OUT} ${LOG} handle ${OUT} ${LOG}
;; ;;
esac esac

View file

@ -4,7 +4,7 @@ class Zim
:clear_line, :ellipsis, :okay, :warn, :error, :done, :failed :clear_line, :ellipsis, :okay, :warn, :error, :done, :failed
def initialize def initialize
@version = "1.8.0" @version = "1.9.0-SNAPSHOT"
@home = "${ZDOTDIR:-${HOME}}" @home = "${ZDOTDIR:-${HOME}}"
@min_zsh_version = "5.2" @min_zsh_version = "5.2"
# Matches {ssh,http,https,git}://{user@,}host/org/repo and {user@,}host:org/repo # Matches {ssh,http,https,git}://{user@,}host/org/repo and {user@,}host:org/repo

View file

@ -110,7 +110,8 @@ Repository options:
changes are lost on updates. Git submodules are not supported. changes are lost on updates. Git submodules are not supported.
%B--no-submodules%b Don't install or update git submodules. %B--no-submodules%b Don't install or update git submodules.
%B-z%b|%B--frozen%b Don't install or update the module. %B-z%b|%B--frozen%b Don't install or update the module.
%B--on-pull%b <command> Execute command after installing or updating the module. The com-
mand is executed in the module root directory.
Initialization options: Initialization options:
%B-f%b|%B--fpath%b <path> Add specified path to fpath. The path is relative to the module %B-f%b|%B--fpath%b <path> Add specified path to fpath. The path is relative to the module
root directory. Default: %Bfunctions%b, if the subdirectory exists. root directory. Default: %Bfunctions%b, if the subdirectory exists.
@ -139,7 +140,7 @@ Initialization options:
fi fi
local zurl=${1} zmodule=${1:t} ztool zdir ztype zrev zarg local zurl=${1} zmodule=${1:t} ztool zdir ztype zrev zarg
local -i zsubmodules=1 zfrozen=0 zdisabled=0 local -i zsubmodules=1 zfrozen=0 zdisabled=0
local -a zfpaths zfunctions zcmds local -a zonpulls zfpaths zfunctions zcmds
zstyle -s ':zim:zmodule' use 'ztool' || ztool=git zstyle -s ':zim:zmodule' use 'ztool' || ztool=git
if [[ ${zurl} =~ ^[^:/]+: ]]; then if [[ ${zurl} =~ ^[^:/]+: ]]; then
zmodule=${zmodule%.git} zmodule=${zmodule%.git}
@ -169,7 +170,7 @@ Initialization options:
fi fi
while (( # > 0 )); do while (( # > 0 )); do
case ${1} in case ${1} in
-b|--branch|-t|--tag|-u|--use|-f|--fpath|-a|--autoload|-s|--source|-c|--cmd) -b|--branch|-t|--tag|-u|--use|--on-pull|-f|--fpath|-a|--autoload|-s|--source|-c|--cmd)
if (( # < 2 )); then if (( # < 2 )); then
print -u2 -PlR "%F{red}x ${funcfiletrace[1]}:%B${zmodule}:%b Missing argument for zmodule option %B${1}%b%f" '' ${zusage} print -u2 -PlR "%F{red}x ${funcfiletrace[1]}:%B${zmodule}:%b Missing argument for zmodule option %B${1}%b%f" '' ${zusage}
_zfailed=1 _zfailed=1
@ -199,6 +200,10 @@ Initialization options:
;; ;;
--no-submodules) zsubmodules=0 ;; --no-submodules) zsubmodules=0 ;;
-z|--frozen) zfrozen=1 ;; -z|--frozen) zfrozen=1 ;;
--on-pull)
shift
zonpulls+=(${1})
;;
-f|--fpath) -f|--fpath)
shift shift
zarg=${1} zarg=${1}
@ -229,7 +234,7 @@ Initialization options:
shift shift
done done
if (( _zflags & 1 )); then if (( _zflags & 1 )); then
_zmodules_zargs+=("${ztool}" "${_zargs_action}" "${zmodule}" "${zdir}" "${zurl}" "${ztype}" "${zrev}" "${zsubmodules}" "${zfrozen}" "${zdisabled}") _zmodules_zargs+=("${ztool}" "${_zargs_action}" "${zmodule}" "${zdir}" "${zurl}" "${ztype}" "${zrev}" "${zsubmodules}" "${(j:; :)zonpulls}" "${zfrozen}" "${zdisabled}")
fi fi
if (( _zflags & 2 )); then if (( _zflags & 2 )); then
if (( zdisabled )); then if (( zdisabled )); then
@ -379,14 +384,14 @@ _zimfw_compile() {
} }
_zimfw_info() { _zimfw_info() {
print -R 'zimfw version: '${_zversion}' (built at 2022-01-25 22:16:46 UTC, previous commit is 72fe20c)' print -R 'zimfw version: '${_zversion}' (built at 2022-05-07 21:29:52 UTC, previous commit is e0fe8ef)'
print -R 'ZIM_HOME: '${ZIM_HOME} print -R 'ZIM_HOME: '${ZIM_HOME}
print -R 'Zsh version: '${ZSH_VERSION} print -R 'Zsh version: '${ZSH_VERSION}
print -R 'System info: '$(command uname -a) print -R 'System info: '$(command uname -a)
} }
_zimfw_install_update() { _zimfw_install_update() {
_zimfw_source_zimrc 1 ${1} && zargs -n 10 -P 0 -- "${_zmodules_zargs[@]}" -- _zimfw_run_tool _zimfw_source_zimrc 1 ${1} && zargs -n 11 -P 0 -- "${_zmodules_zargs[@]}" -- _zimfw_run_tool
} }
_zimfw_uninstall() { _zimfw_uninstall() {
@ -427,8 +432,8 @@ _zimfw_upgrade() {
} }
_zimfw_run_list() { _zimfw_run_list() {
local -r ztool=${1} zmodule=${3} zdir=${4} zurl=${5} ztype=${6} zrev=${7} local -r ztool=${1} zmodule=${3} zdir=${4} zurl=${5} ztype=${6} zrev=${7} zonpull=${9}
local -ri zsubmodules=${8} zfrozen=${9} zdisabled=${10} local -ri zsubmodules=${8} zfrozen=${10} zdisabled=${11}
print -PnR "%B${zmodule}:%b ${zdir}" print -PnR "%B${zmodule}:%b ${zdir}"
if [[ -z ${zurl} ]] print -Pn ' (external)' if [[ -z ${zurl} ]] print -Pn ' (external)'
if (( ${zfrozen} )) print -Pn ' (frozen)' if (( ${zfrozen} )) print -Pn ' (frozen)'
@ -445,6 +450,7 @@ _zimfw_run_list() {
print -nR ", using ${ztool}" print -nR ", using ${ztool}"
if (( ! zsubmodules )) print -nR ', no git submodules' if (( ! zsubmodules )) print -nR ', no git submodules'
print print
if [[ -n ${zonpull} ]] print -R " On-pull: ${zonpull}"
fi fi
# Match and remove the current module prefix from _zfpaths, _zfunctions and _zcmds # Match and remove the current module prefix from _zfpaths, _zfunctions and _zcmds
local -r zpre=${zmodule}$'\0' local -r zpre=${zmodule}$'\0'
@ -461,7 +467,7 @@ _zimfw_run_tool() {
if (( _zprintlevel > 1 )) print -u2 -PR $'\E[2K\r'"%F{green})%f %B${zmodule}:%b Skipping external module" if (( _zprintlevel > 1 )) print -u2 -PR $'\E[2K\r'"%F{green})%f %B${zmodule}:%b Skipping external module"
return 0 return 0
fi fi
local -ri zfrozen=${9} local -ri zfrozen=${10}
if (( zfrozen )); then if (( zfrozen )); then
if (( _zprintlevel > 1 )) print -u2 -PR $'\E[2K\r'"%F{green})%f %B${zmodule}:%b Skipping frozen module" if (( _zprintlevel > 1 )) print -u2 -PR $'\E[2K\r'"%F{green})%f %B${zmodule}:%b Skipping frozen module"
return 0 return 0
@ -491,7 +497,7 @@ _zimfw_run_tool() {
degit) zcmd="# This runs in a new shell degit) zcmd="# This runs in a new shell
builtin emulate -L zsh -o EXTENDED_GLOB builtin emulate -L zsh -o EXTENDED_GLOB
readonly -i PRINTLEVEL=\${1} SUBMODULES=\${8} readonly -i PRINTLEVEL=\${1} SUBMODULES=\${8}
readonly ACTION=\${2} MODULE=\${3} DIR=\${4} URL=\${5} REV=\${7} TEMP=.zdegit_\${RANDOM} readonly ACTION=\${2} MODULE=\${3} DIR=\${4} URL=\${5} REV=\${7} ONPULL=\${9} TEMP=.zdegit_\${RANDOM}
readonly TARBALL_TARGET=\${DIR}/\${TEMP}_tarball.tar.gz INFO_TARGET=\${DIR}/.zdegit readonly TARBALL_TARGET=\${DIR}/\${TEMP}_tarball.tar.gz INFO_TARGET=\${DIR}/.zdegit
print_error() { print_error() {
@ -502,13 +508,25 @@ print_okay() {
if (( PRINTLEVEL > 0 )); then if (( PRINTLEVEL > 0 )); then
local -r log=\${2:+\${(F):- \${(f)^2}}} local -r log=\${2:+\${(F):- \${(f)^2}}}
if [[ \${SUBMODULES} -ne 0 && -e \${DIR}/.gitmodules ]]; then if [[ \${SUBMODULES} -ne 0 && -e \${DIR}/.gitmodules ]]; then
print -u2 -PlR $'\E[2K\r'\"%F{yellow}! %B\${MODULE}:%b \${(C)1}. Module contains git submodules, which are not supported by Zim's degit and were not \${1}. Use zmodule option %B--no-submodules%b to disable this warning.%f\" \${log} print -u2 -PlR $'\E[2K\r'\"%F{yellow}! %B\${MODULE}:%b \${1}. Module contains git submodules, which are not supported by Zim's degit. Use zmodule option %B--no-submodules%b to disable this warning.%f\" \${log}
else else
print -PlR $'\E[2K\r'\"%F{green})%f %B\${MODULE}:%b \${(C)1}\" \${log} print -PlR $'\E[2K\r'\"%F{green})%f %B\${MODULE}:%b \${1}\" \${log}
fi fi
fi fi
} }
handle() {
if [[ -n \${ONPULL} ]]; then
if ! ERR=\$(builtin cd -q \${DIR} 2>&1 && eval \${ONPULL} 2>&1); then
print_error 'Error during on-pull' \${ERR}
return 1
elif [[ \${PRINTLEVEL} -gt 1 && -n \${ERR} ]]; then
set \${1} \${2:+\${2}$'\n'}\"On-pull output:\"$'\n'\${ERR}
fi
fi
print_okay \"\${@}\"
}
download_tarball() { download_tarball() {
local host repo local host repo
if [[ \${URL} =~ ^([^:@/]+://)?([^@]+@)?([^:/]+)[:/]([^/]+/[^/]+)/?\$ ]]; then if [[ \${URL} =~ ^([^:@/]+://)?([^@]+@)?([^:/]+)[:/]([^/]+/[^/]+)/?\$ ]]; then
@ -588,7 +606,7 @@ create_dir() {
case \${ACTION} in case \${ACTION} in
install) install)
{ {
create_dir \${DIR} && download_tarball && untar_tarball \${DIR} && print_okay installed create_dir \${DIR} && download_tarball && untar_tarball \${DIR} && handle Installed
} always { } always {
# return 1 does not change \${TRY_BLOCK_ERROR}, only changes \${?} # return 1 does not change \${TRY_BLOCK_ERROR}, only changes \${?}
(( TRY_BLOCK_ERROR = ? )) (( TRY_BLOCK_ERROR = ? ))
@ -607,8 +625,8 @@ case \${ACTION} in
{ {
download_tarball || return 1 download_tarball || return 1
if [[ ! -e \${TARBALL_TARGET} ]]; then if [[ ! -e \${TARBALL_TARGET} ]]; then
if (( PRINTLEVEL > 0 )) print -PR $'\E[2K\r'\"%F{green})%f %B\${MODULE}:%b Already up to date\" handle 'Already up to date'
return 0 return \${?}
fi fi
create_dir \${DIR_NEW} && untar_tarball \${DIR_NEW} || return 1 create_dir \${DIR_NEW} && untar_tarball \${DIR_NEW} || return 1
if (( \${+commands[diff]} )); then if (( \${+commands[diff]} )); then
@ -620,7 +638,7 @@ case \${ACTION} in
print_error \"Error updating \${DIR}\" \${ERR} print_error \"Error updating \${DIR}\" \${ERR}
return 1 return 1
fi fi
print_okay updated \${LOG} handle Updated \${LOG}
} always { } always {
command rm -f \${TARBALL_TARGET} 2>/dev/null command rm -f \${TARBALL_TARGET} 2>/dev/null
command rm -rf \${DIR_NEW} 2>/dev/null command rm -rf \${DIR_NEW} 2>/dev/null
@ -631,7 +649,7 @@ esac
git) zcmd="# This runs in a new shell git) zcmd="# This runs in a new shell
builtin emulate -L zsh builtin emulate -L zsh
readonly -i PRINTLEVEL=\${1} SUBMODULES=\${8} readonly -i PRINTLEVEL=\${1} SUBMODULES=\${8}
readonly ACTION=\${2} MODULE=\${3} DIR=\${4} URL=\${5} TYPE=\${6:=branch} readonly ACTION=\${2} MODULE=\${3} DIR=\${4} URL=\${5} TYPE=\${6:=branch} ONPULL=\${9}
REV=\${7} REV=\${7}
print_error() { print_error() {
@ -642,10 +660,22 @@ print_okay() {
if (( PRINTLEVEL > 0 )) print -PlR $'\E[2K\r'\"%F{green})%f %B\${MODULE}:%b \${1}\" \${2:+\${(F):- \${(f)^2}}} if (( PRINTLEVEL > 0 )) print -PlR $'\E[2K\r'\"%F{green})%f %B\${MODULE}:%b \${1}\" \${2:+\${(F):- \${(f)^2}}}
} }
handle() {
if [[ -n \${ONPULL} ]]; then
if ! ERR=\$(builtin cd -q \${DIR} 2>&1 && eval \${ONPULL} 2>&1); then
print_error 'Error during on-pull' \${ERR}
return 1
elif [[ \${PRINTLEVEL} -gt 1 && -n \${ERR} ]]; then
set \${1} \${2:+\${2}$'\n'}\"On-pull output:\"$'\n'\${ERR}
fi
fi
print_okay \"\${@}\"
}
case \${ACTION} in case \${ACTION} in
install) install)
if ERR=\$(command git clone \${REV:+-b} \${REV} -q --config core.autocrlf=false \${\${SUBMODULES:#0}:+--recursive} -- \${URL} \${DIR} 2>&1); then if ERR=\$(command git clone \${REV:+-b} \${REV} -q --config core.autocrlf=false \${\${SUBMODULES:#0}:+--recursive} -- \${URL} \${DIR} 2>&1); then
print_okay Installed handle Installed
else else
print_error 'Error during git clone' \${ERR} print_error 'Error during git clone' \${ERR}
return 1 return 1
@ -668,8 +698,8 @@ case \${ACTION} in
fi fi
if [[ \${TYPE} == tag ]]; then if [[ \${TYPE} == tag ]]; then
if [[ \${REV} == \$(command git -C \${DIR} describe --tags --exact-match 2>/dev/null) ]]; then if [[ \${REV} == \$(command git -C \${DIR} describe --tags --exact-match 2>/dev/null) ]]; then
print_okay 'Already up to date' handle 'Already up to date'
return 0 return \${?}
fi fi
elif [[ -z \${REV} ]]; then elif [[ -z \${REV} ]]; then
# Get HEAD remote branch # Get HEAD remote branch
@ -710,7 +740,7 @@ case \${ACTION} in
return 1 return 1
fi fi
fi fi
print_okay \${OUT} \${LOG} handle \${OUT} \${LOG}
;; ;;
esac esac
" ;; " ;;
@ -719,12 +749,12 @@ esac
return 1 return 1
;; ;;
esac esac
zsh -c ${zcmd} ${ztool} ${_zprintlevel} "${@[2,8]}" zsh -c ${zcmd} ${ztool} ${_zprintlevel} "${@[2,9]}"
} }
zimfw() { zimfw() {
builtin emulate -L zsh -o EXTENDED_GLOB builtin emulate -L zsh -o EXTENDED_GLOB
local -r _zversion='1.8.0' zusage="Usage: %B${0}%b <action> [%B-q%b|%B-v%b] local -r _zversion='1.9.0-SNAPSHOT' zusage="Usage: %B${0}%b <action> [%B-q%b|%B-v%b]
Actions: Actions:
%Bbuild%b Build %B${ZIM_HOME}/init.zsh%b and %B${ZIM_HOME}/login_init.zsh%b. %Bbuild%b Build %B${ZIM_HOME}/init.zsh%b and %B${ZIM_HOME}/login_init.zsh%b.
@ -740,10 +770,10 @@ Actions:
Use %B-v%b to also see the modules details. Use %B-v%b to also see the modules details.
%Binit%b Same as %Binstall%b, but with output tailored to be used at terminal startup. %Binit%b Same as %Binstall%b, but with output tailored to be used at terminal startup.
%Binstall%b Install new modules. Also does %Bbuild%b, %Bcheck-dumpfile%b and %Bcompile%b. Use %B-v%b to %Binstall%b Install new modules. Also does %Bbuild%b, %Bcheck-dumpfile%b and %Bcompile%b. Use %B-v%b to
also see their output, and see skipped modules. also see their output, any on-pull output, and see skipped modules.
%Buninstall%b Delete unused modules. Prompts for confirmation. Use %B-q%b for quiet uninstall. %Buninstall%b Delete unused modules. Prompts for confirmation. Use %B-q%b for quiet uninstall.
%Bupdate%b Update current modules. Also does %Bbuild%b, %Bcheck-dumpfile%b and %Bcompile%b. Use %B-v%b %Bupdate%b Update current modules. Also does %Bbuild%b, %Bcheck-dumpfile%b and %Bcompile%b. Use %B-v%b
to also see their output, and see skipped modules. to also see their output, any on-pull output, and see skipped modules.
%Bupgrade%b Upgrade zimfw. Also does %Bcompile%b. Use %B-v%b to also see its output. %Bupgrade%b Upgrade zimfw. Also does %Bcompile%b. Use %B-v%b to also see its output.
%Bversion%b Print zimfw version. %Bversion%b Print zimfw version.
@ -785,7 +815,7 @@ Options:
help) print -PR ${zusage} ;; help) print -PR ${zusage} ;;
info) _zimfw_info ;; info) _zimfw_info ;;
list) list)
_zimfw_source_zimrc 3 && zargs -n 10 -- "${_zmodules_zargs[@]}" -- _zimfw_run_list && \ _zimfw_source_zimrc 3 && zargs -n 11 -- "${_zmodules_zargs[@]}" -- _zimfw_run_list && \
_zimfw_list_unuseds ' (unused)' _zimfw_list_unuseds ' (unused)'
;; ;;
init) init)