mirror of
https://github.com/zdharma-continuum/zinit.git
synced 2026-09-10 07:36:38 -04:00
311 lines
7.5 KiB
Plaintext
311 lines
7.5 KiB
Plaintext
|
||
NAME
|
||
|
||
zinit-side.zsh - a shell script
|
||
|
||
Documentation automatically generated with `zshelldoc'
|
||
|
||
== FUNCTIONS
|
||
.zinit-any-colorify-as-uspl2
|
||
.zinit-at-eval
|
||
.zinit-compute-ice
|
||
.zinit-countdown
|
||
.zinit-exists-physically
|
||
.zinit-exists-physically-message
|
||
.zinit-first
|
||
.zinit-store-ices
|
||
.zinit-two-paths
|
||
|
||
=== DETAILS
|
||
|
||
==== Script Body
|
||
|
||
Has 1 line(s). No functions are called (may set up e.g. a hook, a Zle widget bound to a key, etc.).
|
||
|
||
==== .zinit-any-colorify-as-uspl2
|
||
|
||
____
|
||
|
||
Returns ANSI-colorified "user/plugin" string, from any supported
|
||
plugin spec (user---plugin, user/plugin, user plugin, plugin).
|
||
|
||
$1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
|
||
$2 - plugin (only when $1 - i.e. user - given)
|
||
|
||
$REPLY - ANSI-colorified "user/plugin" string
|
||
|
||
____
|
||
|
||
Has 22 line(s). Calls functions:
|
||
|
||
.zinit-any-colorify-as-uspl2
|
||
|-- zinit.zsh/.zinit-any-to-pid
|
||
`-- zinit.zsh/.zinit-any-to-user-plugin
|
||
|
||
Called by:
|
||
|
||
.zinit-exists-physically-message
|
||
zinit-autoload.zsh/.zinit-clear-completions
|
||
zinit-autoload.zsh/.zinit-compiled
|
||
zinit-autoload.zsh/.zinit-create
|
||
zinit-autoload.zsh/.zinit-exists-message
|
||
zinit-autoload.zsh/.zinit-get-completion-owner-uspl2col
|
||
zinit-autoload.zsh/.zinit-list-bindkeys
|
||
zinit-autoload.zsh/.zinit-recently
|
||
zinit-autoload.zsh/.zinit-search-completions
|
||
zinit-autoload.zsh/.zinit-show-completions
|
||
zinit-autoload.zsh/.zinit-show-times
|
||
zinit-autoload.zsh/.zinit-unload
|
||
zinit-autoload.zsh/.zinit-update-all-parallel
|
||
zinit-autoload.zsh/.zinit-update-or-status-all
|
||
zinit-autoload.zsh/.zinit-update-or-status
|
||
zinit-install.zsh/.zinit-install-completions
|
||
zinit-install.zsh/.zinit-setup-plugin-dir
|
||
zinit.zsh/.zinit-formatter-pid
|
||
|
||
==== .zinit-at-eval
|
||
|
||
____
|
||
|
||
Runs the atpull'' ice, also replaying the atclone'' one when the
|
||
atpull'%atclone' form is used.
|
||
|
||
$1 - the value of the atpull'' ice
|
||
$2 - the value of the atclone'' ice
|
||
|
||
____
|
||
|
||
Has 7 line(s). Calls functions:
|
||
|
||
.zinit-at-eval
|
||
`-- zinit.zsh/@zinit-substitute
|
||
|
||
Uses feature(s): _eval_
|
||
|
||
Called by:
|
||
|
||
zinit-install.zsh/∞zinit-atpull-e-hook
|
||
zinit-install.zsh/∞zinit-atpull-hook
|
||
|
||
==== .zinit-compute-ice
|
||
|
||
____
|
||
|
||
Computes ICE array
|
||
- input
|
||
- static
|
||
- saved
|
||
taking priorities into account.
|
||
Can also pack resulting ices into ZINIT_SICE (see $2).
|
||
Returns filepath to snippet directory and optional snippet file name (only
|
||
valid if ICE[svn] is not set).
|
||
|
||
$1 - URL (also plugin-spec)
|
||
$2 - "pack" or "nopack" or "pack-nf" - packing means ICE
|
||
wins with static ice; "pack-nf" means that disk-ices will
|
||
be ignored (no-file?)
|
||
$3 - name of output associative array, "ICE" is the default
|
||
$4 - name of output string parameter, to hold path to directory ("local_dir")
|
||
$5 - name of output string parameter, to hold filename ("filename")
|
||
$6 - name of output string parameter, to hold is-snippet 0/1-bool ("is_snippet")
|
||
|
||
$REPLY - snippet directory filepath
|
||
|
||
____
|
||
|
||
Has 110 line(s). Calls functions:
|
||
|
||
.zinit-compute-ice
|
||
|-- .zinit-exists-physically-message
|
||
| |-- .zinit-any-colorify-as-uspl2
|
||
| | |-- zinit.zsh/.zinit-any-to-pid
|
||
| | `-- zinit.zsh/.zinit-any-to-user-plugin
|
||
| |-- .zinit-exists-physically
|
||
| | `-- zinit.zsh/.zinit-any-to-user-plugin
|
||
| |-- zinit.zsh/+zi-log
|
||
| |-- zinit.zsh/.zinit-any-to-pid
|
||
| `-- zinit.zsh/.zinit-any-to-user-plugin
|
||
|-- .zinit-two-paths
|
||
| |-- .zinit-first
|
||
| | |-- zinit.zsh/.zinit-any-to-pid
|
||
| | |-- zinit.zsh/.zinit-any-to-user-plugin
|
||
| | |-- zinit.zsh/.zinit-find-other-matches
|
||
| | `-- zinit.zsh/.zinit-get-object-path
|
||
| `-- zinit.zsh/.zinit-get-object-path
|
||
|-- zinit.zsh/.zinit-any-to-user-plugin
|
||
`-- zinit.zsh/.zinit-pack-ice
|
||
|
||
Uses feature(s): _setopt_
|
||
|
||
Called by:
|
||
|
||
zinit-autoload.zsh/.zinit-compile-plugin
|
||
zinit-autoload.zsh/.zinit-edit
|
||
zinit-autoload.zsh/.zinit-recall
|
||
zinit-autoload.zsh/.zinit-uncompile-plugin
|
||
zinit-autoload.zsh/.zinit-update-or-status-snippet
|
||
zinit-autoload.zsh/.zinit-update-or-status
|
||
|
||
==== .zinit-countdown
|
||
|
||
____
|
||
|
||
Displays a countdown 5...4... etc.
|
||
|
||
$REPLY - 1 if Ctrl-C is pressed, otherwise 0
|
||
|
||
____
|
||
|
||
Has 20 line(s). Calls functions:
|
||
|
||
.zinit-countdown
|
||
`-- zinit.zsh/+zi-log
|
||
|
||
Uses feature(s): _trap_
|
||
|
||
Called by:
|
||
|
||
zinit-install.zsh/∞zinit-atclone-hook
|
||
zinit-install.zsh/∞zinit-atpull-e-hook
|
||
zinit-install.zsh/∞zinit-atpull-hook
|
||
|
||
==== .zinit-exists-physically
|
||
|
||
____
|
||
|
||
Checks if directory of given plugin exists in PLUGIN_DIR.
|
||
|
||
$1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
|
||
$2 - plugin (only when $1 - i.e. user - given)
|
||
|
||
____
|
||
|
||
Has 8 line(s). Calls functions:
|
||
|
||
.zinit-exists-physically
|
||
`-- zinit.zsh/.zinit-any-to-user-plugin
|
||
|
||
Called by:
|
||
|
||
.zinit-exists-physically-message
|
||
zinit-autoload.zsh/.zinit-create
|
||
zinit-autoload.zsh/.zinit-update-or-status
|
||
|
||
==== .zinit-exists-physically-message
|
||
|
||
____
|
||
|
||
Checks if directory of given plugin exists in PLUGIN_DIR, and outputs error
|
||
message if it doesn't.
|
||
|
||
$1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
|
||
$2 - plugin (only when $1 - i.e. user - given)
|
||
|
||
____
|
||
|
||
Has 25 line(s). Calls functions:
|
||
|
||
.zinit-exists-physically-message
|
||
|-- .zinit-any-colorify-as-uspl2
|
||
| |-- zinit.zsh/.zinit-any-to-pid
|
||
| `-- zinit.zsh/.zinit-any-to-user-plugin
|
||
|-- .zinit-exists-physically
|
||
| `-- zinit.zsh/.zinit-any-to-user-plugin
|
||
|-- zinit.zsh/+zi-log
|
||
|-- zinit.zsh/.zinit-any-to-pid
|
||
`-- zinit.zsh/.zinit-any-to-user-plugin
|
||
|
||
Uses feature(s): _setopt_
|
||
|
||
Called by:
|
||
|
||
.zinit-compute-ice
|
||
zinit-autoload.zsh/.zinit-changes
|
||
zinit-autoload.zsh/.zinit-glance
|
||
zinit-autoload.zsh/.zinit-stress
|
||
zinit-autoload.zsh/.zinit-update-or-status
|
||
zinit-install.zsh/.zinit-install-completions
|
||
|
||
==== .zinit-first
|
||
|
||
____
|
||
|
||
Finds the main file of plugin. There are multiple file name formats, they are
|
||
ordered in order starting from more correct ones, and matched.
|
||
.zinit-load-plugin() has similar code parts and doesn't call .zinit-first() –
|
||
for performance. Obscure matching is done in .zinit-find-other-matches, here
|
||
and in .zinit-load(). Obscure = non-standard main-file naming convention.
|
||
|
||
$1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
|
||
$2 - plugin (only when $1 - i.e. user - given)
|
||
|
||
____
|
||
|
||
Has 20 line(s). Calls functions:
|
||
|
||
.zinit-first
|
||
|-- zinit.zsh/.zinit-any-to-pid
|
||
|-- zinit.zsh/.zinit-any-to-user-plugin
|
||
|-- zinit.zsh/.zinit-find-other-matches
|
||
`-- zinit.zsh/.zinit-get-object-path
|
||
|
||
Called by:
|
||
|
||
.zinit-two-paths
|
||
zinit-autoload.zsh/.zinit-compile-plugin
|
||
zinit-autoload.zsh/.zinit-glance
|
||
zinit-autoload.zsh/.zinit-stress
|
||
|
||
==== .zinit-store-ices
|
||
|
||
____
|
||
|
||
Saves ice mods in given hash onto disk.
|
||
|
||
$1 - directory where to create or delete files
|
||
$2 - name of hash that holds values
|
||
$3 - additional keys of hash to store, space separated
|
||
$4 - additional keys of hash to store, empty-meaningful ices, space separated
|
||
$5 – URL, if applicable
|
||
$6 – mode, svn=1, 0=single file
|
||
|
||
____
|
||
|
||
Has 30 line(s). Doesn't call other functions.
|
||
|
||
Called by:
|
||
|
||
zinit-autoload.zsh/.zinit-update-or-status
|
||
zinit-install.zsh/.zinit-download-snippet
|
||
zinit-install.zsh/.zinit-setup-plugin-dir
|
||
|
||
==== .zinit-two-paths
|
||
|
||
____
|
||
|
||
Obtains a snippet URL without specification if it is an SVN URL (points to
|
||
directory) or regular URL (points to file), returns 2 possible paths for
|
||
further examination
|
||
|
||
$REPLY - two filepaths
|
||
|
||
____
|
||
|
||
Has 24 line(s). Calls functions:
|
||
|
||
.zinit-two-paths
|
||
|-- .zinit-first
|
||
| |-- zinit.zsh/.zinit-any-to-pid
|
||
| |-- zinit.zsh/.zinit-any-to-user-plugin
|
||
| |-- zinit.zsh/.zinit-find-other-matches
|
||
| `-- zinit.zsh/.zinit-get-object-path
|
||
`-- zinit.zsh/.zinit-get-object-path
|
||
|
||
Uses feature(s): _setopt_
|
||
|
||
Called by:
|
||
|
||
.zinit-compute-ice
|
||
zinit-autoload.zsh/.zinit-update-or-status
|
||
|