Skip to content

docs: add workspace docs #10562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 0 additions & 102 deletions docs/documentation/angular-cli.md

This file was deleted.

34 changes: 34 additions & 0 deletions docs/documentation/angular-workspace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!-- Links in /docs/documentation should NOT have `.md` at the end, because they end up in our wiki at release. -->

# Angular CLI workspace file (angular.json) schema

## Properties

- **version** (`integer`): File format version. This is currently `"1"`.

- **newProjectRoot** (`string`): Path where new projects will be created.

- **defaultProject** (`string`): Default project name used in commands.

- **cli**: Workspace configuration options for Angular CLI.
- *defaultCollection* (`string`): The default schematics collection to use.
- *packageManager* (`string`): Specify which package manager tool to use.
- *warnings* (`object`): Warning configuration.
- *versionMismatch* (`boolean`): Show a warning when the global version is newer than the local one.
- *typescriptMismatch* (`boolean`): The name of the project.

- **schematics** (`object`): Workspace configuration options for Schematics.
- *schematic-package:schematic-name* (`string`): Object containing options for this schematic.

- **projects**: Configuration options for each project in the workspace.
- *root* (`string`): Root of the project files.
- *sourceRoot* (`string`): The root of the source files, assets and index.html file structure..
- *projectType* (`string`): the type of this project, `application` or `library`.
- *prefix* (`string`): The prefix to apply to generated selectors.
- *schematics* (`object`): Project configuration options for Schematics. Has the same format as top level Schematics configuration).
- *architect* (`string`): Project configuration for Architect targets.
- *targetName* (`string`): Name of this target.
- *builder* (`string`): Builder for this target, in the format `package-name:builder-name`.
- *options* (`string`): Options for this builder.
- *configurations* (`object`): A map of alternative target options.
- *configurationName* (`object`): Partial options override for this builder.
4 changes: 2 additions & 2 deletions docs/documentation/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
* [ng xi18n](xi18n)
* [ng update](update)

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

### Additional Information
There are several [stories](stories) which will walk you through setting up
Expand Down
16 changes: 10 additions & 6 deletions packages/@angular/cli/lib/config/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,12 @@
"$ref": "#/definitions/schematicOptions"
},
"newProjectRoot": {
"type": "string"
"type": "string",
"description": "Path where new projects will be created."
},
"defaultProject": {
"type": "string",
"description": "Default project name used in commands"
"description": "Default project name used in commands."
},
"projects": {
"type": "object",
Expand Down Expand Up @@ -59,7 +60,7 @@
"type": "boolean"
},
"typescriptMismatch": {
"description": "Show a warning when the TypeScript version is incompatible",
"description": "Show a warning when the TypeScript version is incompatible.",
"type": "boolean"
}
}
Expand Down Expand Up @@ -297,13 +298,16 @@
},
"prefix": {
"type": "string",
"format": "html-selector"
"format": "html-selector",
"description": "The prefix to apply to generated selectors."
},
"root": {
"type": "string"
"type": "string",
"description": "Root of the project files."
},
"sourceRoot": {
"type": "string"
"type": "string",
"description": "The root of the source files, assets and index.html file structure."
},
"projectType": {
"type": "string",
Expand Down