Skip to content

Commit

Permalink
Merge pull request #3164 from nestjs/11.0.0
Browse files Browse the repository at this point in the history 
release: version 11.0.0
  • Loading branch information
@kamilmysliwiec
kamilmysliwiec authored Jan 17, 2025
2 parents 4ba0026 + 7b1c939 commit 091dd76
Show file tree
Hide file tree
Showing 20 changed files with 1,075 additions and 246 deletions.
18 changes: 9 additions & 9 deletions content/cli/overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,15 @@ Aside from a few specific considerations around how the **build** process works

You can use either mode to manage multiple projects. Here's a quick summary of the differences:

| Feature | Standard Mode | Monorepo Mode |
| ----------------------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------------------------- |
| Multiple projects | Separate file system structure | Single file system structure |
| `node_modules` & `package.json` | Separate instances | Shared across monorepo |
| Default compiler | `tsc` | webpack |
| Compiler settings | Specified separately | Monorepo defaults that can be overridden per project |
| Config files like `.eslintrc.js`, `.prettierrc`, etc. | Specified separately | Shared across monorepo |
| `nest build` and `nest start` commands | Target defaults automatically to the (only) project in the context | Target defaults to the **default project** in the monorepo |
| Libraries | Managed manually, usually via npm packaging | Built-in support, including path management and bundling |
| Feature | Standard Mode | Monorepo Mode |
| ---------------------------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------------------------- |
| Multiple projects | Separate file system structure | Single file system structure |
| `node_modules` & `package.json` | Separate instances | Shared across monorepo |
| Default compiler | `tsc` | webpack |
| Compiler settings | Specified separately | Monorepo defaults that can be overridden per project |
| Config files like `eslint.config.mjs`, `.prettierrc`, etc. | Specified separately | Shared across monorepo |
| `nest build` and `nest start` commands | Target defaults automatically to the (only) project in the context | Target defaults to the **default project** in the monorepo |
| Libraries | Managed manually, usually via npm packaging | Built-in support, including path management and bundling |

Read the sections on [Workspaces](/cli/monorepo) and [Libraries](/cli/libraries) for more detailed information to help you decide which mode is most suitable for you.

Expand Down
92 changes: 49 additions & 43 deletions content/cli/usages.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,25 +54,25 @@ $ nest g <schematic> <name> [options]

##### Schematics

