From b51c3c6922c80bcca4b21db1bd21103541be9b0c Mon Sep 17 00:00:00 2001 From: Philipp Schmitt Date: Thu, 11 Nov 2021 19:59:38 +0100 Subject: [PATCH 1/2] Update annexes repo names (#38) --- README.md | 30 +++++++++++++++--------------- doc/CHANGELOG.md | 18 +++++++++--------- doc/install.sh | 8 ++++---- doc/zinit.1 | 6 +++--- zinit-install.zsh | 18 +++++++++--------- 5 files changed, 40 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 293dd8c52..e68894550 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ . - - A **new annex** [**Unscope**](https://github.com/zdharma-continuum/z-a-unscope) :) + - A **new annex** [**Unscope**](https://github.com/zdharma-continuum/zinit-annex-unscope) :) It's goal is: to allow the usage of the unscoped — i.e.: given without any GitHub user name — plugin IDs. Basically it allows to specify, e.g.: **zinit load _zsh-syntax-highlighting_** instead of **zinit load @@ -119,8 +119,8 @@ nicer snippet IDs in the installation and update messages, **f)** the annexes can be now loaded in any order without influencing their operation in any way (there have been some issues with - [Patch-Dl](https://github.com/zdharma-continuum/z-a-patch-dl) and - [As-Monitor](https://github.com/zdharma-continuum/z-a-as-monitor) annexes), **g)** + [Patch-Dl](https://github.com/zdharma-continuum/zinit-annex-patch-dl) and + [As-Monitor](https://github.com/zdharma-continuum/zinit-annex-as-monitor) annexes), **g)** `compile''` can now obtain multiple patterns separated via semicolon (`;`). - 25-06-2020 @@ -142,7 +142,7 @@ - 20-06-2020 - - The [Bin-Gem-Node](https://github.com/zdharma-continuum/z-a-bin-gem-node) annex now + - The [Bin-Gem-Node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex now has an explicit Cygwin support — it creates additional, **extra shim files** — Windows batch scripts that allow to run the shielded applications from e.g.: Windows run dialog — if the `~/.zinit/polaris/bin` directory is being @@ -217,8 +217,8 @@ directory structure: `Pulumi/bin/{pulumi,pulumi2}`, then after `ziextract --move2 --auto` there will be the two files moved to the top level dir: `./{pulumi,pulumi2}`. To obtain the same effect using the `extract''` ice, pass two exclamation marks, i.e.: `extract'!!'`. A real-world example — it - uses [z-a-as-monitor](https://github.com/zdharma-continuum/z-a-as-monitor) and - [z-a-bin-gem-node](https://github.com/zdharma-continuum/z-a-bin-gem-node) annexes to + uses [zinit-annex-as-monitor](https://github.com/zdharma-continuum/zinit-annex-as-monitor) and + [zinit-annex-bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annexes to download a Zip package that has the files inside two-level nested directory tree: @@ -253,10 +253,10 @@ - A new feature — ability to substitute `stringA` → `stringB` in plugin source body before executing by `subst'A -> B'`. Works also for any nested `source` commands. Example — renaming the `dl''` ice into a `dload''` ice in the - [Patch-Dl](https://github.com/zdharma-continuum/z-a-patch-dl) annex: + [Patch-Dl](https://github.com/zdharma-continuum/zinit-annex-patch-dl) annex: ```zsh - zinit subst"dl'' -> dload''" for zdharma-continuum/z-a-patch-dl + zinit subst"dl'' -> dload''" for zdharma-continuum/zinit-annex-patch-dl ``` - A new ice `autoload''` which invokes `autoload -Uz …` on the given @@ -518,7 +518,7 @@ ``` The binaries will be exposed without altering the PATH via shims - ([Bin-Gem-Node](https://github.com/zdharma-continuum/z-a-bin-gem-node) annex is needed). + ([Bin-Gem-Node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex is needed). Shims are correctly removed when deleting a plugin with `zinit delete …`. - 11-12-2019 @@ -555,7 +555,7 @@ ``` i.e.: precede the plugin name with `@`. Note: `sbin''` is an ice added by the - [z-a-bin-gem-node](https://github.com/zinit/z-a-bin-gem-node) annex, it provides + [zinit-annex-bin-gem-node](https://github.com/zinit/zinit-annex-bin-gem-node) annex, it provides the command to the command line without altering `$PATH`. See the [Zinit Wiki](https://zdharma-continuum.github.io/zinit/wiki/For-Syntax/) for more @@ -687,18 +687,18 @@ - Three new Zinit annexes (i.e. [extensions](https://zdharma-continuum.github.io/zinit/wiki/Annexes/)): - - [z-a-man](https://github.com/zinit/z-a-man) + - [zinit-annex-man](https://github.com/zinit/zinit-annex-man) Generates man pages and code-documentation man pages from plugin's README.md and source files (the code documentation is obtained from [Zshelldoc](https://github.com/zdharma-continuum/zshelldoc)). - - [z-a-test](https://github.com/zinit/z-a-test) + - [zinit-annex-test](https://github.com/zinit/zinit-annex-test) Runs tests (if detected `test` target in a `Makefile` or any `*.zunit` files) on plugin installation and non-empty update. - - [z-a-patch-dl](https://github.com/zinit/z-a-patch-dl) + - [zinit-annex-patch-dl](https://github.com/zinit/zinit-annex-patch-dl) Allows easy download and applying of patches, to e.g. aid building a binary program equipped in the plugin. @@ -756,7 +756,7 @@ install everything from GitHub and other sites. Its characteristics are: 1. Also, specialized Zinit extensions — called **annexes** — allow to extend the plugin manager with new commands, URL-preprocessors (used by e.g.: - [z-a-as-monitor](https://github.com/zdharma-continuum/z-a-as-monitor) annex), + [zinit-annex-as-monitor](https://github.com/zdharma-continuum/zinit-annex-as-monitor) annex), post-install and post-update hooks and much more. See the [zdharma-continuum](https://github.com/zdharma-continuum) organization for a growing, complete list of available Zinit extensions and refer to the [Wiki @@ -1749,7 +1749,7 @@ Zinit has many benefits: Below is a configuration that adds multiple git extensions, loaded in Turbo mode, 1 second after prompt, with use of the -[Bin-Gem-Node](https://github.com/zdharma-continuum/z-a-bin-gem-node) annex: +[Bin-Gem-Node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) annex: ```zsh zinit as"null" wait"1" lucid for \ diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md index 82a6a5e86..dc5c1231c 100644 --- a/doc/CHANGELOG.md +++ b/doc/CHANGELOG.md @@ -29,7 +29,7 @@ startup. Please note that these directories will not necessarily be part of your * 19-01-2020 - The name has been changed to **Zinit** based on the results of the - [poll](https://github.com/zdharma-continuum/zinit/issues/235). + [poll](https://github.com/zdharma/zinit/issues/235). - In general, you don't have to do anything after the name change. - Only a run of `zinit update --all` might be necessary. - You might also want to rename your `zplugin` calls in `zshrc` to `zinit`. @@ -40,7 +40,7 @@ startup. Please note that these directories will not necessarily be part of your - There's a new function, `zpextract`, which unpacks the given file. It supports many formats (notably also `dmg` images) – if there's a format that's unsupported please don't hesitate to [make a - request](https://github.com/zdharma-continuum/zinit/issues/new?template=feature_request.md) + request](https://github.com/zdharma/zinit/issues/new?template=feature_request.md) for it to be added. A few facts: - the function is available only at the time of the plugin/snippet installation, - it's to be used within `atclone` and `atpull` ices, @@ -72,7 +72,7 @@ startup. Please note that these directories will not necessarily be part of your ``` The binaries will be exposed without altering the PATH via shims - ([Bin-Gem-Node](https://github.com/zinit-zsh/z-a-bin-gem-node) annex is needed). + ([Bin-Gem-Node](https://github.com/zinit-zsh/zinit-annex-bin-gem-node) annex is needed). Shims are correctly removed when deleting a plugin with `zinit delete …`. * 11-12-2019 @@ -106,7 +106,7 @@ startup. Please note that these directories will not necessarily be part of your ``` i.e.: precede the plugin name with `@`. Note: `sbin''` is an ice added by the - [z-a-bin-gem-node](https://github.com/zinit/z-a-bin-gem-node) annex, it provides + [zinit-annex-bin-gem-node](https://github.com/zinit/zinit-annex-bin-gem-node) annex, it provides the command to the command line without altering `$PATH`. See the [Zinit Wiki](https://zdharma-continuum.github.io/zinit/wiki/For-Syntax/) for more @@ -226,18 +226,18 @@ startup. Please note that these directories will not necessarily be part of your - Three new Zplugin annexes (i.e. [extensions](https://zdharma-continuum.github.io/zplugin/wiki/Annexes/)): - - [z-a-man](https://github.com/zplugin/z-a-man) + - [zinit-annex-man](https://github.com/zplugin/zinit-annex-man) Generates man pages and code-documentation man pages from plugin's README.md and source files (the code documentation is obtained from [Zshelldoc](https://github.com/zdharma/zshelldoc)). - - [z-a-test](https://github.com/zplugin/z-a-test) + - [zinit-annex-test](https://github.com/zplugin/zinit-annex-test) Runs tests (if detected `test' target in a `Makefile` or any `*.zunit` files) on plugin installation and non-empty update. - - [z-a-patch-dl](https://github.com/zplugin/z-a-patch-dl) + - [zinit-annex-patch-dl](https://github.com/zplugin/zinit-annex-patch-dl) Allows easy download and applying of patches, to e.g. aid building a binary program equipped in the plugin. @@ -437,7 +437,7 @@ startup. Please note that these directories will not necessarily be part of your * 05-02-2018 - I work much on this README however multi-file Wiki might be better to read – it - [just has been created](https://github.com/zdharma-continuum/zinit/wiki). + [just has been created](https://github.com/zdharma/zplugin/wiki). * 16-01-2018 - New ice-mod `compile` which takes pattern to select additional files to compile, e.g. @@ -493,7 +493,7 @@ startup. Please note that these directories will not necessarily be part of your [full story](#automatic-loadunload-on-condition) and [Asciinema video](https://asciinema.org/a/150825). * 29-11-2017 - - **[Turbo Mode](https://github.com/zdharma-continuum/zinit#turbo-mode-zsh--53)** – **39-50% or more faster Zsh startup!** + - **[Turbo Mode](https://github.com/zdharma/zplugin#turbo-mode-zsh--53)** – **39-50% or more faster Zsh startup!** - Subcommand `update` can update snippets, via given URL (up to this point snippets were updated via `zplugin update --all`). - Completion management is enabled for snippets (not only plugins). diff --git a/doc/install.sh b/doc/install.sh index c059e4f91..aa5aa7f98 100755 --- a/doc/install.sh +++ b/doc/install.sh @@ -93,10 +93,10 @@ EOF # Load a few important annexes, without Turbo # (this is currently required for annexes) zinit light-mode for \\ - zdharma-continuum/z-a-rust \\ - zdharma-continuum/z-a-as-monitor \\ - zdharma-continuum/z-a-patch-dl \\ - zdharma-continuum/z-a-bin-gem-node + zdharma-continuum/zinit-annex-rust \\ + zdharma-continuum/zinit-annex-as-monitor \\ + zdharma-continuum/zinit-annex-patch-dl \\ + zdharma-continuum/zinit-annex-bin-gem-node EOF echo diff --git a/doc/zinit.1 b/doc/zinit.1 index 742c96a66..e8fe331c5 100644 --- a/doc/zinit.1 +++ b/doc/zinit.1 @@ -138,15 +138,15 @@ A new ice-mod \fBreset''\fR that ivokes \fBgit reset --hard\fR (or the provided Three new zinit annexes (i.e. \fBextensions\fR \fI\(lahttps://zdharma-continuum.github.io/zinit/wiki/Annexes/\(ra\fR): .RS 4 .IP \(bu 4 -\fBz-a-man\fR \fI\(lahttps://github.com/zinit/z-a-man\(ra\fR +\fBzinit-annex-man\fR \fI\(lahttps://github.com/zinit/zinit-annex-man\(ra\fR .P Generates man pages and code-documentation man pages from plugin's README.md and source files (the code documentation is obtained from \fBZshelldoc\fR \fI\(lahttps://github.com/zdharma/zshelldoc\(ra\fR). .IP \(bu 4 -\fBz-a-test\fR \fI\(lahttps://github.com/zinit/z-a-test\(ra\fR +\fBzinit-annex-test\fR \fI\(lahttps://github.com/zinit/zinit-annex-test\(ra\fR .P Runs tests (if detected \fBtest\fR target in a \fBMakefile\fR or any \fB*.zunit\fR files) on plugin installation and non-empty update. .IP \(bu 4 -\fBz-a-patch-dl\fR \fI\(lahttps://github.com/zinit/z-a-patch-dl\(ra\fR +\fBzinit-annex-patch-dl\fR \fI\(lahttps://github.com/zinit/zinit-annex-patch-dl\(ra\fR .P Allows easy download and applying of patches, to e.g. aid building a binary program equipped in the plugin. .RE 0 diff --git a/zinit-install.zsh b/zinit-install.zsh index 952f31dd6..703d2b82b 100644 --- a/zinit-install.zsh +++ b/zinit-install.zsh @@ -206,9 +206,9 @@ builtin source "${ZINIT[BIN_DIR]}/zinit-side.zsh" || { builtin print -P "${ZINIT req=( ${(s.;.)${:-${required:+$required\;}${ICE[required]}}} ) for required ( $req ) { if [[ $required == (bgn|dl|monitor) ]]; then - if [[ ( $required == bgn && -z ${(k)ZINIT_EXTS[(r)<-> z-annex-data: z-a-bin-gem-node *]} ) || \ - ( $required == dl && -z ${(k)ZINIT_EXTS[(r)<-> z-annex-data: z-a-patch-dl *]} ) || \ - ( $required == monitor && -z ${(k)ZINIT_EXTS[(r)<-> z-annex-data: z-a-readurl *]} ) + if [[ ( $required == bgn && -z ${(k)ZINIT_EXTS[(r)<-> z-annex-data: zinit-annex-bin-gem-node *]} ) || \ + ( $required == dl && -z ${(k)ZINIT_EXTS[(r)<-> z-annex-data: zinit-annex-patch-dl *]} ) || \ + ( $required == monitor && -z ${(k)ZINIT_EXTS[(r)<-> z-annex-data: zinit-annex-readurl *]} ) ]]; then local -A namemap namemap=( bgn Bin-Gem-Node dl Patch-Dl monitor readurl ) @@ -221,7 +221,7 @@ builtin source "${ZINIT[BIN_DIR]}/zinit-side.zsh" || { builtin print -P "${ZINIT +zinit-message '{error}requires the {apo}`{annex}'${namemap[$required]}'{apo}`' \ "{error}annex, which is currently not installed." \ "{nl}{nl}If you'd like to install it, you can visit its homepage:" \ - "{nl}– {url}https://github.com/zinit-zsh/z-a-${(L)namemap[$required]}{rst}" \ + "{nl}– {url}https://github.com/zinit-zsh/zinit-annex-${(L)namemap[$required]}{rst}" \ "{nl}for instructions." (( ${#profiles[@]:#$profile} > 0 )) && \ +zinit-message "{nl}Other available profiles are:" \ @@ -249,16 +249,16 @@ builtin source "${ZINIT[BIN_DIR]}/zinit-side.zsh" || { builtin print -P "${ZINIT fi } - if [[ -n ${ICE[dl]} && -z ${(k)ZINIT_EXTS[(r)<-> z-annex-data: z-a-patch-dl *]} ]] { + if [[ -n ${ICE[dl]} && -z ${(k)ZINIT_EXTS[(r)<-> z-annex-data: zinit-annex-patch-dl *]} ]] { +zinit-message "{nl}{u-warn}WARNING{b-warn}:{rst} the profile uses" \ - "{ice}dl''{rst} ice however there's currently no {annex}z-a-patch-dl{rst}" \ + "{ice}dl''{rst} ice however there's currently no {annex}zinit-annex-patch-dl{rst}" \ "annex loaded, which provides it." +zinit-message "The ice will be inactive, i.e.: no additional" \ "files will become downloaded (the ice downloads the given URLs)." \ "The package should still work, as it doesn't indicate to" \ "{u}{slight}require{rst} the annex." +zinit-message "{nl}You can download the" \ - "annex from its homepage at {url}https://github.com/zinit-zsh/z-a-patch-dl{rst}." + "annex from its homepage at {url}https://github.com/zinit-zsh/zinit-annex-patch-dl{rst}." } [[ -n ${jsondata1[message]} ]] && \ @@ -1321,10 +1321,10 @@ builtin source "${ZINIT[BIN_DIR]}/zinit-side.zsh" || { builtin print -P "${ZINIT local url=$1 integer correct=0 [[ -o ksharrays ]] && correct=1 - opts=( -u ) # for z-a-readurl + opts=( -u ) # for zinit-annex-readurl # Create a local copy of OPTS, basically - # for z-a-readurl annex + # for zinit-annex-readurl annex local -A ice_opts ice_opts=( "${(kv)OPTS[@]}" ) local -A OPTS From 2728a6431ff8674ef67e349e91f74be282e3f6a6 Mon Sep 17 00:00:00 2001 From: Philipp Schmitt Date: Thu, 11 Nov 2021 20:06:09 +0100 Subject: [PATCH 2/2] Update changelog: New annex urls --- doc/CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md index dc5c1231c..0721ef12f 100644 --- a/doc/CHANGELOG.md +++ b/doc/CHANGELOG.md @@ -9,6 +9,12 @@ # Changelog All notable changes to this project will be documented in this file. +* 11-11-2021 + - The annexes repos have been renamed to improve discoverability. They used to +be called `z-a-${name}` and have been renamed to `zinit-annex-${name}`. You +don't *need* to update your configs right away since GitHub redirects to the +new URLs. + * 06-11-2021 - 🚧 zinit has a new home: https://github.com/zdharma-continuum/zinit - The migration from @zdharma, @Zsh-Packages and @zinit-zsh is still in