nx/docs/generated/packages/react/executors/module-federation-ssr-dev-server.json
Colum Ferry aefafc55ba
feat(module-federation): alias host and remote generators to consumer and producer (#29190)
## Current Behavior
Our Module Federation support across Angular and React contains Host and
Remote generators.
The module-federation.io docs have started to shift towards Consumer and
Producer terminology for better translation of meanings across
languages.


## Expected Behavior
To stay consistent with official terminology, add aliases for the host
and remote generators to allow for the new terminology. i.e. host ->
consumer, remote -> producer.

Therefore the following are all valid

```shell
nx g host shell --remotes=remote1
nx g host shell --producers=producer1
nx g consumer shell --remotes=remote1
nx g consumer shell --producers=remote1

nx g remote remote1 --host=shell
nx g remote remote1 --consumer=shell
nx g producer producer1 --host=shell
nx g producer producer1 --consumer=shell
```
2024-12-04 16:45:27 +00:00

86 lines
3.0 KiB
JSON

{
"name": "module-federation-ssr-dev-server",
"implementation": "/packages/react/src/executors/module-federation-ssr-dev-server/module-federation-ssr-dev-server.impl.ts",
"schema": {
"version": 2,
"outputCapture": "direct-nodejs",
"title": "Module Federation SSR Dev Server",
"description": "Serve a SSR Consumer (host) application along with its known Producers (remotes).",
"cli": "nx",
"type": "object",
"properties": {
"browserTarget": {
"type": "string",
"description": "Target which builds the browser application.",
"x-priority": "important"
},
"serverTarget": {
"type": "string",
"description": "Target which builds the server application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "The port to be set on `process.env.PORT` for use in the server.",
"default": 4200,
"x-priority": "important"
},
"devRemotes": {
"type": "array",
"items": { "type": "string" },
"description": "List of Producer (remote) applications to run in development mode (i.e. using serve target).",
"x-priority": "important",
"alias": "devProducers"
},
"skipRemotes": {
"type": "array",
"items": { "type": "string" },
"description": "List of Producer (remote) applications to not automatically serve, either statically or in development mode.",
"x-priority": "important",
"alias": "skipProducers"
},
"host": {
"type": "string",
"description": "Host to listen on.",
"default": "localhost"
},
"staticRemotesPort": {
"type": "number",
"description": "The port at which to serve the file-server for the static Producers (remotes).",
"alias": "staticProducersPort"
},
"pathToManifestFile": {
"type": "string",
"description": "Path to a Module Federation manifest file (e.g. `my/path/to/module-federation.manifest.json`) containing the dynamic Producer (remote) applications relative to the workspace root."
},
"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."
},
"isInitialHost": {
"type": "boolean",
"description": "Whether the Consumer (host) that is running this executor is the first in the project tree to do so.",
"default": true,
"x-priority": "internal",
"alias": "isInitialConsumer"
}
},
"required": ["browserTarget", "serverTarget"],
"presets": []
},
"description": "Serve a host application along with it's known remotes.",
"aliases": [],
"hidden": false,
"path": "/packages/react/src/executors/module-federation-ssr-dev-server/schema.json",
"type": "executor"
}