Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/jscutlery/nx-completion

nx zsh zsh-plugin

Last synced: about 1 month ago
JSON representation

Nx workspace completion plugin for Zsh.

Host: GitHub
URL: https://github.com/jscutlery/nx-completion
Owner: jscutlery
License: mit
Created: 2021-03-19T21:11:46.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2023-12-15T11:54:26.000Z (about 1 year ago)
Last Synced: 2024-04-16T16:22:39.639Z (8 months ago)
Topics: nx, zsh, zsh-plugin
Language: Shell
Homepage:
Size: 114 KB
Stars: 124
Watchers: 6
Forks: 14
Open Issues: 7
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

# Nx completion plugin for Zsh

> This plugin bring Nx autocompletion to Zsh.

![demo](https://user-images.githubusercontent.com/8522558/111908149-67e8d780-8a58-11eb-9343-691f6d664163.gif)

## Features

- Commands and arguments autocompletion
- Projects, targets, and generators autocompletion
- Support different workspace versions

## Install

### Prerequisit

Install [`jq`](https://stedolan.github.io/jq/) dependency:

```shell
apt install jq
```

On MacOS you can install with:

```shell
brew install jq
```

> **Note**: [`jq`](https://stedolan.github.io/jq/) is a lightweight command-line JSON processor used to manipulate the workspace graph.

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

Clone the repository into the custom plugins directory:

```shell
git clone [email protected]:jscutlery/nx-completion.git ~/.oh-my-zsh/custom/plugins/nx-completion
```

Then load it as a plugin in your `.zshrc`:

```shell
plugins+=(nx-completion)
```

### Manually

Clone this repository somewhere (`~/.nx-completion` for example):

```shell
git clone [email protected]:jscutlery/nx-completion.git ~/.nx-completion
```

Then source it in your `.zshrc`:

```shell
source ~/.nx-completion/nx-completion.plugin.zsh
```

## License

This project is MIT licensed.