Skip to content

Commit

Permalink
feat(scripts): documentation upgrade
Browse files Browse the repository at this point in the history
Follow the new package architecture.
The generation of the documentation has been improved, new helper
functions have been added to handle the new architecture.
  • Loading branch information
bcabanes authored and vsavkin committed May 14, 2019
1 parent 1ad5e91 commit 84deb16
Show file tree
Hide file tree
Showing 64 changed files with 1,397 additions and 667 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# application

Create an application
Create an Angular application

## Usage

Expand All @@ -25,14 +25,6 @@ Type: `string`

Test runner to use for end to end (e2e) tests

### framework

Default: `angular`

Type: `string`

The Framework for the application.

### inlineStyle

Alias(es): s
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# downgrade-module

Generates downgradeModule setup
Setup Downgrade Module

## Usage

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# karma-project [hidden]
# karma-project

Add Karma configuration to a project
Add karma testing to a project

## Usage

Expand Down
10 changes: 10 additions & 0 deletions docs/api-angular/schematics/karma.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# karma

Add karma configuration to a workspace

## Usage

```bash
ng generate karma ...

```
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# library

Create a library
Create an Angular library

## Usage

Expand All @@ -17,14 +17,6 @@ Type: `string`

A directory where the app is placed

### framework

Default: `none`

Type: `string`

The framework this library uses

### lazy

Default: `false`
Expand All @@ -33,14 +25,6 @@ Type: `boolean`

Add RouterModule.forChild when set to true, and a simple array of routes when set to false.

### module

Default: `true`

Type: `boolean`

[Deprecated]: Include an NgModule in the library.

### name

Type: `string`
Expand Down
36 changes: 36 additions & 0 deletions docs/api-angular/schematics/ng-add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# ng-add [hidden]

Add @nrwl/react to a project

## Usage

```bash
ng generate ng-add ...

```

## Options

### e2eTestRunner

Default: `cypress`

Type: `string`

Test runner to use for end to end (e2e) tests

### skipInstall

Default: `false`

Type: `boolean`

Skip installing after adding @nrwl/workspace

### unitTestRunner

Default: `jest`

Type: `string`

Test runner to use for unit tests
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ngrx

Add NgRx support to a module
Add an ngrx config to a project

## Usage

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# upgrade-module

Generates UpgradeModule setup
Add an upgrade module

## Usage

Expand Down
File renamed without changes.
30 changes: 30 additions & 0 deletions docs/api-cypress/schematics/cypress-project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# cypress-project

Add a Cypress E2E Project

## Usage

```bash
ng generate cypress-project ...

```

## Options

### directory

Type: `string`

A directory where the app is placed

### name

Type: `string`

Name of the E2E Project

### project

Type: `string`

The name of the frontend project to test.
10 changes: 10 additions & 0 deletions docs/api-cypress/schematics/ng-add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ng-add [hidden]

Add Cypress configuration to the workspace

## Usage

```bash
ng generate ng-add ...

```
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# node-application
# application

Create a NodeJS Application
Create an express application

## Usage

```bash
ng generate node-application ...
ng generate application ...

```

Expand All @@ -17,14 +17,6 @@ Type: `string`

The directory of the new application.

### framework

Default: `nestjs`

Type: `string`

Node Framework to use for application.

### frontendProject

Type: `string`
Expand Down
10 changes: 10 additions & 0 deletions docs/api-express/schematics/ng-add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ng-add [hidden]

Add @nrwl/express to a project

## Usage

```bash
ng generate ng-add ...

```
60 changes: 60 additions & 0 deletions docs/api-nest/schematics/application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# application

Create a nest application

## Usage

```bash
ng generate application ...

```

## Options

### directory

Type: `string`

The directory of the new application.

### frontendProject

Type: `string`

Frontend project that needs to access this application. This sets up proxy configuration.

### name

Type: `string`

The name of the application.

### skipFormat

Default: `false`

Type: `boolean`

Skip formatting files

### skipPackageJson

Default: `false`

Type: `boolean`

Do not add dependencies to package.json.

### tags

Type: `string`

Add tags to the application (used for linting)

### unitTestRunner

Default: `jest`

Type: `string`

Test runner to use for unit tests
10 changes: 10 additions & 0 deletions docs/api-nest/schematics/ng-add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ng-add [hidden]

Add @nrwl/nest to a project

## Usage

```bash
ng generate ng-add ...

```
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# node-build
# build

Build a Node application

## Properties

### assets

Type: `array`

List of static application assets.

### externalDependencies

Default: `all`
Expand All @@ -20,6 +26,24 @@ Type: `boolean`

Extract all licenses in a separate file, in the case of production builds only.

### fileReplacements

Type: `array` of `object`

Replace files with other files in the build.

#### replace

Type: `string`

undefined

#### with

Type: `string`

undefined

### main

Type: `string`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# node-execute
# execute

Execute a Node application

Expand Down
Loading

0 comments on commit 84deb16

Please sign in to comment.