メインコンテンツまでスキップ

☑️ 概要

この概要では、以下の基礎を説明します。

  1. Oh-My-Zsh & Prezto
  2. Completions
  3. Turbo mode
  4. Ice modifiers

プラグインとスニペットの読み込み​

zi load z-shell/H-S-MW
zi light zsh-users/zsh-syntax-highlighting

上記のコマンドは2通りの基本的なプラグインの読み込み方法です。 If you want to source local or remote files (using a direct URL), you can do so with a snippet.

zi snippet <URL>

Such lines should be added to .zshrc. Snippets are cached locally, use the -f option to download a fresh version of a snippet, or zi update {URL}. Use zi update --all to update all snippets and plugins.

Using load causes reporting to be enabled – you can track what the plugin does, view the information with zi report {plugin-name}, and then also unload the plugin with zi unload {plugin-name}.

Using light is a faster loading without tracking and reporting about the plugin but also withdrawing the ability to unload it.

Using load or light:

zi load  <repo/plugin> # Load with reporting/investigating.
zi light <repo/plugin> # Load without reporting/investigating.

プラグイン history-search-multi-word が調査しながら読み込み:

zi load z-shell/H-S-MW

2つの通常のプラグインを調査せずに読み込み:

zi light zsh-users/zsh-autosuggestions
zi light z-shell/F-Sy-H

スニペット:

zi snippet https://gist.githubusercontent.com/hightemp/5071909/raw/
备注

In turbo mode loading, the slowdown by plugin tracking is done in the background and does not affect the user experience, i.e., loading with zi light and zi load has the same effect.

Oh-My-Zsh, Prezto​

To load Oh-My-Zsh and Prezto plugins, use the snippet feature. Snippets are single files downloaded by curl, wget, etc., automatic detection of the download tool is being performed, directly from the URL:

zi snippet 'https://github.com/robbyrussell/oh-my-zsh/raw/master/plugins/git/git.plugin.zsh'
zi snippet 'https://github.com/sorin-ionescu/prezto/blob/master/modules/helper/init.zsh'

Also, for Oh-My-Zsh and Prezto, you can use OMZ:: and PZT:: shorthands:

zi snippet OMZ::plugins/git/git.plugin.zsh
zi snippet PZT::modules/helper/init.zsh

さらに、GitHubはスニペットのためにSubversionプロトコルをサポートしています。 This allows loading snippets that are multi-file (for example, a Prezto module can consist of two or more files, e.g. init.zsh and alias.zsh).

Default files that will be sourced are: *.plugin.zsh, init.zsh, *.zsh-theme:

URLはディレクトリを指します:

zi ice svn
zi snippet PZT::modules/docker

スニペットとパフォーマンス​

Using curl, wget, etc. along with Subversion allows us to almost completely avoid code dedicated to Oh-My-Zsh and Prezto, and also to other frameworks. メモリへの負荷が少なく、ロード時間も短いため、より高いパフォーマンスを実現します。

Ice 修飾子​

The command zi ice provides ice modifiers for the single Zi command, i.e., zi ice <some-ice-modifier>; zi load some/plugin, after loading some/plugin the ice-modifier has to be set again.

この考え方は、"氷"が飲み物やコーヒーに入れられるようなもので、これをZIに置き換えると、iceは次のZIコマンドへ変更を与えることを意味しています。 また、溶けること(つまり長く続かない)は、Ziの中ではその変更は次のZIコマンドにのみ有効ということです。

Using one other ice modifier "pick" users can explicitly select the file to source:

zi ice svn pick"init.zsh"
zi snippet PZT::modules/git

