fix(npx)!: detect new npx versions and fail gracefully (#10452)

BREAKING CHANGE: the `npx` plugin used a feature of `npx` to check for
npm packages and run them if a command was not found. This feature was
removed in v7.0.0 and was deemed insecure. The `npx` plugin is now
officially deprecated and will be removed soon.

Fixes #10452
This commit is contained in:
Marc Cornellà 2022-01-26 17:13:10 +01:00
parent fc40b53e64
commit 3741d1aa02
No known key found for this signature in database
GPG key ID: 0314585E776A9C1B
3 changed files with 14 additions and 32 deletions

View file

@ -1,27 +1,4 @@
# NPX Plugin
> npx(1) -- execute npm package binaries. ([more info](https://github.com/npm/npx))
This plugin automatically registers npx command-not-found handler if `npx` exists in your `$PATH`.
To use it, add `npx` to the plugins array in your zshrc file:
```zsh
plugins=(.... npx)
```
## Note
The shell auto-fallback doesn't auto-install plain packages. In order to get it to install something, you need to add `@`:
```
➜ jasmine@latest # or just `jasmine@`
npx: installed 13 in 1.896s
Randomized with seed 54385
Started
```
It does it this way so folks using the fallback don't accidentally try to install regular typoes.
# npx plugin
## Deprecation

View file

@ -1,7 +1,12 @@
# NPX Plugin
# https://www.npmjs.com/package/npx
# Maintainer: Pooya Parsa <pooya@pi0.ir>
if (( ! $+commands[npx] )); then
return
fi
(( $+commands[npx] )) && {
source <(npx --shell-auto-fallback zsh)
}
if ! npx_fallback_script="$(npx --shell-auto-fallback zsh 2>/dev/null)"; then
print -u2 ${(%):-"%F{yellow}This \`npx\` version ($(npx --version)) is not supported.%f"}
else
source <(<<< "$npx_fallback_script")
fi
print -u2 ${(%):-"%F{yellow}The \`npx\` plugin is deprecated and will be removed soon. %BPlease disable it%b.%f"}
unset npx_fallback_script

View file

@ -1,5 +1,5 @@
print ${(%):-'%F{yellow}The `osx` plugin is deprecated and has been renamed to `macos`.'}
print ${(%):-'Please update your .zshrc to use the `%Bmacos%b` plugin instead.%f'}
print -u2 ${(%):-'%F{yellow}The `osx` plugin is deprecated and has been renamed to `macos`.'}
print -u2 ${(%):-'Please update your .zshrc to use the `%Bmacos%b` plugin instead.%f'}
(( ${fpath[(Ie)$ZSH/plugins/macos]} )) || fpath=("$ZSH/plugins/macos" $fpath)
source "$ZSH/plugins/macos/macos.plugin.zsh"