https://github.com/lukechilds/zsh-better-npm-completion

Better completion for npm
https://github.com/lukechilds/zsh-better-npm-completion

completion npm zsh zsh-plugin

Last synced: 5 days ago
JSON representation

Better completion for npm

• Host: GitHub
• URL: https://github.com/lukechilds/zsh-better-npm-completion
• Owner: lukechilds
• License: mit
• Created: 2016-06-29T22:25:43.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-31T09:38:35.000Z (about 1 month ago)
• Last Synced: 2024-11-20T07:13:47.853Z (22 days ago)
• Topics: completion, npm, zsh, zsh-plugin
• Language: Shell
• Homepage:
• Size: 2.34 MB
• Stars: 471
• Watchers: 7
• Forks: 35
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-npm - zsh-better-npm-completion - Better ZSH completion for npm. (Tools / CLI)
• awesome-starred-test - lukechilds/zsh-better-npm-completion - Better completion for npm (Shell)
• awesome-npm - zsh-better-npm-completion - Better ZSH completion for npm. (Tools / CLI)

README

        
# zsh-better-npm-completion

> Better completion for `npm`

[![GitHub Donate](https://badgen.net/badge/GitHub/Sponsor/D959A7?icon=github)](https://github.com/sponsors/lukechilds)

[![Bitcoin Donate](https://badgen.net/badge/Bitcoin/Donate/F19537?icon=bitcoin)](https://lu.ke/tip/bitcoin)

[![Lightning Donate](https://badgen.net/badge/Lightning/Donate/F6BC41?icon=bitcoin-lightning)](https://lu.ke/tip/lightning)



* Makes `npm install` recommendations from npm cache

* Makes `npm uninstall` recommendations from `dependencies`/`devDependencies`

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

* Falls back to default npm completions if we don't have anything better

## Installation

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

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

```shell

antigen bundle lukechilds/zsh-better-npm-completion

```

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

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

```shell

zplug "lukechilds/zsh-better-npm-completion", defer:2

```

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

Include the load command in your `.zshrc`

```shell

zgen load lukechilds/zsh-better-npm-completion

```

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

Clone `zsh-better-npm-completion` into your custom plugins repo

```shell

git clone https://github.com/lukechilds/zsh-better-npm-completion ~/.oh-my-zsh/custom/plugins/zsh-better-npm-completion

```

Then load as a plugin in your `.zshrc`

```shell

plugins+=(zsh-better-npm-completion)

```

### Manually

Clone this repository somewhere (`~/.zsh-better-npm-completion` for example)

```shell

git clone https://github.com/lukechilds/zsh-better-npm-completion.git ~/.zsh-better-npm-completion

```

Then source it in your `.zshrc`

```shell

source ~/.zsh-better-npm-completion/zsh-better-npm-completion.plugin.zsh

```

## Related

- [`zsh-nvm`](https://github.com/lukechilds/zsh-nvm) - Zsh plugin for installing, updating and loading `nvm`

- [`gifgen`](https://github.com/lukechilds/gifgen) - Simple high quality GIF encoding 

## License

MIT © Luke Childs