The content of the ice-modifier is simply put into "…", '…', $'…'. No need for ":" after the ice-modifier name (although it's allowed: as the equal sign =, e.g. pick="init.zsh" or pick=init.zsh).

This way editors like vim and emacs and also zsh-users/zsh-syntax-highlighting and z-shell/F-Sy-H will highlight the contents of ice-modifiers.

as"program" について​

A plugin might not be a file for sourcing, but a command to be added to $PATH. To obtain this effect, use ice-modifier as with value program (or an alias value command).

zi ice as"program" cp"httpstat.sh -> httpstat" pick"httpstat"
zi light b4b4r07/httpstat

The above command will add plugin directory to $PATH, copy file httpstat.sh into httpstat and add execution rights (+x) to the file selected with pick, i.e. to httpstat. Another ice-mod exists, mv, which works like cp but moves a file instead of copying it. mv is run before cp.

tip

The cp and mv ices (and also some other ones, like atclone) are being run when the plugin or snippet is being installed. To test them again first delete the plugin or snippet (example: zi delete PZT::modules/osx).

Ice 修飾子: atpull'…'​

Copying file is safe for doing later updates – original files of the repository are unmodified and Git will report no conflicts. However, mv also can be used, if a proper atpull, an ice-modifier ran at update of the plugin:

zi ice as"program" mv"httpstat.sh -> httpstat" \
  pick"httpstat" atpull'!git reset --hard'
zi light b4b4r07/httpstat

If atpull starts with an exclamation mark, then it will be run before git pull, and before mv. Nevertheless, atpull, mv, and cp are run only if new commits are to be fetched.

So in summary, when the user runs zi update b4b4r07/httpstat to update this plugin, and there are new commits, what happens first is that git reset --hard is run – and it restores original httpstat.sh, then git pull is ran and it downloads new commits (doing fast-forward), then mv is running again so that the command is httpstat not httpstat.sh.

This way the mv ice can be used to induce permanent changes into the plugin's contents without blocking the ability to update it with git or with subversion in the case of snippets.

info

For exclamation marks to not be expanded by Zsh an interactive session, use '…' not "…" to enclose contents of atpull ice-modifier.

Ice 修飾子: subscribe'…'​

このice修飾子は、与えられたファイル(複数可) の更新時間をチェックしながらプラグインの読み込みを延期し、変更されるとプラグインまたはスニペットの読み込みを実行します。

Copy and paste the example below to the terminal or add it to the .zshrc file and reload the shell with exec zsh.

zi ice subscribe'{~/files-*,/tmp/files-*}' id-as'z-sub' lucid \
  atload'+zi-message "{profile}I have been loaded{nl}\
  {auto}\`Zi Rocks ♥\`"' notify"Yes that is cool ♥ "
zi load z-shell/0

上記で説明したようにファイルを更新して、 ice 修飾子をテストします。

touch ~/files-1

プラグインやスニペットは、ファイルが更新されるたびに何度でもsourceされます。

スニペットで as'…' program​

Commands can also be added to $PATH using snippets:

zi ice mv"httpstat.sh -> httpstat" \
  pick"httpstat" as"program"
zi snippet https://github.com/b4b4r07/httpstat/blob/master/httpstat.sh
tip

Snippets also support atpull, e.g. atpull'!svn revert'. There’s also an atinit ice-modifier, executed before each loading of plugin or snippet.

スニペットで as'…' completion​

By using the as'…' ice modifier with the value completion you can point the snippet subcommand directly to a completion file:

zi ice as"completion"
zi snippet https://github.com/docker/cli/blob/master/contrib/completion/zsh/_docker

補完管理​

Ziは、各プラグインの各補完機能を無効化、有効化することができます。 補完を提供する人気のプラグインをインストールしてみましょう:

zi ice blockf
zi light zsh-users/zsh-completions

The first command, the blockf ice, will block the traditional method of adding completions. Zi uses this method, based on symlinks instead of adding several directories to $fpath. Zi will automatically install completions of a newly downloaded plugin.

補完のアンインストールとインストール:

アンインストール:

zi cuninstall zsh-users/zsh-completions

インストール:

zi creinstall zsh-users/zsh-completions

使用可能な補完のリスト​

To see what completions all plugins provide, in tabular formatting and with the name of each plugin:

zi clist

This command is adapted for plugins like zsh-users/zsh-completions, which provide many completions – listing will have 3 completions per line, and a smaller number of terminal pages can be occupied like this:

To show more completions per line by providing an argument to clist, e.g.: zi clist 6, will show:

補完の有効化／無効化​

補完を無効にし、Zshの組み込み関数など他の補完を使用することも可能です。 The commands are very basic, they only need completion name:

Disable cmake completion:

zi cdisable cmake

Enable cmake completion:

zi cenable cmake

Command zi csearch will search all plugin directories for available completions:

Subversionを使ってサブディレクトリ指定​

In general, to use subdirectories of Github projects as snippets add /trunk/{path-to-dir} to the URL:

zi ice svn
zi snippet https://github.com/zsh-users/zsh-completions/trunk/src
tip

For Oh-My-Zsh and Prezto, the OMZ:: and PZT:: prefixes work without the need to add the /trunk/ infix, however, the path should point to a directory, not to a file.

zi ice svn
zi snippet PZT::modules/docker

Turbo Mode (Zsh >= 5.3)​

The ice-modifier wait allows the user to postpone the loading of a plugin to the moment when the processing of .zshrc is finished and the first prompt is shown.

Windowsと同じで、起動時に、バックグラウンドでデータを読み込んでいるにもかかわらず、デスクトップを表示するのです。 欠点もありますが、10分も真っ白な画面が続くよりは確実にマシです。 しかし、Ziでは、この方法の欠点はありません 。ラグやフリーズなどはありません。プラグインがロードされている間、コマンドラインは完全に使用可能で、プラグインの数に関係なく使用できます。

info

Turbo will speed up Zsh startup by 50%–80%. たとえば、200ミリ秒ではなく、40ミリ秒になります。

备注

Zsh 5.3以降が必要です。

To use turbo mode add wait ice to the target plugin in one of the following ways:

PS1="READY > "
zi ice wait'!0'
zi load halfo/lambda-mod-zsh-theme

This sets plugin halfo/lambda-mod-zsh-theme to be loaded 0 seconds after .zshrc. これは、 1 ms of showing the basic prompt READY >.

このような方法でプロンプトを読み込むことはないでしょうが、ターボモードが観察できる良い例です。 感嘆符を使うと、Zi はプラグインのロード後にプロンプトをリセットします。これはテーマに大抵必要です。 Prezto プロンプトの場合も同様です。遅延時間がより長い場合:

zi ice svn silent wait'!1' atload'prompt smiley'
zi snippet PZT::modules/prompt

Using zsh-users/zsh-autosuggestions without any drawbacks:

zi ice wait lucid atload'!_zsh_autosuggest_start'
zi light zsh-users/zsh-autosuggestions

ターボモードが性能の決め手です。​

非同期で読み込むことができるので、プラグインの量が増えたときに大きな差が出ます。 Usually used as zi ice wait'<SECONDS>'.

备注

The wait is equivalent to wait'0'.

zi ice wait
zi load z-shell/H-S-MW

2秒後に読み込みむ:

zi ice wait'2'
zi load z-shell/H-S-MW

Also can be used in light and snippet:

zi ice wait
zi snippet https://gist.githubusercontent.com/hightemp/5071909/raw/

Turbo mode & lucid​

Turbo and lucid are the most used options because turbo mode is verbose and may require an option for quiet and this can be achieved with the lucid.

zi ice wait lucid
zi load z-shell/H-S-MW

高度なプロンプトを使用したターボ・モード​

For some, mostly advanced themes the initialization of the prompt is being done in a precmd-hook, i.e.; in a function that gets called before each prompt. The hook is installed by the add-zsh-hook Zsh function by adding its name to the $precmd_functions array.

To make the prompt fully initialized after turbo mode loading in the middle of the prompt the same situation as with the zsh-autosuggestions plugin, the hook should be called from atload'…' ice.

First, find the name of the hook function by examining the $precmd_functions array. For example, for the robobenklein/zinc theme, they'll be two functions: prompt_zinc_setup and prompt_zinc_precmd:

print $precmd_functions
_zsh_autosuggest_start prompt_zinc_setup prompt_zinc_precmd

Then, add them to the ice list in the atload'…' ice:

zi ice wait'!' lucid nocd \
  atload'!prompt_zinc_setup; prompt_zinc_precmd'
zi load robobenklein/zinc

The exclamation mark in atload'!…' is to track the functions allowing the plugin to be unloaded, as described here. 次に説明するマルチプロンプトの設定に便利かもしれません。

ターボモードのまとめ​

Autosuggestions use the precmd hook, which is being called right after processing .zshrc – precmd hooks are being called right before displaying each prompt.

Turbo mode with the empty wait ice will postpone the loading 1 ms after that, so precmd will not be called at that first prompt. これにより、最初のプロンプトでautosuggestionは無効となります。

However the given atload'…' ice-modifier fixes this, it calls the same function that precmd would, right after loading autosuggestions, resulting in the same behavior of the plugin.

The ice called lucid causes the under-prompt message saying Loaded zsh-users/zsh-autosuggestions that normally appears for every Turbo-loaded plugin to not show.

Automatic condition based - load & unload​

Ices load and unload allow defining when you want plugins active or inactive:

Load when in ~/tmp:

zi ice load'![[ $PWD = */tmp* ]]' unload'![[ $PWD != */tmp* ]]' \
  atload'!promptinit; prompt sprint3'
zi load z-shell/zprompts

Load when NOT in ~/tmp:

zi ice load'![[ $PWD != */tmp* ]]' unload'![[ $PWD = */tmp* ]]'
zi load russjohnson/angry-fly-zsh

2つのプロンプトは、それぞれ異なるディレクトリでアクティブになります。 This technique can be used to have plugin-sets, e.g. by defining parameter $PLUGINS with possible values like cpp, web, admin and by setting load / unload conditions to activate different plugins on cpp, on web, etc.

备注
  • The difference with wait is that load / unload are constantly active, not only till the first activation. Note that for the unloading of a plugin to work the plugin needs to be loaded with tracking, so zi load … and not zi light ….

トラッキングにより若干の速度低下が発生しますが、ターボモード使用時のZsh起動時間には影響ありません。

プロンプトの概要​

tip

参照： 複数のプロンプト または詳細。 マルチプロンプト・セットアップの実際の例をさらに示します。これは、著者がセットアップで使用するものに近いものです。

This is powerlevel10k, pure, starship sample:

powerlevel10kのテーマを読み込む:

~/.zshrc
zi ice depth"1"
zi light romkatv/powerlevel10k

pure のテーマを読み込む:

will pick the async.zsh library and will source it.

~/.zshrc
zi ice pick"async.zsh" src"pure.zsh"
zi light sindresorhus/pure

starship テーマをロード読み込む:

  • pick starship binary as a command, from the GitHub release.
  • setup starship using atclone and create init.zsh and completion.
  • the atpull'…' behavior same as atclone'…' and but is used when running zi update.
  • src will source init.zsh.
~/.zshrc
zi ice as"command" from"gh-r" \
  atclone"./starship init zsh > init.zsh; ./starship completions zsh > _starship" \
  atpull"%atclone" src"init.zsh"
zi light starship/starship

Common use cases​

Load the pure theme, with the zsh-async library that's bundled with it.

~/.zshrc
zi ice pick"async.zsh" src"pure.zsh"
zi light sindresorhus/pure

GitHub のバイナリのリリースを使う場合。 自動で展開後、プログラム "fzf "を提供します。

~/.zshrc
zi ice from"gh-r" as"program"
zi light junegunn/fzf

One other binary release needs renaming from docker-compose-Linux-x86_64. This can be done by ice modifier: mv'{from} -> {to}'.

There are multiple packages per single version for OS X, Linux, and Windows – the ice-modifier bpick is utilized to select the Linux package – in this case - not required, Zi will grep operating system name and architecture automatically when there's no bpick.

~/.zshrc
zi ice from"gh-r" as"program" mv"docker* -> docker-compose" bpick"*linux*"
zi load docker/compose

Handle completions without loading any plugin, see the clist command. こちらは、インタラクティブセッションで一度だけ実行することになっています。

~/.zshrc
zi creinstall %HOME/my_completions

If you are interested to try out more then check out the playground repository where users have uploaded the ~/.zshrc and other Zi configurations. Feel free to submit your ~/.zshrc configuration.

Additional examples: collection.