| Name | Alias | Description |
| ------------- | ----- | ----------------------------------------------------------------------------------------------------------------------|
| `app` | | Generate a new application within a monorepo (converting to monorepo if it's a standard structure). |
| `library` | `lib` | Generate a new library within a monorepo (converting to monorepo if it's a standard structure). |
| `class` | `cl` | Generate a new class. |
| `controller` | `co` | Generate a controller declaration. |
| `decorator` | `d` | Generate a custom decorator. |
| `filter` | `f` | Generate a filter declaration. |
| `gateway` | `ga` | Generate a gateway declaration. |
| `guard` | `gu` | Generate a guard declaration. |
| `interface` | `itf` | Generate an interface. |
| `interceptor` | `itc` | Generate an interceptor declaration. |
| `middleware` | `mi` | Generate a middleware declaration. |
| `module` | `mo` | Generate a module declaration. |
| `pipe` | `pi` | Generate a pipe declaration. |
| `provider` | `pr` | Generate a provider declaration. |
| `resolver` | `r` | Generate a resolver declaration. |
| `resource` | `res` | Generate a new CRUD resource. See the [CRUD (resource) generator](/recipes/crud-generator) for more details. (TS only)|
| `service` | `s` | Generate a service declaration. |
| Name | Alias | Description |
| ------------- | ----- | ---------------------------------------------------------------------------------------------------------------------- |
| `app` | | Generate a new application within a monorepo (converting to monorepo if it's a standard structure). |
| `library` | `lib` | Generate a new library within a monorepo (converting to monorepo if it's a standard structure). |
| `class` | `cl` | Generate a new class. |
| `controller` | `co` | Generate a controller declaration. |
| `decorator` | `d` | Generate a custom decorator. |
| `filter` | `f` | Generate a filter declaration. |
| `gateway` | `ga` | Generate a gateway declaration. |
| `guard` | `gu` | Generate a guard declaration. |
| `interface` | `itf` | Generate an interface. |
| `interceptor` | `itc` | Generate an interceptor declaration. |
| `middleware` | `mi` | Generate a middleware declaration. |
| `module` | `mo` | Generate a module declaration. |
| `pipe` | `pi` | Generate a pipe declaration. |
| `provider` | `pr` | Generate a provider declaration. |
| `resolver` | `r` | Generate a resolver declaration. |
| `resource` | `res` | Generate a new CRUD resource. See the [CRUD (resource) generator](/recipes/crud-generator) for more details. (TS only) |
| `service` | `s` | Generate a service declaration. |

##### Options

Expand Down Expand Up @@ -107,15 +107,19 @@ $ nest build <name> [options]

##### Options

| Option | Description |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `--path [path]` | Path to `tsconfig` file. <br/>Alias `-p` |
| `--config [path]` | Path to `nest-cli` configuration file. <br/>Alias `-c` |
| `--watch` | Run in watch mode (live-reload).<br /> If you're using `tsc` for compilation, you can type `rs` to restart the application (when `manualRestart` option is set to `true`). <br/>Alias `-w` |
| `--builder [name]` | Specify the builder to use for compilation (`tsc`, `swc`, or `webpack`). <br/>Alias `-b` |
| `--webpack` | Use webpack for compilation (deprecated: use `--builder webpack` instead). |
| `--webpackPath` | Path to webpack configuration. |
| `--tsc` | Force use `tsc` for compilation. |
| Option | Description |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `--path [path]` | Path to `tsconfig` file. <br/>Alias `-p` |
| `--config [path]` | Path to `nest-cli` configuration file. <br/>Alias `-c` |
| `--watch` | Run in watch mode (live-reload).<br /> If you're using `tsc` for compilation, you can type `rs` to restart the application (when `manualRestart` option is set to `true`). <br/>Alias `-w` |
| `--builder [name]` | Specify the builder to use for compilation (`tsc`, `swc`, or `webpack`). <br/>Alias `-b` |
| `--webpack` | Use webpack for compilation (deprecated: use `--builder webpack` instead). |
| `--webpackPath` | Path to webpack configuration. |
| `--tsc` | Force use `tsc` for compilation. |
| `--watchAssets` | Watch non-TS files (assets like `.graphql` etc.). See [Assets](cli/monorepo#assets) for more details. |
| `--type-check` | Enable type checking (when SWC is used). |
| `--all` | Build all projects in a monorepo. |
| `--preserveWatchOutput` | Keep outdated console output in watch mode instead of clearing the screen. (`tsc` watch mode only) |

#### nest start

Expand All @@ -133,20 +137,22 @@ $ nest start <name> [options]

##### Options

| Option | Description |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `--path [path]` | Path to `tsconfig` file. <br/>Alias `-p` |
| `--config [path]` | Path to `nest-cli` configuration file. <br/>Alias `-c` |
| `--watch` | Run in watch mode (live-reload) <br/>Alias `-w` |
| `--builder [name]` | Specify the builder to use for compilation (`tsc`, `swc`, or `webpack`). <br/>Alias `-b` |
| `--preserveWatchOutput` | Keep outdated console output in watch mode instead of clearing the screen. (`tsc` watch mode only) |
| `--watchAssets` | Run in watch mode (live-reload), watching non-TS files (assets). See [Assets](cli/monorepo#assets) for more details. |
| `--debug [hostport]` | Run in debug mode (with --inspect flag) <br/>Alias `-d` |
| `--webpack` | Use webpack for compilation. (deprecated: use `--builder webpack` instead) |
| `--webpackPath` | Path to webpack configuration. |
| `--tsc` | Force use `tsc` for compilation. |
| `--exec [binary]` | Binary to run (default: `node`). <br/>Alias `-e` |
| `-- [key=value]` | Command-line arguments that can be referenced with `process.argv`. |
| Option | Description |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `--path [path]` | Path to `tsconfig` file. <br/>Alias `-p` |
| `--config [path]` | Path to `nest-cli` configuration file. <br/>Alias `-c` |
| `--watch` | Run in watch mode (live-reload) <br/>Alias `-w` |
| `--builder [name]` | Specify the builder to use for compilation (`tsc`, `swc`, or `webpack`). <br/>Alias `-b` |
| `--preserveWatchOutput` | Keep outdated console output in watch mode instead of clearing the screen. (`tsc` watch mode only) |
| `--watchAssets` | Run in watch mode (live-reload), watching non-TS files (assets). See [Assets](cli/monorepo#assets) for more details. |
| `--debug [hostport]` | Run in debug mode (with --inspect flag) <br/>Alias `-d` |
| `--webpack` | Use webpack for compilation. (deprecated: use `--builder webpack` instead) |
| `--webpackPath` | Path to webpack configuration. |
| `--tsc` | Force use `tsc` for compilation. |
| `--exec [binary]` | Binary to run (default: `node`). <br/>Alias `-e` |
| `--no-shell` | Do not spawn child processes within a shell (see node's `child_process.spawn()` method docs). |
| `--env-file` | Loads environment variables from a file relative to the current directory, making them available to applications on `process.env`. |
| `-- [key=value]` | Command-line arguments that can be referenced with `process.argv`. |

#### nest add

Expand Down Expand Up @@ -180,7 +186,7 @@ $ nest info
[System Information]
OS Version : macOS High Sierra
NodeJS Version : v16.18.0
NodeJS Version : v20.18.0
[Nest Information]
microservices version : 10.0.0
websockets version : 10.0.0
Expand Down
Loading

0 comments on commit 091dd76

Please sign in to comment.