Skip to content
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

docs(@schematics/angular): add README and update description in schema #20527

Merged
merged 1 commit into from Apr 19, 2021
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 33 additions & 0 deletions packages/schematics/angular/README.md
@@ -0,0 +1,33 @@
# @schematics/angular

This package contains a collection of [schematics](/packages/angular_devkit/schematics/README.md)
for generating an Angular application.

## Schematics

Name | Description
-----|-------------
app-shell | Generates an app shell for running a server-side version of an app
application | Generates a new basic app definition in the "projects" subfolder of the workspace
class | Creates a new, generic class definition in the given or default project
component | Creates a new, generic component definition in the given or default project
directive | Creates a new, generic directive definition in the given or default project
e2e | Generates a new, generic end-to-end test definition for the given or default project
enum | Generates a new, generic enum definition for the given or default project
guard | Generates a new, generic route guard definition in the given or default project
interceptor | Creates a new, generic interceptor definition in the given or default project
interface | Creates a new, generic interface definition in the given or default project
library | Creates a new, generic library project in the current workspace
module | Creates a new, generic NgModule definition in the given or default project
ng-new | Creates a new project by combining the workspace and application schematics
pipe | Creates a new, generic pipe definition in the given or default project
resolver | Creates a new, generic resolver definition in the given or default project
service | Creates a new, generic service definition in the given or default project
service-worker | Pass this schematic to the "run" command to create a service worker
universal | Pass this schematic to the "run" command to set up server-side rendering for an app
web-worker | Creates a new, generic web worker definition in the given or default project
workspace | Initializes an empty workspace and adds the necessary dependencies required by an Angular application

## Disclaimer

While the schematics when executed via the Angular CLI and their associated options are considered stable, the programmatic APIs are not considered officially supported and are not subject to the breaking change guarantees of SemVer.
2 changes: 1 addition & 1 deletion packages/schematics/angular/class/schema.json
Expand Up @@ -3,7 +3,7 @@
"$id": "SchematicsAngularClass",
"title": "Angular Class Options Schema",
"type": "object",
"description": "Creates a new generic class definition in the given or default project.",
"description": "Creates a new, generic class definition in the given or default project.",
kyliau marked this conversation as resolved.
Show resolved Hide resolved
"additionalProperties": false,
"properties": {
"name": {
Expand Down
2 changes: 1 addition & 1 deletion packages/schematics/angular/component/schema.json
Expand Up @@ -3,7 +3,7 @@
"$id": "SchematicsAngularComponent",
"title": "Angular Component Options Schema",
"type": "object",
"description": "Creates a new generic component definition in the given or default project.",
"description": "Creates a new, generic component definition in the given or default project.",
"additionalProperties": false,
"properties": {
"path": {
Expand Down
2 changes: 1 addition & 1 deletion packages/schematics/angular/directive/schema.json
Expand Up @@ -3,7 +3,7 @@
"$id": "SchematicsAngularDirective",
"title": "Angular Directive Options Schema",
"type": "object",
"description": "Creates a new generic directive definition in the given or default project.",
"description": "Creates a new, generic directive definition in the given or default project.",
"additionalProperties": false,
"properties": {
"name": {
Expand Down
2 changes: 1 addition & 1 deletion packages/schematics/angular/interface/schema.json
Expand Up @@ -4,7 +4,7 @@
"title": "Angular Interface Options Schema",
"type": "object",
"additionalProperties": false,
"description": "Creates a new generic interface definition in the given or default project.",
"description": "Creates a new, generic interface definition in the given or default project.",
"properties": {
"name": {
"type": "string",
Expand Down
2 changes: 1 addition & 1 deletion packages/schematics/angular/library/schema.json
Expand Up @@ -3,7 +3,7 @@
"$id": "SchematicsLibrary",
"title": "Library Options Schema",
"type": "object",
"description": "Creates a new generic library project in the current workspace.",
"description": "Creates a new, generic library project in the current workspace.",
"long-description": "./library-long.md",
"additionalProperties": false,
"properties": {
Expand Down
2 changes: 1 addition & 1 deletion packages/schematics/angular/module/schema.json
Expand Up @@ -4,7 +4,7 @@
"title": "Angular Module Options Schema",
"type": "object",
"additionalProperties": false,
"description": "Creates a new generic NgModule definition in the given or default project.",
"description": "Creates a new, generic NgModule definition in the given or default project.",
"properties": {
"name": {
"type": "string",
Expand Down
1 change: 1 addition & 0 deletions packages/schematics/angular/ng-new/schema.json
Expand Up @@ -3,6 +3,7 @@
"$id": "SchematicsAngularNgNew",
"title": "Angular Ng New Options Schema",
"type": "object",
"description": "Creates a new project by combining the workspace and application schematics.",
"additionalProperties": false,
"properties": {
"directory": {
Expand Down
1 change: 1 addition & 0 deletions packages/schematics/angular/package.json
Expand Up @@ -2,6 +2,7 @@
"name": "@schematics/angular",
"version": "0.0.0",
"description": "Schematics specific to Angular",
"homepage": "https://github.com/angular/angular-cli",
kyliau marked this conversation as resolved.
Show resolved Hide resolved
"keywords": [
"blueprints",
"code generation",
Expand Down
2 changes: 1 addition & 1 deletion packages/schematics/angular/pipe/schema.json
Expand Up @@ -4,7 +4,7 @@
"title": "Angular Pipe Options Schema",
"type": "object",
"additionalProperties": false,
"description": "Creates a new generic pipe definition in the given or default project.",
"description": "Creates a new, generic pipe definition in the given or default project.",
"properties": {
"name": {
"type": "string",
Expand Down
2 changes: 1 addition & 1 deletion packages/schematics/angular/web-worker/schema.json
Expand Up @@ -4,7 +4,7 @@
"title": "Angular Web Worker Options Schema",
"type": "object",
"additionalProperties": false,
"description": "Creates a new generic web worker definition in the given or default project.",
"description": "Creates a new, generic web worker definition in the given or default project.",
"properties": {
"path": {
"type": "string",
Expand Down
1 change: 1 addition & 0 deletions packages/schematics/angular/workspace/schema.json
Expand Up @@ -2,6 +2,7 @@
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "SchematicsAngularWorkspace",
"title": "Angular Workspace Options Schema",
"description": "Initializes an empty workspace and adds the necessary dependencies required by an Angular application.",
"type": "object",
"additionalProperties": false,
"properties": {
Expand Down