Skip to content

Commit c21ec68

Browse files
committed
docs: add workspace docs
1 parent e65a885 commit c21ec68

File tree

4 files changed

+46
-110
lines changed

4 files changed

+46
-110
lines changed

docs/documentation/angular-cli.md

Lines changed: 0 additions & 102 deletions
This file was deleted.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- Links in /docs/documentation should NOT have `.md` at the end, because they end up in our wiki at release. -->
2+
3+
# Angular CLI workspace file (angular.json) schema
4+
5+
## Properties
6+
7+
- **version** (`integer`): File format version.
8+
9+
- **newProjectRoot** (`string`): Path where new projects will be created.
10+
11+
- **defaultProject** (`string`): Default project name used in commands.
12+
13+
- **cli**: Workspace configuration options for Angular CLI.
14+
- *defaultCollection* (`string`): The default schematics collection to use.
15+
- *packageManager* (`string`): Specify which package manager tool to use.
16+
- *warnings* (`object`): Warning configuration.
17+
- *versionMismatch* (`boolean`): Show a warning when the global version is newer than the local one.
18+
- *typescriptMismatch* (`boolean`): The name of the project.
19+
20+
- **schematics** (`object`): Workspace configuration options for Schematics.
21+
- *schematic-package:schematic-name* (`string`): Object containing options for this schematic.
22+
23+
- **projects**: Configuration options for each project in the workspace.
24+
- *root* (`string`): Root of the project files.
25+
- *sourceRoot* (`string`): The root of the source files, assets and index.html file structure..
26+
- *projectType* (`string`): the type of this project, `application` or `library`.
27+
- *prefix* (`string`): The prefix to apply to generated selectors.
28+
- *schematics* (`object`): Project configuration options for Schematics. Has the same format as top level Schematics configuration).
29+
- *architect* (`string`): Project configuration for Architect targets.
30+
- *targetName* (`string`): Name of this target.
31+
- *builder* (`string`): Builder for this target, in the format `package-name:builder-name`.
32+
- *options* (`string`): Options for this builder.
33+
- *configurations* (`object`): A map of alternative target options.
34+
- *configurationName* (`object`): Partial options override for this builder.

docs/documentation/home.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
5656
* [ng xi18n](xi18n)
5757
* [ng update](update)
5858

59-
## Angular CLI Config Schema
60-
* [Config Schema](angular-cli)
59+
## Angular CLI Workspace Schema
60+
* [Angular CLI workspace file (angular.json) schema](angular-workspace)
6161

6262
### Additional Information
6363
There are several [stories](stories) which will walk you through setting up

packages/@angular/cli/lib/config/schema.json

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,12 @@
1717
"$ref": "#/definitions/schematicOptions"
1818
},
1919
"newProjectRoot": {
20-
"type": "string"
20+
"type": "string",
21+
"description": "Path where new projects will be created."
2122
},
2223
"defaultProject": {
2324
"type": "string",
24-
"description": "Default project name used in commands"
25+
"description": "Default project name used in commands."
2526
},
2627
"projects": {
2728
"type": "object",
@@ -59,7 +60,7 @@
5960
"type": "boolean"
6061
},
6162
"typescriptMismatch": {
62-
"description": "Show a warning when the TypeScript version is incompatible",
63+
"description": "Show a warning when the TypeScript version is incompatible.",
6364
"type": "boolean"
6465
}
6566
}
@@ -297,13 +298,16 @@
297298
},
298299
"prefix": {
299300
"type": "string",
300-
"format": "html-selector"
301+
"format": "html-selector",
302+
"description": "The prefix to apply to generated selectors."
301303
},
302304
"root": {
303-
"type": "string"
305+
"type": "string",
306+
"description": "Root of the project files."
304307
},
305308
"sourceRoot": {
306-
"type": "string"
309+
"type": "string",
310+
"description": "The root of the source files, assets and index.html file structure."
307311
},
308312
"projectType": {
309313
"type": "string",

0 commit comments

Comments
 (0)