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

docs(nx): small changes (#1066)

Browse Source 
* docs(node): update documentation
* docs(nx): small changes
This commit is contained in:
Jason Jean 2019-02-11 10:40:50 -05:00 committed by Benjamin Cabanes
parent 2ce53ea2f8
commit 24dadb9b29
5 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,5 +1,7 @@
_[Please make sure you have read the submission guidelines before posting an PR](https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-pr)_
## Description
## Current Behavior (This is the behavior we have today, before the PR is merged)
## Expected Behavior (This is the new behavior we can expect after the PR is merged)
## Issue

4
CONTRIBUTING.md
View File

@ -42,7 +42,7 @@ To make sure you changes do not break any unit tests, run the following:
yarn e2e
```
Running e2e tests can take some time, so if it often useful to run a single test. You can do it as follows:
Running e2e tests can take some time, so it is often useful to run a single test. You can do it as follows:
```bash
yarn e2e affected
@ -53,7 +53,7 @@ yarn e2e affected
To build Nx on Windows, you need to use WSL.
- Run `yarn install` in WSL. Yarn will compile several dependencies. If you don't run `install` in WSL, they will be compiled for Windows.
- Run `yarn test:scheamtics` and other commands in WSL.
- Run `yarn test:schematics` and other commands in WSL.
## Submission Guidelines

2
README.md
View File

@ -109,7 +109,7 @@ yarn global add @nrwl/schematics
To create an Nx workspace, run:
```bash
ng new myworkspace --collection=@nrw/schematics
ng new myworkspace --collection=@nrwl/schematics
```
The `ng new` command uses globally-installed packages. Anything installed globally can be in a messy state. If you have any problems running the command above, you can also run:

3
docs/builders/node-execute.md
View File

@ -5,8 +5,9 @@ Execute a Node application
### Properties
| Name | Description | Type | Default value |
| ------------- | ------------------------------------------ | ------ | ------------- |
| ------------------ | -------------------------------------------------- | ------ | ------------- |
| `buildTarget` | The target to run to build you the app | string | `undefined` |
| `waitUntilTargets` | The targets to run to before starting the node app | array | `undefined` |
| `port` | The port to inspect the process on | number | `7777` |
| `inspect` | Ensures the app is starting with debugging | string | `inspect` |
| `args` | Extra args when starting the app | array | `undefined` |

3
docs/schematics/node-application.md
View File

@ -12,7 +12,7 @@ ng generate node-application ...
### Options
| Name | Alias | Description | Type | Default value |
| ----------------- | ----- | ---------------------------------------------- | ------- | ------------- |
| ----------------- | ----- | ----------------------------------------------------------------------------------------- | ------- | ------------- |
| `name` | | The name of the application. | string | `undefined` |
| `directory` | | The directory of the new application. | string | `undefined` |
| `framework` | | Node Framework to use for application. | string | `express` |
@ -20,3 +20,4 @@ ng generate node-application ...
| `skipPackageJson` | | Do not add dependencies to package.json. | boolean | `false` |
| `unitTestRunner` | | Test runner to use for unit tests | string | `jest` |
| `tags` | | Add tags to the application (used for linting) | string | `undefined` |
| `frontendProject` | | Frontend project that needs to access this application. This sets up proxy configuration. | string | `undefined` |