@nx/react/dist/src/generators/host/schema.json

The React plugin for Nx contains executors and generators for managing React applications and libraries within an Nx workspace. It provides: - Integration with libraries such as Jest, Vitest, Playwright, Cypress, and Storybook. - Generators for applica

{
  "$schema": "https://json-schema.org/schema",
  "$id": "GeneratorReactHost",
  "cli": "nx",
  "title": "Generate Module Federation Setup for React Consumer (Host) App",
  "description": "Create Module Federation configuration files for given React Consumer (Host) Application.",
  "type": "object",
  "properties": {
    "directory": {
      "description": "The directory of the new application.",
      "type": "string",
      "alias": "dir",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "Which directory do you want to create the application in?"
    },
    "name": {
      "type": "string",
      "description": "The name of the Consumer (host) application to generate the Module Federation configuration",
      "pattern": "^[a-zA-Z][^:]*$",
      "x-priority": "important"
    },
    "style": {
      "description": "The file extension to be used for style files.",
      "type": "string",
      "default": "css",
      "alias": "s",
      "enum": ["css", "scss", "none"],
      "x-prompt": {
        "message": "Which stylesheet format would you like to use?",
        "type": "list",
        "items": [
          {
            "value": "css",
            "label": "CSS"
          },
          {
            "value": "scss",
            "label": "SASS(.scss)       [ https://sass-lang.com   ]"
          },
          {
            "value": "none",
            "label": "None"
          }
        ]
      }
    },
    "linter": {
      "description": "The tool to use for running lint checks.",
      "type": "string",
      "enum": ["eslint"],
      "default": "eslint"
    },
    "dynamic": {
      "type": "boolean",
      "description": "Should the Consumer (host) application use dynamic federation?",
      "default": false
    },
    "skipFormat": {
      "description": "Skip formatting files.",
      "type": "boolean",
      "default": false,
      "x-priority": "internal"
    },
    "skipNxJson": {
      "description": "Skip updating nx.json with default options based on values provided to this app (e.g. babel, style).",
      "type": "boolean",
      "default": false,
      "x-priority": "internal"
    },
    "unitTestRunner": {
      "type": "string",
      "enum": ["jest", "none"],
      "description": "Test runner to use for unit tests.",
      "default": "jest"
    },
    "e2eTestRunner": {
      "type": "string",
      "enum": ["playwright", "cypress", "none"],
      "description": "Test runner to use for end to end (E2E) tests.",
      "x-prompt": "Which E2E test runner would you like to use?",
      "default": "playwright"
    },
    "tags": {
      "type": "string",
      "description": "Add tags to the application (used for linting).",
      "alias": "t"
    },
    "classComponent": {
      "type": "boolean",
      "description": "Use class components instead of functional component.",
      "alias": "C",
      "default": false
    },
    "js": {
      "type": "boolean",
      "description": "Generate JavaScript files rather than TypeScript files.",
      "default": false
    },
    "globalCss": {
      "type": "boolean",
      "description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
      "default": false
    },
    "strict": {
      "type": "boolean",
      "description": "Creates an application with strict mode and strict type checking",
      "default": true
    },
    "enableTypedLinting": {
      "type": "boolean",
      "description": "Whether to enable typed linting. For flat configs, this configures the recommended `parserOptions.projectService` and `tsconfigRootDir`. For legacy `.eslintrc` configs, this configures `parserOptions.project`. We do not enable this by default for lint performance reasons.",
      "default": false
    },
    "setParserOptionsProject": {
      "type": "boolean",
      "description": "Deprecated alias for `enableTypedLinting`.",
      "default": false,
      "x-deprecated": "Use `enableTypedLinting` instead. This option will be removed in Nx v24."
    },
    "compiler": {
      "type": "string",
      "description": "The compiler to use",
      "enum": ["babel", "swc"],
      "default": "babel"
    },
    "remotes": {
      "type": "array",
      "description": "A list of Producer (remote) application names that the Consumer (host) application should consume.",
      "default": [],
      "x-priority": "important",
      "alias": "producers"
    },
    "devServerPort": {
      "type": "number",
      "description": "The port for the dev server of the Producer (remote) app.",
      "default": 4200,
      "x-priority": "important"
    },
    "ssr": {
      "description": "Whether to configure SSR for the Consumer (host) application",
      "type": "boolean",
      "default": false
    },
    "minimal": {
      "description": "Generate a React app with a minimal setup. No nx starter template.",
      "type": "boolean",
      "default": false
    },
    "typescriptConfiguration": {
      "type": "boolean",
      "description": "Whether the module federation configuration and webpack configuration files should use TS. When --js is used, this flag is ignored.",
      "default": true
    },
    "skipPackageJson": {
      "description": "Do not add dependencies to `package.json`.",
      "type": "boolean",
      "default": false,
      "x-priority": "internal"
    },
    "bundler": {
      "description": "The bundler to use.",
      "type": "string",
      "enum": ["rspack", "webpack"],
      "x-prompt": "Which bundler do you want to use to build the application?",
      "default": "rspack",
      "x-priority": "important"
    }
  },
  "required": ["directory"],
  "additionalProperties": false
}