https://github.com/buonomo/yarn-extra-completion

ZSH completion plugin for yarn
https://github.com/buonomo/yarn-extra-completion

completion plugin yarn zsh

Last synced: 25 days ago
JSON representation

ZSH completion plugin for yarn

• Host: GitHub
• URL: https://github.com/buonomo/yarn-extra-completion
• Owner: BuonOmo
• License: other
• Created: 2017-05-29T05:47:25.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-11-10T10:58:12.000Z (about 2 years ago)
• Last Synced: 2024-11-19T21:25:29.662Z (about 1 month ago)
• Topics: completion, plugin, yarn, zsh
• Language: Shell
• Homepage:
• Size: 2.35 MB
• Stars: 37
• Watchers: 4
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# yarn-extra-completion

This plugin is greatly inspired by [zsh-better-npm-completion](https://github.com/lukechilds/zsh-better-npm-completion). It works the same way, as you can see with `npm` demo:



* Makes `yarn add` recommendations from npm cache,

* Makes `yarn remove` recommendations from `dependencies`/`devDependencies`,

* Shows detailed information on script contents for `npm run`,

* Calls already installed yarn completion for any other command.

# Pre-requisites

You'll need [jq](https://stedolan.github.io/jq/download/).

It is strongly suggested that you also have the default yarn suggestion under

the name of `_yarn`. Or that you set `YARN_EXTRA_COMPLETION_DEFAULT=_your_default_function`.

## Installation

### Using [Antigen](https://github.com/zsh-users/antigen)

Bundle `zsh-better-npm-completion` in your `.zshrc`

```shell

antigen bundle buonomo/yarn-extra-completion

```

### Using [zplug](https://github.com/b4b4r07/zplug)

Load `zsh-better-npm-completion` as a plugin in your `.zshrc`

```shell

zplug "buonomo/yarn-extra-completion", defer:2

```

### Using [zgen](https://github.com/tarjoilija/zgen)

Include the load command in your `.zshrc`

```shell

zgen load buonomo/yarn-extra-completion

```

### As an [Oh My ZSH!](https://github.com/robbyrussell/oh-my-zsh) custom plugin

Clone `yarn-extra-completion` into your custom plugins repo

```shell

git clone https://github.com/buonomo/yarn-extra-completion ~/.oh-my-zsh/custom/plugins/yarn-extra-completion

```

Then load as a plugin in your `.zshrc`

```shell

plugins+=(yarn-extra-completion)

```

### Manually

Clone this repository somewhere (`~/.yarn-extra-completion` for example)

```shell

git clone https://github.com/buonomo/yarn-extra-completion.git ~/.yarn-extra-completion

```

Then source it in your `.zshrc`

```shell

source ~/.yarn-extra-completion/yarn-extra-completion.plugin.zsh

```

## License

MIT © Ulysse Buonomo