docs(angular): remove leftovers references to the deleted file-server executor (#16010)

This commit is contained in:
Leosvel Pérez Espinosa 2023-04-03 09:27:53 +01:00 committed by GitHub
parent 059447b2fb
commit 1d955d3e18
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 0 additions and 150 deletions

View File

@ -1,85 +0,0 @@
{
"name": "file-server",
"implementation": "/packages/angular/src/executors/file-server/file-server.impl.ts",
"schema": {
"version": 2,
"outputCapture": "direct-nodejs",
"title": "File Server",
"description": "Serves a static web application from a folder.",
"type": "object",
"cli": "nx",
"properties": {
"buildTarget": {
"type": "string",
"description": "Target which builds the application."
},
"parallel": {
"type": "boolean",
"description": "Build the target in parallel.",
"default": true
},
"maxParallel": {
"type": "number",
"description": "Max number of parallel jobs."
},
"port": {
"type": "number",
"description": "Port to listen on.",
"default": 4200
},
"host": {
"type": "string",
"description": "Host to listen on.",
"default": "localhost"
},
"ssl": {
"type": "boolean",
"description": "Serve using `HTTPS`.",
"default": false
},
"sslKey": {
"type": "string",
"description": "SSL key to use for serving `HTTPS`."
},
"sslCert": {
"type": "string",
"description": "SSL certificate to use for serving `HTTPS`."
},
"proxyUrl": {
"type": "string",
"description": "URL to proxy unhandled requests to."
},
"proxyOptions": {
"type": "object",
"description": "Options for the proxy used by `http-server`.",
"default": {},
"properties": { "secure": { "type": "boolean", "default": false } },
"additionalProperties": true
},
"watch": {
"type": "boolean",
"description": "Watch for file changes.",
"default": false
},
"spa": {
"type": "boolean",
"description": "Redirect 404 errors to index.html (useful for SPA's).",
"default": false
},
"cors": {
"type": "boolean",
"description": "Enable CORS",
"default": true
}
},
"additionalProperties": false,
"required": ["buildTarget"],
"examplesFile": "## Examples\n\n{% tabs %}\n\n{% tab label=\"Serve static files with http-server\" %}\n\nSet up `http-server` to host static files on a local webserver.\n\n```json\n{\n \"static-serve\": {\n \"executor\": \"@nrwl/angular:file-server\",\n \"options\": {\n \"buildTarget\": \"app:build\",\n \"port\": 4201\n }\n }\n}\n```\n\n{% /tab %}\n\n{% tab label=\"Watch for changes\" %}\n\nTo allow watching for changes, simply add the watch property.\n\n```json\n{\n \"static-serve\": {\n \"executor\": \"@nrwl/angular:file-server\",\n \"options\": {\n \"buildTarget\": \"app:build\",\n \"port\": 4201,\n \"watch\": true\n }\n }\n}\n```\n\n{% /tab %}\n\n{% /tabs %}\n",
"presets": []
},
"description": "Serves a static web application from a folder.",
"aliases": [],
"hidden": false,
"path": "/packages/angular/src/executors/file-server/schema.json",
"type": "executor"
}

View File

@ -16,7 +16,6 @@
"delegate-build",
"ng-packagr-lite",
"package",
"file-server",
"webpack-browser",
"webpack-dev-server",
"webpack-server",

View File

@ -7596,10 +7596,6 @@
"file": "packages/angular/docs/downgrade-module-examples.md",
"hash": "9bf81e20b174c74466770384d9f420578aefb3fa"
},
{
"file": "packages/angular/docs/file-server-examples.md",
"hash": "7970193bd9b6d0e74c36ac0e301c87e0d64a6680"
},
{
"file": "packages/angular/docs/karma-project-examples.md",
"hash": "e68f2b2c13e158bb2a31508eb6a503695cb9abd5"
@ -7907,24 +7903,6 @@
"file": "packages/angular/src/executors/delegate-build/schema.json",
"hash": "d60ccce50361ab93c1f275dc0b49b932ad1d8b79"
},
{
"file": "packages/angular/src/executors/file-server/compat.ts",
"hash": "094efc423152340e16481ea0d7c25caa077a714f",
"deps": ["devkit"]
},
{
"file": "packages/angular/src/executors/file-server/file-server.impl.ts",
"hash": "0a96dae29f5508ac0d1c045b1427e29dfddfe39d",
"deps": ["devkit", "npm:chokidar", "npm:ignore", "nx"]
},
{
"file": "packages/angular/src/executors/file-server/schema.d.ts",
"hash": "119d207103daa389ce5b30ef23a45b2bdf5a3e19"
},
{
"file": "packages/angular/src/executors/file-server/schema.json",
"hash": "5773152a7176513833c148843bd881aa5eb56f3b"
},
{
"file": "packages/angular/src/executors/ng-packagr-lite/compat.ts",
"hash": "e88113f3945178058b91809f00ad20bc64536efd",

View File

@ -1,42 +0,0 @@
## Examples
{% tabs %}
{% tab label="Serve static files with http-server" %}
Set up `http-server` to host static files on a local webserver.
```json
{
"static-serve": {
"executor": "@nrwl/angular:file-server",
"options": {
"buildTarget": "app:build",
"port": 4201
}
}
}
```
{% /tab %}
{% tab label="Watch for changes" %}
To allow watching for changes, simply add the watch property.
```json
{
"static-serve": {
"executor": "@nrwl/angular:file-server",
"options": {
"buildTarget": "app:build",
"port": 4201,
"watch": true
}
}
}
```
{% /tab %}
{% /tabs %}