@nx/angular/src/executors/module-federation-ssr-dev-server/schema.json

The Nx Plugin for Angular contains executors, generators, and utilities for managing Angular applications and libraries within an Nx workspace. It provides: - Integration with libraries such as Storybook, Jest, ESLint, Tailwind CSS, Playwright and Cypre

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "title": "Module Federation SSR Dev Server Target",
  "continuous": true,
  "outputCapture": "direct-nodejs",
  "description": "The module-federation-ssr-dev-server executor is reserved exclusively for use with host SSR Module Federation applications. It allows the user to specify which remote applications should be served with the host.",
  "type": "object",
  "properties": {
    "browserTarget": {
      "type": "string",
      "description": "Browser target to build.",
      "pattern": ".+:.+(:.+)?"
    },
    "serverTarget": {
      "type": "string",
      "description": "Server target to build.",
      "pattern": ".+:.+(:.+)?"
    },
    "host": {
      "type": "string",
      "description": "Host to listen on.",
      "default": "localhost"
    },
    "port": {
      "type": "number",
      "default": 4200,
      "description": "Port to start the development server at. Default is 4200. Pass 0 to get a dynamically assigned port."
    },
    "publicHost": {
      "type": "string",
      "description": "The URL that the browser client should use to connect to the development server. Use for a complex dev server setup, such as one with reverse proxies."
    },
    "open": {
      "type": "boolean",
      "description": "Opens the url in default browser.",
      "default": false,
      "alias": "o"
    },
    "progress": {
      "type": "boolean",
      "description": "Log progress to the console while building."
    },
    "inspect": {
      "type": "boolean",
      "description": "Launch the development server in inspector mode and listen on address and port '127.0.0.1:9229'.",
      "default": false
    },
    "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."
    },
    "proxyConfig": {
      "type": "string",
      "description": "Proxy configuration file."
    },
    "devRemotes": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "object",
            "properties": {
              "remoteName": {
                "type": "string"
              },
              "configuration": {
                "type": "string"
              }
            },
            "required": ["remoteName"],
            "additionalProperties": false
          }
        ]
      },
      "description": "List of remote applications to run in development mode (i.e. using serve target).",
      "x-priority": "important"
    },
    "skipRemotes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of remote applications to not automatically serve, either statically or in development mode."
    },
    "verbose": {
      "type": "boolean",
      "description": "Adds more details to output logging.",
      "default": false
    },
    "pathToManifestFile": {
      "type": "string",
      "description": "Path to a Module Federation manifest file (e.g. `my/path/to/module-federation.manifest.json`) containing the dynamic remote applications relative to the workspace root."
    },
    "isInitialHost": {
      "type": "boolean",
      "description": "Whether the host that is running this executor is the first in the project tree to do so.",
      "default": true,
      "x-priority": "internal"
    },
    "parallel": {
      "type": "number",
      "description": "Max number of parallel processes for building static remotes"
    },
    "staticRemotesPort": {
      "type": "number",
      "description": "The port at which to serve the file-server for the static remotes."
    }
  },
  "additionalProperties": false,
  "required": ["browserTarget", "serverTarget"]
}