mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2026-01-23 02:35:38 +01:00
nestjs command alieases
This commit is contained in:
parent
51d0e0aa1d
commit
3208439652
2 changed files with 95 additions and 0 deletions
54
plugins/nestjs/README.md
Normal file
54
plugins/nestjs/README.md
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
# NestJS Plugin for Oh My Zsh
|
||||||
|
|
||||||
|
This plugin provides aliases for common [NestJS CLI](https://docs.nestjs.com/cli/overview) commands.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- [NestJS CLI](https://docs.nestjs.com/cli/overview#installation) installed globally:
|
||||||
|
`npm install -g @nestjs/cli`
|
||||||
|
|
||||||
|
## Aliases
|
||||||
|
|
||||||
|
| Alias | Command | Description |
|
||||||
|
| :------ | :--------------------------- | :------------------------------------------ |
|
||||||
|
| `nnew` | `nest new` | Create a new NestJS project |
|
||||||
|
| `nb` | `nest build` | Build the NestJS application |
|
||||||
|
| `ns` | `nest start` | Start the application |
|
||||||
|
| `nsw` | `nest start --watch` | Start the application in watch mode |
|
||||||
|
| `nsd` | `nest start --dev` | Start the application in dev mode |
|
||||||
|
| `nsdbg` | `nest start --debug --watch` | Start the application in debug & watch mode |
|
||||||
|
| `ng` | `nest generate` | Generate a NestJS element |
|
||||||
|
| `ngm` | `nest generate module` | Generate a module |
|
||||||
|
| `ngc` | `nest generate controller` | Generate a controller |
|
||||||
|
| `ngs` | `nest generate service` | Generate a service |
|
||||||
|
| `ngg` | `nest generate guard` | Generate a guard |
|
||||||
|
| `ngp` | `nest generate pipe` | Generate a pipe |
|
||||||
|
| `ngf` | `nest generate filter` | Generate a filter |
|
||||||
|
| `ngr` | `nest generate resolver` | Generate a GraphQL resolver |
|
||||||
|
| `ngcl` | `nest generate class` | Generate a class |
|
||||||
|
| `ngi` | `nest generate interface` | Generate an interface |
|
||||||
|
| `ngit` | `nest generate interceptor` | Generate an interceptor |
|
||||||
|
| `ngmi` | `nest generate middleware` | Generate a middleware |
|
||||||
|
| `ngd` | `nest generate decorator` | Generate a custom decorator |
|
||||||
|
| `ngres` | `nest generate resource` | Generate a CRUD resource |
|
||||||
|
| `nglib` | `nest generate library` | Generate a new library |
|
||||||
|
| `ngsub` | `nest generate sub-app` | Generate a new sub-application (monorepo) |
|
||||||
|
| `na` | `nest add` | Add a library to the project |
|
||||||
|
| `ni` | `nest info` | Display NestJS project information |
|
||||||
|
| `nu` | `nest update` | Update NestJS dependencies |
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
1. Clone this repository into your Oh My Zsh plugins directory (usually `~/.oh-my-zsh/custom/plugins`):
|
||||||
|
```sh
|
||||||
|
git clone https://github.com/ohmyzsh/ohmyzsh.git # Or your fork
|
||||||
|
# Navigate to the plugins directory within the main repo if developing locally
|
||||||
|
# cp -r path/to/your/nestjs/plugin ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/nestjs
|
||||||
|
```
|
||||||
|
_(Adjust the clone/copy command based on whether you are contributing to the main repo or using a local
|
||||||
|
copy)_
|
||||||
|
2. Add `nestjs` to the `plugins` array in your `~/.zshrc` file:
|
||||||
|
```zsh
|
||||||
|
plugins=(... nestjs)
|
||||||
|
```
|
||||||
|
3. Restart your terminal or source your `~/.zshrc` file: `source ~/.zshrc`
|
||||||
41
plugins/nestjs/nestjs.plugin.zsh
Normal file
41
plugins/nestjs/nestjs.plugin.zsh
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
# Oh My Zsh plugin for NestJS CLI
|
||||||
|
|
||||||
|
# Check if nest command exists
|
||||||
|
if ! command -v nest &>/dev/null; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Project creation
|
||||||
|
alias nnew='nest new'
|
||||||
|
|
||||||
|
# Basic development
|
||||||
|
alias nb='nest build'
|
||||||
|
alias ns='nest start'
|
||||||
|
alias nsw='nest start --watch'
|
||||||
|
alias nsd='nest start --dev' # Alias for start --watch
|
||||||
|
alias nsdbg='nest start --debug --watch'
|
||||||
|
|
||||||
|
# Code generation (short aliases)
|
||||||
|
alias ng='nest generate'
|
||||||
|
alias ngm='nest generate module'
|
||||||
|
alias ngc='nest generate controller'
|
||||||
|
alias ngs='nest generate service'
|
||||||
|
alias ngg='nest generate guard'
|
||||||
|
alias ngp='nest generate pipe'
|
||||||
|
alias ngf='nest generate filter'
|
||||||
|
alias ngr='nest generate resolver'
|
||||||
|
alias ngcl='nest generate class'
|
||||||
|
alias ngi='nest generate interface'
|
||||||
|
alias ngit='nest generate interceptor'
|
||||||
|
alias ngmi='nest generate middleware'
|
||||||
|
alias ngd='nest generate decorator'
|
||||||
|
alias ngres='nest generate resource'
|
||||||
|
alias nglib='nest generate library'
|
||||||
|
alias ngsub='nest generate sub-app'
|
||||||
|
|
||||||
|
# Other commands
|
||||||
|
alias na='nest add'
|
||||||
|
alias ni='nest info'
|
||||||
|
alias nu='nest update'
|
||||||
|
|
||||||
|
# You can add more aliases or functions here as needed.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue