Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 5904c3e

Browse files
Cammisulivsavkin
Cammisuli
authored and
vsavkin
committed
feat(docs): add node document generation
(cherry picked from commit 0304516)
1 parent 0759213 commit 5904c3e

File tree

103 files changed

+10029
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+10029
-3
lines changed

‎docs/map.json‎

Lines changed: 864 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/node/api-angular/builders/package.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# package
2+
3+
Build an Angular library
4+
5+
Builder properties can be configured in workspace.json when defining the builder, or when invoking it.
6+
Read more about how to use builders and the CLI here: https://nx.dev/node/guides/cli.
7+
8+
## Properties
9+
10+
### project
11+
12+
Type: `string`
13+
14+
The file path for the ng-packagr configuration file, relative to the current workspace.
15+
16+
### tsConfig
17+
18+
Type: `string`
19+
20+
The full path for the TypeScript configuration file, relative to the current workspace.
21+
22+
### updateBuildableProjectDepsInPackageJson
23+
24+
Default: `true`
25+
26+
Type: `boolean`
27+
28+
Update buildable project dependencies in package.json
29+
30+
### watch
31+
32+
Default: `false`
33+
34+
Type: `boolean`
35+
36+
Run build when files change.

‎docs/node/api-angular/schematics/application.md‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
# application
2+
3+
Create an Angular application
4+
5+
## Usage
6+
7+
```bash
8+
nx generate application ...
9+
```
10+
11+
```bash
12+
nx g app ... # same
13+
```
14+
15+
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
16+
17+
You can specify the collection explicitly as follows:
18+
19+
```bash
20+
nx g @nrwl/angular:application ...
21+
```
22+
23+
Show what will be generated without writing to disk:
24+
25+
```bash
26+
nx g application ... --dry-run
27+
```
28+
29+
## Options
30+
31+
### backendProject
32+
33+
Type: `string`
34+
35+
Backend project that provides data to this application. This sets up proxy.config.json.
36+
37+
### directory
38+
39+
Type: `string`
40+
41+
The directory of the new application.
42+
43+
### e2eTestRunner
44+
45+
Default: `cypress`
46+
47+
Type: `string`
48+
49+
Possible values: `protractor`, `cypress`, `none`
50+
51+
Test runner to use for end to end (e2e) tests
52+
53+
### enableIvy
54+
55+
Default: `true`
56+
57+
Type: `boolean`
58+
59+
Create a new app that uses the Ivy rendering engine.
60+
61+
### inlineStyle
62+
63+
Alias(es): s
64+
65+
Default: `false`
66+
67+
Type: `boolean`
68+
69+
Specifies if the style will be in the ts file.
70+
71+
### inlineTemplate
72+
73+
Alias(es): t
74+
75+
Default: `false`
76+
77+
Type: `boolean`
78+
79+
Specifies if the template will be in the ts file.
80+
81+
### linter
82+
83+
Default: `tslint`
84+
85+
Type: `string`
86+
87+
Possible values: `tslint`, `eslint`
88+
89+
The tool to use for running lint checks.
90+
91+
### name
92+
93+
Type: `string`
94+
95+
The name of the application.
96+
97+
### prefix
98+
99+
Alias(es): p
100+
101+
Type: `string`
102+
103+
The prefix to apply to generated selectors.
104+
105+
### routing
106+
107+
Default: `false`
108+
109+
Type: `boolean`
110+
111+
Generates a routing module.
112+
113+
### skipFormat
114+
115+
Default: `false`
116+
117+
Type: `boolean`
118+
119+
Skip formatting files
120+
121+
### skipPackageJson
122+
123+
Default: `false`
124+
125+
Type: `boolean`
126+
127+
Do not add dependencies to package.json.
128+
129+
### skipTests
130+
131+
Alias(es): S
132+
133+
Default: `false`
134+
135+
Type: `boolean`
136+
137+
Skip creating spec files.
138+
139+
### strict
140+
141+
Default: `false`
142+
143+
Type: `boolean`
144+
145+
Creates an application with stricter type checking and build optimization options.
146+
147+
### style
148+
149+
Default: `css`
150+
151+
Type: `string`
152+
153+
Possible values: `css`, `scss`, `styl`, `less`
154+
155+
The file extension to be used for style files.
156+
157+
### tags
158+
159+
Type: `string`
160+
161+
Add tags to the application (used for linting)
162+
163+
### unitTestRunner
164+
165+
Default: `jest`
166+
167+
Type: `string`
168+
169+
Possible values: `karma`, `jest`, `none`
170+
171+
Test runner to use for unit tests
172+
173+
### viewEncapsulation
174+
175+
Type: `string`
176+
177+
Possible values: `Emulated`, `Native`, `None`
178+
179+
Specifies the view encapsulation strategy.

‎docs/node/api-angular/schematics/downgrade-module.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# downgrade-module
2+
3+
Setup Downgrade Module
4+
5+
## Usage
6+
7+
```bash
8+
nx generate downgrade-module ...
9+
```
10+
11+
By default, Nx will search for `downgrade-module` in the default collection provisioned in `workspace.json`.
12+
13+
You can specify the collection explicitly as follows:
14+
15+
```bash
16+
nx g @nrwl/angular:downgrade-module ...
17+
```
18+
19+
Show what will be generated without writing to disk:
20+
21+
```bash
22+
nx g downgrade-module ... --dry-run
23+
```
24+
25+
## Options
26+
27+
### angularJsImport
28+
29+
Type: `string`
30+
31+
Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app).
32+
33+
### name
34+
35+
Type: `string`
36+
37+
The name of the main AngularJS module.
38+
39+
### project
40+
41+
Type: `string`
42+
43+
The name of the project
44+
45+
### skipFormat
46+
47+
Default: `false`
48+
49+
Type: `boolean`
50+
51+
Skip formatting files
52+
53+
### skipPackageJson
54+
55+
Default: `false`
56+
57+
Type: `boolean`
58+
59+
Do not add @angular/upgrade to package.json (e.g., --skipPackageJson)

‎docs/node/api-angular/schematics/karma-project.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# karma-project
2+
3+
Add karma testing to a project
4+
5+
## Usage
6+
7+
```bash
8+
nx generate karma-project ...
9+
```
10+
11+
By default, Nx will search for `karma-project` in the default collection provisioned in `workspace.json`.
12+
13+
You can specify the collection explicitly as follows:
14+
15+
```bash
16+
nx g @nrwl/angular:karma-project ...
17+
```
18+
19+
Show what will be generated without writing to disk:
20+
21+
```bash
22+
nx g karma-project ... --dry-run
23+
```
24+
25+
## Options
26+
27+
### project
28+
29+
Type: `string`
30+
31+
The name of the project.

‎docs/node/api-angular/schematics/karma.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# karma
2+
3+
Add karma configuration to a workspace
4+
5+
## Usage
6+
7+
```bash
8+
nx generate karma ...
9+
```
10+
11+
By default, Nx will search for `karma` in the default collection provisioned in `workspace.json`.
12+
13+
You can specify the collection explicitly as follows:
14+
15+
```bash
16+
nx g @nrwl/angular:karma ...
17+
```
18+
19+
Show what will be generated without writing to disk:
20+
21+
```bash
22+
nx g karma ... --dry-run
23+
```

0 commit comments

Comments
 (0)