用法 · Nest.js 中文文檔

## 用法 ### CLI命令參考 ### nest new 創建一個新的(標準模式)Nest項目。 ```bash $ nest new <name> [options] $ nest n <name> [options] ``` 描述創建并初始化一個新的 `Nest` 項目。提示使用包管理器。 - 創建具有給定的文件夾 - 用配置文件填充文件夾 - 為源代碼( `/src` )和端到端測試( `/test` )創建子文件夾 - 用應用程序組件和測試的默認文件填充子文件夾參數 |參數 | 描述 | |---|---| | `<name>` |新項目的名稱| 選項 |選項|描述| |---|---| | `--dry-run` |報告將要進行的更改，但不更改文件系統。別名:- d| |`--skip-git`|跳過 `git` 存儲庫初始化。別名:- g| |`--skip-install`|跳過軟件包安裝。別名：-s| |`--package-manager [package-manager]`| 指定包管理器。使用 `npm` 或 `yarn`。必須全局安裝包管理器。別名: -p| |`--language [language]` |指定編程語言(`TS` 或 `JS`)。別名:- l| |`--collection [collectionName]`| 指定邏輯示意圖集合。使用已安裝的包含原理的 `npm` 軟件包的軟件包名稱。別名：-c| ### nest generate 根據原理圖生成或修改文件 ```bash $ nest generate <schematic> <name> [options] $ nest g <schematic> <name> [options] ``` 參數 |參數 | 描述 | |---|---| |`<schematic>`| 原理圖或集合:生成原理圖。可用的示意圖見下表。| | `<name>` |生成的組件的名稱。| Schematics |名稱|別名|描述| |---|---|---| |`app`||在 `monorepo` 中生成一個新應用程序(如果它是一個標準結構，則轉換為 `monorepo`)。| |`library`|`lib`|在 `monorepo` 中生成一個新庫(如果是標準結構，則轉換為 `monorepo` )。| |`class`| `cl`|生成一個新類。| |`controller`|`co`|生成控制器聲明| |`decorator` |`d`| 生成自定義裝飾器。| |`filter`|`f`|生成過濾器聲明。| |`gateway`| `ga`|生成網關聲明。| |`guard`|`gu`|生成守衛聲明。| |`interface`||生成一個接口。| |`interceptor`|`in`|生成一個攔截器聲明。| |`middleware`|`mi`|生成中間件聲明。| |`module`|`mo`|生成模塊聲明。| |`pipe`|`pi`|生成管道聲明。| |`provider`|`pr`|生成提供者聲明。| |`resolver`|`r`|生成解析器聲明。| |`service`|`s`|生成服務聲明。| 選項： |選項|描述| |---|--| |`--dry-run`| 報告將要進行的更改，但不更改文件系統。別名:- d| |`--project [project]`|應該將該元素添加到項目中。別名:-p| |`--flat`|不要為元素生成文件夾。| |`--collection [collectionName]`|指定邏輯示意圖集合。使用已安裝的包含原理圖的npm軟件包的軟包名稱。別名：-c| |`--spec`|強制spec文件生成（默認）| |`--no-spec`|禁用spec文件生成| ### nest build 將應用程序或工作區編譯到輸出文件夾中。 ```bash $ nest build <name> [options] ``` 參數 |參數 | 描述 | |---|---| |`<name>`|要構建的項目的名稱。| 選項： |選項|描述| |---|--| |`--path [path]`| `tsconfig`文件的路徑。別名: `-p`| |`--watch`| 在監視模式下運行（實時重載）別名-w| |`--webpack`|使用 `webpack` 進行編譯。| |`--webpackPath`|配置 `webpack` 的路徑。| |`--tsc`|強制使用 `tsc` 編譯。| ### nest start 編譯并運行應用程序(或工作空間中的默認項目)。 ```bash $ nest start <name> [options] ``` 參數 |參數 | 描述 | |---|---| |`<name>`|要運行的項目的名稱。| 選項： |選項|描述| |---|--| |`--path [path]`| `tsconfig`文件的路徑。別名: `-p`| |`--config [path]`| `nest-cli`配置文件的路徑。別名: `-c`| |`--watch`| 在監視模式下運行（實時重載）別名-w| |`--preserveWatchOutput`| 在watch模式下，保存命令行輸出內容而不是清空屏幕（僅在`tsc watch`模式下)| |`--watchAssets`| 運行在watch模式下（熱重載），監控非TS文件（資源文件），見**資源文件**了解更多細節| |`--debug [hostport]`| 在debug模式運行（使用--inspect標識），別名-d| |`--webpack`|使用 `webpack` 進行編譯。| |`--webpackPath`|webpack配置路徑。| |`--tsc`|強制使用 `tsc` 編譯。| |`--exec [binary]`|要運行的二進制文件（默認：`node`）。別名: `-e`| ### nest add 導入一個已打包為 `nest庫`的庫，運行其安裝示意圖;導入一個已打包為 `nest` 庫的庫，運行其安裝示意圖 ```bash $ nest add <name> [options] ``` 選項： |選項|描述| |---|--| |`<name>`|要導入的庫的名稱。| ### nest update 將 `package.json` “依賴項”列表中的 `@nestjs` 依賴項更新為其 `@latest` 版本。選項： |選項|描述| |---|--| |`--force`|做升級而不是更新別名: -f| |`--tag`|更新為標記版本（使用 `@latest`，`@<tag>`等）別名-wt| ### nest info 顯示nest安裝的包和其他有用的系統信息，例如： ```bash _ _ _ ___ _____ _____ _ _____ | \ | | | | |_ |/ ___|/ __ \| | |_ _| | \| | ___ ___ | |_ | |\ `--. | / \/| | | | | . ` | / _ \/ __|| __| | | `--. \| | | | | | | |\ || __/\__ \| |_ /\__/ //\__/ /| \__/\| |_____| |_ \_| \_/ \___||___/ \__|\____/ \____/ \____/\_____/\___/ [System Information] OS Version : macOS High Sierra NodeJS Version : v8.9.0 YARN Version : 1.5.1 [Nest Information] microservices version : 6.0.0 websockets version : 6.0.0 testing version : 6.0.0 common version : 6.0.0 core version : 6.0.0 ```