@nx/react-native/src/generators/application/schema.json

The Nx Plugin for React Native contains generators for managing React Native applications and libraries within an Nx workspace. It provides: -Integration with libraries such as Jest, Detox, and Storybook. -Scaffolding for creating buildable libraries th

{
  "cli": "nx",
  "$id": "NxReactNativeApplication",
  "$schema": "https://json-schema.org/schema",
  "title": "Create a React Application for Nx",
  "description": "Create a React Application for Nx.",
  "examples": [
    {
      "command": "nx g @nx/react-native:app myapp --directory=nested",
      "description": "Generate `apps/nested/myapp`"
    },
    {
      "command": "nx g @nx/react-native:app myapp --classComponent",
      "description": "Use class components instead of functional components"
    }
  ],
  "type": "object",
  "properties": {
    "directory": {
      "description": "The directory of the new application.",
      "type": "string",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "Which directory do you want to create the application in?"
    },
    "name": {
      "description": "The name of the application.",
      "pattern": "^[a-zA-Z][^:]*$",
      "type": "string"
    },
    "displayName": {
      "description": "The display name to show in the application. Defaults to name.",
      "type": "string"
    },
    "skipFormat": {
      "description": "Skip formatting files",
      "type": "boolean",
      "default": false,
      "x-priority": "internal"
    },
    "linter": {
      "description": "The tool to use for running lint checks.",
      "type": "string",
      "enum": ["eslint", "none"],
      "default": "none",
      "x-priority": "important"
    },
    "unitTestRunner": {
      "type": "string",
      "enum": ["jest", "none"],
      "description": "Test runner to use for unit tests",
      "default": "none",
      "x-priority": "important"
    },
    "tags": {
      "type": "string",
      "description": "Add tags to the application (used for linting).",
      "alias": "t"
    },
    "js": {
      "type": "boolean",
      "description": "Generate JavaScript files rather than TypeScript files",
      "default": false
    },
    "setParserOptionsProject": {
      "type": "boolean",
      "description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
      "default": false
    },
    "e2eTestRunner": {
      "description": "Adds the specified e2e test runner.",
      "type": "string",
      "enum": ["playwright", "cypress", "detox", "none"],
      "default": "none",
      "x-priority": "important"
    },
    "install": {
      "type": "boolean",
      "description": "Runs `pod install` for native modules before building iOS app.",
      "x-prompt": "Run 'pod install' for native modules?",
      "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": ["vite", "webpack"],
      "x-prompt": "Which bundler do you want to use to build the application?",
      "default": "vite",
      "x-priority": "important"
    },
    "useProjectJson": {
      "type": "boolean",
      "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
    }
  },
  "required": ["directory"]
}