miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(nest): update Nest plugin overview (#8903)

Browse Source 
* docs(nest): update Nest plugin overview

* docs(nest): add back application proxies

Co-authored-by: Chau Tran <ctran@Chaus-MacBook-Pro.local>
This commit is contained in:
Chau Tran 2022-02-15 07:59:12 -06:00 committed by GitHub
parent 2ce696d708
commit 1ec7244c6a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 106 additions and 152 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

258
docs/shared/nest-plugin.md
View File

@ -11,189 +11,143 @@ Nest.js is a framework designed for building scalable server-side applications.
Many conventions and best practices used in Angular applications can be also be used in Nest. Many conventions and best practices used in Angular applications can be also be used in Nest.
## Installing the Nest Plugin ## Setting Up Nest
Installing the Nest plugin to a workspace can be done with the following: To create a new workspace with Nest, run the following command:
```bash ```shell
yarn add -D @nrwl/nest npx create-nx-workspace my-workspace --preset=nest
``` ```
```bash Yarn users can use the following command instead:
```shell
yarn create nx-workspace my-workspace --preset=nest
```
To add the Nest plugin to an existing workspace, run one the following commands:
```shell
npm install -D @nrwl/nest npm install -D @nrwl/nest
``` ```
## Applications ```shell
yarn add -D @nrwl/nest
Generating new applications can be done with the following:
```bash
nx generate @nrwl/nest:application <nest-app>
``` ```
This creates the following app structure: ### Create Applications
```treeview You can add a new Nest application with the following command:
my-org/
├── apps/
└── nest-app/
├── jest.config.js
├── src/
│ ├── app/
│ │ ├── app.controller.ts
│ │ ├── app.controller.spec.ts
│ │ ├── app.module.ts
│ │ ├── app.service.ts
│ │ └── app.service.spec.ts
│ ├── assets/
│ ├── environments/
│ └── main.ts
├── tsconfig.app.json
├── tsconfig.json
├── tsconfig.spec.json
└── tslint.json
```
The `main.ts` content should look similar to this: ```shell
nx g @nrwl/nest:app my-nest-app
```typescript
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app/app.module';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
const globalPrefix = 'api';
app.setGlobalPrefix(globalPrefix);
const port = process.env.port || 3333;
await app.listen(port, () => {
console.log('Listening at http://localhost:' + port + '/' + globalPrefix);
});
}
bootstrap();
``` ```
#### Application Proxies #### Application Proxies
Generating Nest applications has an option to configure other projects in the workspace to proxy API requests. This can be done by passing the `--frontendProject` with the project name you wish to enable proxy support for. Generating Nest applications has an option to configure other projects in the workspace to proxy API requests. This can be done by passing the `--frontendProject` with the project name you wish to enable proxy support for.
```bash ```shell
nx generate @nrwl/nest:application <nest-app> --frontendProject my-angular-app nx g @nrwl/nest:app my-nest-app --frontendProject my-angular-app
``` ```
### Application commands ### Create Libraries
When a Nest application is added, the following architect commands are available for execution: You can add a new Nest library with the following command:
#### build ```shell
nx g @nrwl/nest:lib my-nest-lib
```bash
nx build <nest-app>
``` ```
The build command will compile the application using Webpack. It supports a production configuration by building with the following command: To make the library `buildable`, use the following command:
```bash ```shell
nx build <nest-app> --configuration=production nx g @nrwl/nest:lib my-nest-lib --buildable
``` ```
Additional configurations can be added in the project.json. Changing the `--configuration` flag with the new configuration name will run that config. To make the library `publishable`, use the following command:
#### serve ```shell
nx g @nrwl/nest:lib my-nest-lib --publishable --importPath=@my-workspace/my-nest-lib
```bash
nx serve <nest-app>
``` ```
The serve command runs the `build` target, and executes the application. > Read more about [building and publishing libraries here](/structure/buildable-and-publishable-libraries).
By default, the serve command will run in watch mode. This allows code to be changed, and the Nest application to be rebuilt automatically. ### Nest Generators
Nest applications also have the `inspect` flag set, so you can attach your debugger to the running instance.
##### Debugging
Debugging is set to use a random port that is available on the system. The port can be changed by setting the port option in the `serve` architect in the project.json. Or by running the serve command with `--port <number>`.
For additional information on how to debug Node applications, see the [Node.js debugging getting started guide](https://nestjs.org/en/docs/guides/debugging-getting-started/#inspector-clients).
##### Waiting for other builds
Setting the `waitUntilTargets` option with an array of projects (with the following format: `"project:architect"`) will execute those commands before serving the Nest application.
#### lint
The lint command will run linting within the scope of the Nest app.
```bash
nx lint <nest-app>
```
#### test
Test will execute Jest tests within the scope of the Nest app.
```bash
nx test <nest-app>
```
## Libraries
Nest libraries are a good way to separate features within your organization. To create a Nest library run the following command:
```bash
nx generate @nrwl/nest:library <nest-lib>
```
Nest libraries can also be generated with an included controller, service or making the module global with their respective flags.
```bash
nx generate @nrwl/nest:library <nest-lib> [--controller] [--service] [--global]
```
#### Buildable libraries
Libraries can also be enabled to be built separately from apps. To create a buildable library, add the `--buildable` flag to the generate command above.
```bash
nx generate @nrwl/nest:library <nest-lib> --buildable
```
### Library commands
When a Nest library is added, the following architect commands are available for execution:
#### lint
The lint command will run linting within the scope of the Nest library.
```bash
nx lint <nest-lib>
```
#### test
Test will execute Jest tests within the scope of the Nest library.
```bash
nx test <nest-lib>
```
> Note: By default, Nest libraries are generated with Jest's test environment set to `node`
#### build
The build command will only be available if the library was generated with the `--buildable` flag.
Buildable Nest libraries use TypeScript to compile the source. The tsconfig files that are generated with the library allow customization of the compiled output.
```bash
nx build <nest-lib>
```
## Nest Generators
The Nest plugin for Nx extends the generators provided by Nest. Any commands that can be used with the Nest CLI can also be used with the `nx` command. The `--sourceRoot` flag should be used for all Nest generators. The Nest plugin for Nx extends the generators provided by Nest. Any commands that can be used with the Nest CLI can also be used with the `nx` command. The `--sourceRoot` flag should be used for all Nest generators.
> The `--sourceRoot` command should point to the source directory of a Nest library or application within an Nx workspace. > The `--sourceRoot` command should point to the source directory of a Nest library or application within an Nx workspace.
## Using Nest
### Build
You can build an application with the following command:
```shell
nx build my-nest-app
```
This applies to `buildable` libraries as well
```shell
nx build my-nest-lib
```
#### Waiting for other builds
Setting the `waitUntilTargets` option with an array of projects (with the following format: `"project:architect"`) will execute those commands before serving the Nest application.
### Serve
You can serve an application with the following command:
```shell
nx serve my-nest-app
```
The `serve` command runs the `build` target, and executes the application.
By default, the serve command will run in `watch` mode. This allows code to be changed, and the Nest application to be rebuilt automatically.
#### Debugging
Nest applications also have the `inspect` flag set, so you can attach your debugger to the running instance.
Debugging is set to use a random port that is available on the system. The port can be changed by setting the port option in the `serve` architect in the workspace.json. Or by running the serve command with `--port <number>`.
For additional information on how to debug Node applications, see the [Node.js debugging getting started guide](https://nestjs.org/en/docs/guides/debugging-getting-started/#inspector-clients).
### Lint
You can lint an application with the following command:
```shell
nx lint my-nest-app
```
You can lint a library with the following command:
```shell
nx lint my-nest-lib
```
### Unit Test
You can run unit test for an application with the following command:
```shell
nx test my-nest-app
```
You can run unit test for a library with the following command:
```shell
nx test my-nest-lib
```
## More Documentation
- [Todo Tutorial](/node-tutorial/01-create-application)
- [Using Jest](/jest/overview)