docs(module-federation): clarify usage of skipRemotes (#21887)

This commit is contained in:
Colum Ferry 2024-02-20 19:18:58 +00:00 committed by GitHub
parent 86acef668c
commit fc0c99dd96
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 4 additions and 4 deletions

View File

@ -112,7 +112,7 @@
"skipRemotes": {
"type": "array",
"items": { "type": "string" },
"description": "List of remote applications to not automatically serve, either statically or in development mode."
"description": "List of remote applications to not automatically serve, either statically or in development mode. This will not remove the remotes from the `module-federation.config` file, and therefore the application may still try to fetch these remotes.\nThis option is useful for when the `host` application is using a `remote` that does not live in the same workspace as the `host`."
},
"pathToManifestFile": {
"type": "string",

View File

@ -18,7 +18,7 @@
"skipRemotes": {
"type": "array",
"items": { "type": "string" },
"description": "List of remote applications to not automatically serve, either statically or in development mode.",
"description": "List of remote applications to not automatically serve, either statically or in development mode. This will not remove the remotes from the `module-federation.config` file, and therefore the application may still try to fetch these remotes.\nThis option is useful for when the `host` application is using a `remote` that does not live in the same workspace as the `host`.",
"x-priority": "important"
},
"buildTarget": {

View File

@ -122,7 +122,7 @@
"items": {
"type": "string"
},
"description": "List of remote applications to not automatically serve, either statically or in development mode."
"description": "List of remote applications to not automatically serve, either statically or in development mode. This will not remove the remotes from the `module-federation.config` file, and therefore the application may still try to fetch these remotes.\nThis option is useful for when the `host` application is using a `remote` that does not live in the same workspace as the `host`."
},
"pathToManifestFile": {
"type": "string",

View File

@ -19,7 +19,7 @@
"items": {
"type": "string"
},
"description": "List of remote applications to not automatically serve, either statically or in development mode.",
"description": "List of remote applications to not automatically serve, either statically or in development mode. This will not remove the remotes from the `module-federation.config` file, and therefore the application may still try to fetch these remotes.\nThis option is useful for when the `host` application is using a `remote` that does not live in the same workspace as the `host`.",
"x-priority": "important"
},
"buildTarget": {