1
0
mirror of https://github.com/angular/angular-cli.git synced 2025-05-25 16:57:51 +08:00

docs: remove long-description from schematics

These long descriptions were and are only handled at the Angular CLI level which makes these redundant.
This commit is contained in:
Alan Agius 2022-07-07 13:34:18 +00:00 committed by Alan Agius
parent 624e0b0ec6
commit 68358f0c37
7 changed files with 0 additions and 60 deletions

@ -142,11 +142,8 @@ pkg_npm(
"//packages/angular_devkit/core:package.json",
],
deps = [
"library/library-long.md",
":README.md",
":angular",
":app-shell/app-shell-long.md",
":e2e/e2e-long.md",
":license",
":migrations/migration-collection.json",
":utility/latest-versions/package.json",

@ -1,47 +0,0 @@
An app shell lets Universal render a portion of your application via a route at build time.
This gives users a meaningful first paint of your application that appears quickly
because the browser can simply render the HTML without the need to initialize any JavaScript.
Use this command with a routing app that is accompanied by a Universal server-side app.
To create an app shell, use the following command.
<code-example format="." language="bash">
ng generate app-shell my-app
</code-example>
- `my-app` is the name of your client application
- `server-app` is the name of the Universal (server) application
The command adds two new architect build targets to your `angular.json` configuration file (along with a few other changes).
<code-example format="." language="none" linenums="false">
"server": {
"builder": "@angular-devkit/build-angular:server",
"options": {
"outputPath": "dist/my-app-server",
"main": "src/main.server.ts",
"tsConfig": "src/tsconfig.server.json"
}
},
"app-shell": {
"builder": "@angular-devkit/build-angular:app-shell",
"options": {
"browserTarget": "my-app:build",
"serverTarget": "my-app:server",
"route": "shell"
}
}
</code-example>
To verify the that the app has been built with the default shell content:
1. Run the app-shell target.
<code-example format="." language="bash">
ng run my-app:app-shell
</code-example>
1. Open `dist/app-shell/index.html` in your browser.
The default text "app-shell works!" verifies that the app-shell route was rendered as part of the output.

@ -5,7 +5,6 @@
"type": "object",
"description": "Generates an application shell for running a server-side version of an app.",
"additionalProperties": false,
"long-description": "./app-shell-long.md",
"properties": {
"project": {
"type": "string",

@ -1,2 +0,0 @@
The e2e tests are created in a separate application in the `projects` folder of the workspace,
next to the project being tested.

@ -5,7 +5,6 @@
"type": "object",
"additionalProperties": false,
"description": "Generates a new, generic end-to-end test definition for the given or default project.",
"long-description": "e2e-long.md",
"properties": {
"rootSelector": {
"description": "The HTML selector for the root component of the test app.",

@ -1,5 +0,0 @@
A library is a type of project that does not run independently.
The library skeleton created by this command is placed by default in the `/projects` folder, and has `type` of "library".
You can build a new library using the `ng build` command, run unit tests for it using the `ng test` command,
and lint it using the `ng lint` command.

@ -4,7 +4,6 @@
"title": "Library Options Schema",
"type": "object",
"description": "Creates a new, generic library project in the current workspace.",
"long-description": "./library-long.md",
"additionalProperties": false,
"properties": {
"name": {