diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..b883403 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,15 @@ +name: Lint + +on: + pull_request: + branches: [main, master] + push: + branches: [main, master] + tags: ["v*.*.*"] + workflow_dispatch: + +jobs: + commit: + uses: zdharma-continuum/.github/.github/workflows/commit-job.yml@main + lint: + uses: zdharma-continuum/.github/.github/workflows/lint-job.yml@main diff --git a/README.md b/README.md index aaffc5a..a80b086 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # zinit-packages -🌻 Welcome to [zinit](https://github.com/zdharma-continuum/zinit)'s package -repository. +🌻 Welcome to [zinit](https://github.com/zdharma-continuum/zinit)'s package repository. To learn more about zinit packages and how to install them please refer to: @@ -19,12 +18,11 @@ To create a new package named `foo`: This will create a directory named `foo` which contains: -- `default.ices.zsh`: Your source file where you can define your zinit -ices and will later be used for generating `package.json` +- `default.ices.zsh`: Your source file where you can define your zinit ices and will later be used for generating + `package.json` - `package.json`: The file that `zinit pack` actually consumes -To add another profile (as in `zinit pack"PROFILE" for PACKAGE`), for example -`bar`: +To add another profile (as in `zinit pack"PROFILE" for PACKAGE`), for example `bar`: ```zsh ./zinit-gen-pkg.sh create foo bar @@ -36,13 +34,12 @@ This will create a new file in your package directory: `bar.ices.zsh`. As mentionned above you should start by editing your `.ices.zsh` file. -📓 Exactly one zinit call is required in there, multiple `zinit` calls are not -supported. +📓 Exactly one zinit call is required in there, multiple `zinit` calls are not supported. 📝 You can also define metadata in your `.ices.zsh` files: | Variable | Description | Example Value | -|-----------------|---------------------------------------------------|---------------------------------------------| +| --------------- | ------------------------------------------------- | ------------------------------------------- | | `AUTHOR` | Author of the package | `zdharma-continuum` | | `DESCRIPTION` | Description of the package | `My amazing blockchain project` | | `LICENSE` | License of the packaged software | `GPL-3` | @@ -69,8 +66,7 @@ profile=default ## 🐳 How do I run these? -There's a shorthand subcommand for running a `.ices.zsh` file locally, inside a -container: +There's a shorthand subcommand for running a `.ices.zsh` file locally, inside a container: ```zsh ./zinit-gen-pkg.sh run PACKAGE PROFILE diff --git a/any-gem/README.md b/any-gem/README.md index 4bce5aa..9864f1a 100644 --- a/any-gem/README.md +++ b/any-gem/README.md @@ -1,31 +1,29 @@ # `any-gem` Zsh package -| **Package source:** | Source Tarball | Binary | Git | Node | Gem | -|:-------------------:|:--------------:|:------:|:---:|:----:|:---:| -| **Status:** | - | - | - | – | +
(default) | +| **Package source:** | Source Tarball | Binary | Git | Node | Gem | +| :-----------------: | :------------: | :----: | :-: | :--: | :--------------: | +| **Status:** | - | - | - | – | +
(default) | ## Introduction -[Zplugin](https://github.com/zdharma-continuum/zinit) can use a `package.json` -(similar in construct to the one used in `npm` packages) to automatically: +[Zplugin](https://github.com/zdharma-continuum/zinit) can use a `package.json` (similar in construct to the one used in +`npm` packages) to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. ## The `any-gem` Package -This package is special – it is designed for easy installing of any Ruby Gems -locally inside the plugin directory, exposing their binaries via *shims* (i.e.: -forwarder scripts) created automatically by +This package is special – it is designed for easy installing of any Ruby Gems locally inside the plugin directory, +exposing their binaries via *shims* (i.e.: forwarder scripts) created automatically by [Bin-Gem-Node](https://github.com/zplugin/zinit-annex-bin-gem-gem) annex. -The Ruby Gem(s) to install are specified by the `param'GEM → {gem1}; GEM2 → -{gem2}; …'` ice. The name of the plugin will be `{gem1}`, unless `id-as''` ice -will be provided, or the `IDAS` param will be set (i.e.: `param'IDAS → -my-plugin; GEM → …'`). +The Ruby Gem(s) to install are specified by the `param'GEM → {gem1}; GEM2 → {gem2}; …'` ice. The name of the plugin will +be `{gem1}`, unless `id-as''` ice will be provided, or the `IDAS` param will be set (i.e.: +`param'IDAS → my-plugin; GEM → …'`). A few example invocations: @@ -42,8 +40,8 @@ zinit pack param='IDAS → jkl; GEM → jekyll' for any-gem ## Default Profile -The only profile that does all the magic. It relies on the `%PARAM%` keywords, -which are substituted with the `value` from the ice `param'PARAM → value; …'`. +The only profile that does all the magic. It relies on the `%PARAM%` keywords, which are substituted with the `value` +from the ice `param'PARAM → value; …'`. The Zplugin command executed will be equivalent to: diff --git a/any-node/README.md b/any-node/README.md index 00af913..f9faa8e 100644 --- a/any-node/README.md +++ b/any-node/README.md @@ -1,31 +1,26 @@ # `any-node` Zsh package -| **Package source:** | Source Tarball | Binary | Git | Node | Gem -| |:-------------------:|:--------------:|:------:|:---:|:----:|:---:| -| **Status:** | - | - | - | +
(default) -| – | +| **Package source:** | Source Tarball | Binary | Git | Node | Gem | +|:-------------------:|:--------------:|:------:|:---:|:----:|:---:| | **Status:** | - | - | - | +
(default) | – | ## Introduction -[Zinit](https://github.com/zdharma-continuum/zinit) can use the NPM package registry -to automatically: +[Zinit](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. ## The `any-node` Package -This package is special – it is designed for easy installing of any Node modules -inside the plugin directory, exposing their binaries via *shims* (i.e.: forwarder -scripts) created automatically by +This package is special – it is designed for easy installing of any Node modules inside the plugin directory, exposing +their binaries via *shims* (i.e.: forwarder scripts) created automatically by [Bin-Gem-Node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex. -The Node module(s) to install are specified by the `param'MOD → {module1}; MOD2 -→ {module2}; …'` ice. The name of the plugin will be `{module1}`, unless -`id-as''` ice will be provided, or the `IDAS` param will be set (i.e.: +The Node module(s) to install are specified by the `param'MOD → {module1}; MOD2 → {module2}; …'` ice. The name of the +plugin will be `{module1}`, unless `id-as''` ice will be provided, or the `IDAS` param will be set (i.e.: `param'IDAS → my-plugin; MOD → …'`). A few example invocations: @@ -43,8 +38,8 @@ zinit pack param='IDAS → my-pen; MOD → pen' for any-node ## Default Profile -The only profile that does all the magic. It relies on the `%PARAM%` keywords, -which are substituted with the `value` from the ice `param'PARAM → value; …'`. +The only profile that does all the magic. It relies on the `%PARAM%` keywords, which are substituted with the `value` +from the ice `param'PARAM → value; …'`. The Zplugin command executed will be equivalent to: diff --git a/apr/README.md b/apr/README.md index bb5b4c1..3571430 100644 --- a/apr/README.md +++ b/apr/README.md @@ -2,22 +2,20 @@ ##### Homepage link: [apache/apr](https://github.com/apache/apr) -| **Package source:** | Source Tarball | Binary | Git | Node | Gem | -|:-------------------:|:--------------:|:------:|:---:|:----:|:---:| -| **Status:** | +
(default) | - | + | – | – | +| **Package source:** | Source Tarball | Binary | Git | Node | Gem | +| :-----------------: | :--------------: | :----: | :-: | :--: | :-: | +| **Status:** | +
(default) | - | + | – | – | -[Zinit](https://github.com/zdharma-continuum/zinit) can use the NPM package registry -to automatically: +[Zinit](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. -Example invocations that'll install -[apache/apr](https://github.com/apache/apr) either from the release archive -or from Git repository: +Example invocations that'll install [apache/apr](https://github.com/apache/apr) either from the release archive or from +Git repository: ```zsh # Download, build and install the latest Apache Portable Runtime source tarball @@ -26,8 +24,8 @@ zinit pack for apr ## Default Profile -Provides the Apache Portable Runtime library by compiling and installing it to -the `$ZPFX` directory (`~/.zinit/polaris` by default). It uses the +Provides the Apache Portable Runtime library by compiling and installing it to the `$ZPFX` directory (`~/.zinit/polaris` +by default). It uses the [zdharma-continuum/zinit-annex-as-monitor](https://github.com/zdharma-continuum/zinit-annex-as-monitor) annex to download the latest Apache Portable Runtime tarball. diff --git a/asciidoctor/README.md b/asciidoctor/README.md index 1aa609e..76443e6 100644 --- a/asciidoctor/README.md +++ b/asciidoctor/README.md @@ -2,21 +2,19 @@ ##### Homepage link: [asciidoctor/asciidoctor](https://github.com/asciidoctor/asciidoctor) -| **Package source:** | Tarball | Git | Node | Gem | -|:-------------------:|:-------:|:---:|:----:|:---:| -| **Status:** | - | - | - | +
(default) | +| **Package source:** | Tarball | Git | Node | Gem | +| :-----------------: | :-----: | :-: | :--: | :--------------: | +| **Status:** | - | - | - | +
(default) | -[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry -to automatically: +[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. -Example invocations that'll install -[asciidoctor/asciidoctor](https://github.com/asciidoctor/asciidoctor) by using the +Example invocations that'll install [asciidoctor/asciidoctor](https://github.com/asciidoctor/asciidoctor) by using the [bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex: ```zsh @@ -29,10 +27,9 @@ zinit pack for @asciidoctor Provides the CLI command `asciidoctor`. -The Gem is installed locally into a null-plugin directory (feature of the -bin-gem-node annex) and provided to the command line through *shims*, i.e.: -automatic forwarder scripts created under `$ZPFX/bin` (which is added to the -`$PATH` by default; shims are also a bin-gem-node annex feature). +The Gem is installed locally into a null-plugin directory (feature of the bin-gem-node annex) and provided to the +command line through *shims*, i.e.: automatic forwarder scripts created under `$ZPFX/bin` (which is added to the `$PATH` +by default; shims are also a bin-gem-node annex feature). The Zplugin command executed will be equivalent to: diff --git a/dircolors-material/README.md b/dircolors-material/README.md index dacd808..8ea95b0 100644 --- a/dircolors-material/README.md +++ b/dircolors-material/README.md @@ -2,31 +2,28 @@ ##### Homepage link: [zpm-zsh/dircolors-material](https://github.com/zpm-zsh/dircolors-material) -| **Package source:** | Tarball | Binary | Git | Node | Gem | -|:-------------------:|:-------:|:------:|:---:|:----:|:---:| -| **Status:** | - | - | +
(default) | – | – | +| **Package source:** | Tarball | Binary | Git | Node | Gem | +| :-----------------: | :-----: | :----: | :--------------: | :--: | :-: | +| **Status:** | - | - | +
(default) | – | – | ## Introduction -[Zinit](https://github.com/zdharma-continuum/zinit) can use a `package.json` -(similar in construct to the one used in `npm` packages) to automatically: +[Zinit](https://github.com/zdharma-continuum/zinit) can use a `package.json` (similar in construct to the one used in +`npm` packages) to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. ## The `dircolors-material` Package -The package provides the -[zpm-zsh/dircolors-material](https://github.com/zpm-zsh/dircolors-material) -definitions for GNU `ls`, `ogham/exa` and also setups zsh-completion system to -use the definitions. +The package provides the [zpm-zsh/dircolors-material](https://github.com/zpm-zsh/dircolors-material) definitions for GNU +`ls`, `ogham/exa` and also setups zsh-completion system to use the definitions. -Example invocations that'll install `zpm-zsh/dircolors-material` from Git -repository in the most optimized way as described on the [Zinit -Wiki](https://zdharma-continuum.github.io/zinit/wiki/LS_COLORS-explanation/): +Example invocations that'll install `zpm-zsh/dircolors-material` from Git repository in the most optimized way as +described on the [Zinit Wiki](https://zdharma-continuum.github.io/zinit/wiki/LS_COLORS-explanation/): ```zsh # Download the default profile @@ -47,11 +44,9 @@ zinit pack"minimal" for dircolors-material Provides the dircolors-material definitions for GNU `ls`, `ogham/exa` and also: - sets up the zsh-completion system to use the definitions, -- automatically (i.e.: transparently for the updates of the plugin) swaps the - color for the directory to a more bright blue (of the index 63 in the standard - 256 color palette), -- uses a workaround for some old `dircolors` commands that improperly test - `$TERM` variable and produce empty output. +- automatically (i.e.: transparently for the updates of the plugin) swaps the color for the directory to a more bright + blue (of the index 63 in the standard 256 color palette), +- uses a workaround for some old `dircolors` commands that improperly test `$TERM` variable and produce empty output. The Zinit command executed will be equivalent to: @@ -67,9 +62,8 @@ zinit lucid \ ## `no-color-swaps` Profile -Provides the dircolors-material definitions for GNU `ls`, `ogham/exa` but -doesn't swap the directory color, i.e.: it doesn't customize the original theme. -It still initializes the zsh-completion system with the theme's colors. +Provides the dircolors-material definitions for GNU `ls`, `ogham/exa` but doesn't swap the directory color, i.e.: it +doesn't customize the original theme. It still initializes the zsh-completion system with the theme's colors. The Zinit command executed will be equivalent to: @@ -84,9 +78,8 @@ zinit lucid \ ## `no-zsh-completion` Profile -Provides the dircolors-material definitions for GNU `ls`, `ogham/exa` but -doesn't set up the zsh-completion system to use them. It still swaps the -directory color. +Provides the dircolors-material definitions for GNU `ls`, `ogham/exa` but doesn't set up the zsh-completion system to +use them. It still swaps the directory color. The Zinit command executed will be equivalent to: @@ -101,9 +94,8 @@ zinit lucid \ ## `minimal` Profile -Provides the dircolors-material definitions for GNU `ls`, `ogham/exa` with both -extra functions/features disabled, i.e.: without altering the original theme and -without setting the zsh-completion system. Thus, this is a barebones profile. +Provides the dircolors-material definitions for GNU `ls`, `ogham/exa` with both extra functions/features disabled, i.e.: +without altering the original theme and without setting the zsh-completion system. Thus, this is a barebones profile. The Zinit command executed will be equivalent to: diff --git a/doctoc/README.md b/doctoc/README.md index e3815f0..0cb7fba 100644 --- a/doctoc/README.md +++ b/doctoc/README.md @@ -2,21 +2,19 @@ ##### Homepage link: [thlorenz/doctoc](https://github.com/thlorenz/doctoc) -| **Package source:** | Source Tarball | Binary | Git | Node | Gem | -|:-------------------:|:--------------:|:------:|:---:|:----:|:---:| -| **Status:** | - | - | - | +
(default) | – | +| **Package source:** | Source Tarball | Binary | Git | Node | Gem | +| :-----------------: | :------------: | :----: | :-: | :--------------: | :-: | +| **Status:** | - | - | - | +
(default) | – | -[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry -to automatically: +[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. -Example invocations that'll install -[thlorenz/doctoc](https://github.com/thlorenz/doctoc) by using the +Example invocations that'll install [thlorenz/doctoc](https://github.com/thlorenz/doctoc) by using the [bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex: ```zsh @@ -28,9 +26,8 @@ zinit pack for doctoc Provides the CLI command `doctoc`. -The Node packages are installed locally into a null-plugin directory (feature of -the bin-gem-node annex) and provided to the command line through *shims*, i.e.: -automatic forwarder scripts created under `$ZPFX/bin` (which is added to the +The Node packages are installed locally into a null-plugin directory (feature of the bin-gem-node annex) and provided to +the command line through *shims*, i.e.: automatic forwarder scripts created under `$ZPFX/bin` (which is added to the `$PATH` by default; shims are also a bin-gem-node annex feature). The Zplugin command executed will be equivalent to: diff --git a/ecs-cli/README.md b/ecs-cli/README.md index 0d2d23c..0fcd867 100644 --- a/ecs-cli/README.md +++ b/ecs-cli/README.md @@ -2,21 +2,19 @@ ##### Homepage link: [aws/amazon-ecs-cli](https://github.com/aws/amazon-ecs-cli) -| **Package source:** | Source Tarball | Binary | Git | Node | Gem | -|:-------------------:|:--------------:|:------:|:---:|:----:|:---:| -| **Status:** | - | +
(default) | - | – | – | +| **Package source:** | Source Tarball | Binary | Git | Node | Gem | +| :-----------------: | :------------: | :--------------: | :-: | :--: | :-: | +| **Status:** | - | +
(default) | - | – | – | -[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry -to automatically: +[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. -Example invocations that'll install -[aws/amazon-ecs-cli](https://github.com/aws/amazon-ecs-cli): +Example invocations that'll install [aws/amazon-ecs-cli](https://github.com/aws/amazon-ecs-cli): ```zsh # Download the binary of amazon-ecs-cli command @@ -41,10 +39,9 @@ zinit as=null id-as="ecs-cli" mv="*latest -> ecs-cli" \ ## bin-gem-node Profile -Provides the CLI command `ecs-cli` by creating a forwarder script (a *shim*) in -`$ZPFX/bin` by using the -[bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex. It's the best -method of providing the binary to the command line. +Provides the CLI command `ecs-cli` by creating a forwarder script (a *shim*) in `$ZPFX/bin` by using the +[bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex. It's the best method of providing +the binary to the command line. The Zplugin command executed will be equivalent to: diff --git a/firefox-dev/README.md b/firefox-dev/README.md index 88becb7..b83a612 100644 --- a/firefox-dev/README.md +++ b/firefox-dev/README.md @@ -2,20 +2,20 @@ ##### Homepage link: [Mozilla Firefox Developer Edition](https://www.mozilla.org/en-US/firefox/developer/) -| **Package source:** | Source Tarball | Binary | Git | Node | Gem | -|:-------------------:|:--------------:|:------:|:---:|:----:|:---:| -| **Status:** | - | +
(default) | - | – | – | +| **Package source:** | Source Tarball | Binary | Git | Node | Gem | +| :-----------------: | :------------: | :--------------: | :-: | :--: | :-: | +| **Status:** | - | +
(default) | - | – | – | -[Zinit](https://github.com/zdharma-continuum/zinit) can use the `package.json` file to -automatically: +[Zinit](https://github.com/zdharma-continuum/zinit) can use the `package.json` file to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. -Example invocations that'll install [Mozilla Firefox Developer Edition](https://www.mozilla.org/en-US/firefox/developer/) +Example invocations that'll install +[Mozilla Firefox Developer Edition](https://www.mozilla.org/en-US/firefox/developer/) ```zsh # Download the binary of amazon-firefox-dev command @@ -27,8 +27,7 @@ zinit pack"bgn" for firefox-dev ## Default Profile -Provides the CLI commands `firefox-bin` and `firefox` by extending the `$PATH` -to point to the snippet's directory. +Provides the CLI commands `firefox-bin` and `firefox` by extending the `$PATH` to point to the snippet's directory. The Zinit command executed will be equivalent to: @@ -42,10 +41,9 @@ zinit id-as"firefox-dev" as"command" lucid" \ ## bin-gem-node Profile -Provides the CLI command `firefox` by creating a forwarder script (a *shim*) to -the `firefox-bin` command, in `$ZPFX/bin` by using the -[bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex. It's the best -method of providing the binary to the command line. +Provides the CLI command `firefox` by creating a forwarder script (a *shim*) to the `firefox-bin` command, in +`$ZPFX/bin` by using the [bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex. It's the +best method of providing the binary to the command line. The Zinit command executed will be equivalent to: diff --git a/fzf/README.md b/fzf/README.md index 9d22744..0410367 100644 --- a/fzf/README.md +++ b/fzf/README.md @@ -6,22 +6,19 @@ | :------------: | :------------: | :----: | :-: | :--: | :-: | | Status | Default | + | + | – | - | -[Zinit](https://github.com/zdharma-continuum/Zinit) can use `package.json` to -automatically: +[Zinit](https://github.com/zdharma-continuum/Zinit) can use `package.json` to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, - *default*, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, - the ices can be selectively overridden. More documentation on Zinit Packages can be found on the [Zinit Wiki](https://zdharma-continuum.github.io/zinit/wiki/Zinit-Packages/). -Example invocations that'll install -[junegunn/fzf](https://github.com/junegunn/fzf) either from the release archive -or from Git repository: +Example invocations that'll install [junegunn/fzf](https://github.com/junegunn/fzf) either from the release archive or +from Git repository: ```zsh # Download the package with the default ice list @@ -50,8 +47,7 @@ zinit pack"bgn-binary" for fzf ## Default Profile -Provides the fuzzy finder via Makefile-installation of the `fzf` binary under -`$ZPFX/bin`. +Provides the fuzzy finder via Makefile-installation of the `fzf` binary under `$ZPFX/bin`. ```zsh zinit lucid as=program pick="$ZPFX/bin/(fzf|fzf-tmux)" \ @@ -62,9 +58,8 @@ zinit lucid as=program pick="$ZPFX/bin/(fzf|fzf-tmux)" \ ## Bin-Gem-Node Profile -Provides the fuzzy finder via *shims*, i.e., automatic forwarder scripts created -under `$ZPFX/bin` (added to the `$PATH` by default). It needs the -[bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex. +Provides the fuzzy finder via *shims*, i.e., automatic forwarder scripts created under `$ZPFX/bin` (added to the `$PATH` +by default). It needs the [bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex. ```zsh zinit lucid as=null make \ diff --git a/fzy/README.md b/fzy/README.md index db243b6..1302c7c 100644 --- a/fzy/README.md +++ b/fzy/README.md @@ -2,21 +2,20 @@ ##### Homepage link: [jhawthorn/fzy](https://github.com/jhawthorn/fzy) -| **Package source:** | Tarball | Git | Node | Gem | -|:-------------------:|:-------:|:---:|:----:|:---:| -| **Status:** | +
(default) | + | – | – | +| **Package source:** | Tarball | Git | Node | Gem | +| :-----------------: | :--------------: | :-: | :--: | :-: | +| **Status:** | +
(default) | + | – | – | [Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. -Example invocations that'll install -[jhawthorn/fzy](https://github.com/jhawthorn/fzy) either from the release -archive or from Git repository: +Example invocations that'll install [jhawthorn/fzy](https://github.com/jhawthorn/fzy) either from the release archive or +from Git repository: ```zsh # Download the package with the default ice list @@ -34,8 +33,7 @@ zinit pack"bgn" atclone'' for fzy ## Default Profile -Provides the fuzzy finder via Makefile-installation of the `fzy` binary under -`$ZPFX/bin`. +Provides the fuzzy finder via Makefile-installation of the `fzy` binary under `$ZPFX/bin`. ```zsh zinit lucid as"program" pick"$ZPFX/bin/fzy*" \ @@ -46,9 +44,9 @@ zinit lucid as"program" pick"$ZPFX/bin/fzy*" \ ## Bin-Gem-Node Profile -Provides the fuzzy finder via *shims*, i.e.: automatic forwarder scripts created -under `$ZPFX/bin` (which is added to the `$PATH` by default). It needs the -[bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex. +Provides the fuzzy finder via *shims*, i.e.: automatic forwarder scripts created under `$ZPFX/bin` (which is added to +the `$PATH` by default). It needs the [bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) +annex. ```zsh zinit lucid as"null" make sbin"fzy;contrib/fzy-*" … diff --git a/github-issues-srv/README.md b/github-issues-srv/README.md index 1ba894d..a603b26 100644 --- a/github-issues-srv/README.md +++ b/github-issues-srv/README.md @@ -2,18 +2,17 @@ ##### Homepage link: [zdharma-continuum/zsh-github-issues](https://github.com/zdharma-continuum/zsh-github-issues) -| **Package source:** | Tarball | Git | Node | Gem | -|:-------------------:|:-------:|:---:|:----:|:---:| -| **Status:** | - | +
(default) | – | – | +| **Package source:** | Tarball | Git | Node | Gem | +| :-----------------: | :-----: | :--------------: | :--: | :-: | +| **Status:** | - | +
(default) | – | – | -[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry -to automatically: +[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. Example Zplugin invocations that'll install [zdharma-continuum/zsh-github-issues](https://github.com/zdharma-continuum/zsh-github-issues): @@ -25,9 +24,8 @@ zinit pack for @github-issues-srv ## Default Profile -The package is the puller-thread service for the `zdharma-continuum/zsh-github-issues` -plugin. It runs the background service that downloads the new issues from -GitHub. +The package is the puller-thread service for the `zdharma-continuum/zsh-github-issues` plugin. It runs the background +service that downloads the new issues from GitHub. The Zplugin command executed will be equivalent to: diff --git a/github-issues/README.md b/github-issues/README.md index 7ad0a9b..acb1e87 100644 --- a/github-issues/README.md +++ b/github-issues/README.md @@ -2,18 +2,17 @@ ##### Homepage link: [zdharma-continuum/zsh-github-issues](https://github.com/zdharma-continuum/zsh-github-issues) -| **Package source:** | Tarball | Git | Node | Gem | -|:-------------------:|:-------:|:---:|:----:|:---:| -| **Status:** | - | +
(default) | – | – | +| **Package source:** | Tarball | Git | Node | Gem | +| :-----------------: | :-----: | :--------------: | :--: | :-: | +| **Status:** | - | +
(default) | – | – | -[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry -to automatically: +[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. Example Zplugin invocations that'll install [zdharma-continuum/zsh-github-issues](https://github.com/zdharma-continuum/zsh-github-issues): diff --git a/ls_colors/README.md b/ls_colors/README.md index 24341ee..aeab72a 100644 --- a/ls_colors/README.md +++ b/ls_colors/README.md @@ -1,25 +1,22 @@ # trapd00r/LS_COLORS: Zsh & NPM package -**LS_COLORS source code**: -[trapd00r/LS_COLORS](https://github.com/trapd00r/LS_COLORS) +**LS_COLORS source code**: [trapd00r/LS_COLORS](https://github.com/trapd00r/LS_COLORS) | Package | Tarball | Git | Node | Gem | | :-----: | :-----: | :-----: | :--: | :-: | | Status | N/A | Default | N/A | N/A | -[Zinit](https://github.com/zdharma-continuum/zinit) can use a `package.json` -(similar in construct to the one used in `npm` packages) to automatically: +[Zinit](https://github.com/zdharma-continuum/zinit) can use a `package.json` (similar in construct to the one used in +`npm` packages) to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, - *default*, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, - the ices can be selectively overridden. -Example invocations that'll install -[trapd00r/LS_COLORS](https://github.com/trapd00r/LS_COLORS) from Git repository -in the most optimized way as described on the +Example invocations that'll install [trapd00r/LS_COLORS](https://github.com/trapd00r/LS_COLORS) from Git repository in +the most optimized way as described on the [Zinit Wiki](https://zdharma-continuum.github.io/zinit/wiki/LS_COLORS-explanation/): ```zsh @@ -35,9 +32,8 @@ zinit pack"no-dir-color-swap" for ls_colors ## Default Profile -Provides the LS_COLORS definitions for GNU `ls` and `ogham/exa` and sets up the -zsh-completion system to use the definitions. It also edits the color for the -directory (see the details in the `no-dir-color-swap` profile section). +Provides the LS_COLORS definitions for GNU `ls` and `ogham/exa` and sets up the zsh-completion system to use the +definitions. It also edits the color for the directory (see the details in the `no-dir-color-swap` profile section). The Zinit command executed will be equivalent to: @@ -53,8 +49,7 @@ zinit lucid reset \ ## `no-zsh-completion` Profile -Provides the LS_COLORS definitions for GNU `ls`, `ogham/exa` but doesn't set up -the zsh-completion system to use them. +Provides the LS_COLORS definitions for GNU `ls`, `ogham/exa` but doesn't set up the zsh-completion system to use them. The Zinit command executed will be equivalent to: @@ -69,9 +64,8 @@ zinit lucid reset \ ## `no-dir-color-swap` Profile -Provides the LS_COLORS definitions like the `default` profile; however, it -doesn't edit the definitions file or changes the directory's color. The color is -being edited in the default profile because the author found it to be too dark. +Provides the LS_COLORS definitions like the `default` profile; however, it doesn't edit the definitions file or changes +the directory's color. The color is being edited in the default profile because the author found it to be too dark. The Zinit command executed will be equivalent to: diff --git a/pyenv/README.md b/pyenv/README.md index c474dbd..094c5e9 100644 --- a/pyenv/README.md +++ b/pyenv/README.md @@ -2,22 +2,20 @@ ##### Homepage link: [pyenv/pyenv](https://github.com/pyenv/pyenv) -| **Package source:** | Source Tarball | Binary | Git | Node | Gem | -|:-------------------:|:--------------:|:------:|:---:|:----:|:---:| -| **Status:** | +
(default) | - | + | – | – | +| **Package source:** | Source Tarball | Binary | Git | Node | Gem | +| :-----------------: | :--------------: | :----: | :-: | :--: | :-: | +| **Status:** | +
(default) | - | + | – | – | -[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry -to automatically: +[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. -Example invocations that'll install -[pyenv/pyenv](https://github.com/pyenv/pyenv) either from the release archive -or from Git repository: +Example invocations that'll install [pyenv/pyenv](https://github.com/pyenv/pyenv) either from the release archive or +from Git repository: ```zsh # Download the tarball with the default ice list @@ -32,8 +30,7 @@ zinit pack"bgn" git for pyenv ## Default Profile -Provides the `pyenv` version manager by extending `$PATH` to make it point into -the `bin` subdirectory of the plugin. +Provides the `pyenv` version manager by extending `$PATH` to make it point into the `bin` subdirectory of the plugin. The Zplugin command executed will be equivalent to: @@ -46,10 +43,9 @@ zinit lucid as'command' pick'bin/pyenv' atinit'export PYENV_ROOT="$PWD"' \ ## Bin-Gem-Node Profile -Provides the version manager via *shims*, i.e.: automatic forwarder scripts created -under `$ZPFX/bin` (which is added to the `$PATH` by default by Zplugin). It needs the -[bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex (it has the -shim-creation feature). +Provides the version manager via *shims*, i.e.: automatic forwarder scripts created under `$ZPFX/bin` (which is added to +the `$PATH` by default by Zplugin). It needs the +[bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex (it has the shim-creation feature). The Zplugin command executed will be equivalent to: diff --git a/remark/README.md b/remark/README.md index f88d674..6fee01c 100644 --- a/remark/README.md +++ b/remark/README.md @@ -2,21 +2,19 @@ ##### Homepage link: [remarkjs/remark](https://github.com/remarkjs/remark) -| **Package source:** | Tarball | Git | Node | Gem | -|:-------------------:|:-------:|:---:|:----:|:---:| -| **Status:** | - | - | +
(default) | – | +| **Package source:** | Tarball | Git | Node | Gem | +| :-----------------: | :-----: | :-: | :--------------: | :-: | +| **Status:** | - | - | +
(default) | – | -[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry -to automatically: +[Zplugin](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. -Example invocations that'll install -[remarkjs/remark](https://github.com/remarkjs/remark) by using the +Example invocations that'll install [remarkjs/remark](https://github.com/remarkjs/remark) by using the [bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex: ```zsh @@ -34,9 +32,8 @@ zinit pack"html-only" for remark Provides the CLI command `remark` with two plugins: Man and Html. -The Node packages are installed locally into a null-plugin directory (feature of -the bin-gem-node annex) and provided to the command line through *shims*, i.e.: -automatic forwarder scripts created under `$ZPFX/bin` (which is added to the +The Node packages are installed locally into a null-plugin directory (feature of the bin-gem-node annex) and provided to +the command line through *shims*, i.e.: automatic forwarder scripts created under `$ZPFX/bin` (which is added to the `$PATH` by default; shims are also a bin-gem-node annex feature). The Zplugin command executed will be equivalent to: diff --git a/svn/README.md b/svn/README.md index 9e6ca7f..c61725a 100644 --- a/svn/README.md +++ b/svn/README.md @@ -2,22 +2,20 @@ ##### Homepage link: [apache/subversion](https://github.com/apache/subversion) -| **Package source:** | Source Tarball | Binary | Git | Node | Gem | -|:-------------------:|:--------------:|:------:|:---:|:----:|:---:| -| **Status:** | +
(default) | - | + | – | – | +| **Package source:** | Source Tarball | Binary | Git | Node | Gem | +| :-----------------: | :--------------: | :----: | :-: | :--: | :-: | +| **Status:** | +
(default) | - | + | – | – | -[Zinit](https://github.com/zdharma-continuum/zinit) can use the NPM package registry -to automatically: +[Zinit](https://github.com/zdharma-continuum/zinit) can use the NPM package registry to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. -Example invocations that'll install -[apache/subversion](https://github.com/apache/subversion) either from the release archive -or from Git repository: +Example invocations that'll install [apache/subversion](https://github.com/apache/subversion) either from the release +archive or from Git repository: ```zsh # Download and install the APR dependency of Subversion @@ -28,8 +26,8 @@ zinit pack for subversion ## Default Profile -Provides the Subversion revision control system by compiling and installing it -to the `$ZPFX` directory (`~/.zinit/polaris` by default). It uses the +Provides the Subversion revision control system by compiling and installing it to the `$ZPFX` directory +(`~/.zinit/polaris` by default). It uses the [zdharma-continuum/zinit-annex-as-monitor](https://github.com/zdharma-continuum/zinit-annex-as-monitor) annex to download the latest Subversion tarball. diff --git a/system-completions/README.md b/system-completions/README.md index 78d3f1f..ae516f4 100644 --- a/system-completions/README.md +++ b/system-completions/README.md @@ -1,24 +1,24 @@ # `system-completions` Zinit package | **Package source:** | Tarball | Binary | Git | Node | Gem | -|:-------------------:|:-------:|:------:|:---:|:----:|:---:| -| **Status:** | - | - | - | – | – | +| :-----------------: | :-----: | :----: | :-: | :--: | :-: | +| **Status:** | - | - | - | – | – | ## Introduction -[Zinit](https://github.com/zdharma-continuum/zinit) can use a `package.json` -(similar in construct to the one used in `npm` packages) to automatically: +[Zinit](https://github.com/zdharma-continuum/zinit) can use a `package.json` (similar in construct to the one used in +`npm` packages) to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. ## The `system-completions` Package -Moves the stock Zsh completions under the control of Zinit. You can then -selectively enable and disable the completions with `cenable` and `cdisable`. +Moves the stock Zsh completions under the control of Zinit. You can then selectively enable and disable the completions +with `cenable` and `cdisable`. Example Zinit invocations: diff --git a/zsh-static/README.md b/zsh-static/README.md index 9c0e6a1..a351098 100644 --- a/zsh-static/README.md +++ b/zsh-static/README.md @@ -12,8 +12,7 @@ zinit pack for zsh-static ### Default profile -Requires root or sudo. Installs static zsh to /usr/local and tries to register -it as a login shell. +Requires root or sudo. Installs static zsh to /usr/local and tries to register it as a login shell. ```zsh zinit lucid as"null" \ diff --git a/zsh/README.md b/zsh/README.md index ce4687f..9eca291 100644 --- a/zsh/README.md +++ b/zsh/README.md @@ -2,22 +2,20 @@ ##### Homepage link: [zsh-users/zsh](https://github.com/zsh-users/zsh) -| **Package source:** | Source Tarball | Binary | Git | Node | Gem | -|:-------------------:|:--------------:|:------:|:---:|:----:|:---:| -| **Status:** | - | - | +
(default) | - | - | +| **Package source:** | Source Tarball | Binary | Git | Node | Gem | +| :-----------------: | :------------: | :----: | :--------------: | :--: | :-: | +| **Status:** | - | - | +
(default) | - | - | -[Zinit](https://github.com/zdharma-continuum/zinit) can use `package.json` to -automatically: +[Zinit](https://github.com/zdharma-continuum/zinit) can use `package.json` to automatically: - get the plugin's Git repository OR release-package URL, - get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in *profiles*; there's at least one profile, *default*, - - the ices can be selectively overriden. + - there can be multiple lists of ices, + - the ice lists are stored in *profiles*; there's at least one profile, *default*, + - the ices can be selectively overriden. -Example invocations that'll install -[zsh-users/zsh](https://github.com/zsh-users/zsh) either from the release archive -or from Git repository: +Example invocations that'll install [zsh-users/zsh](https://github.com/zsh-users/zsh) either from the release archive or +from Git repository: ```zsh # Install the newest zsh @@ -56,10 +54,9 @@ It copies the zsh binary onto `/bin/zsh`. ## What are the `-tcsetpgrp` profiles for? -These are meant to be used in CI, for building ZSH without a TTY which is -normally used to determine dynamically if -[setpgrp](https://linux.die.net/man/2/setpgrp) is available. The `-tcsetpgrp` -profiles explicitly set `--with-tcsetpgrp` in the `./configure` call. +These are meant to be used in CI, for building ZSH without a TTY which is normally used to determine dynamically if +[setpgrp](https://linux.die.net/man/2/setpgrp) is available. The `-tcsetpgrp` profiles explicitly set `--with-tcsetpgrp` +in the `./configure` call. More info: