@nx/expo/src/generators/application/schema.json

The Expo Plugin for Nx contains executors and generators for managing and developing an expo application within your workspace. For example, you can directly build for different target platforms as well as generate projects and publish your code.

{
  "cli": "nx",
  "$id": "NxExpoApplication",
  "$schema": "https://json-schema.org/schema",
  "description": "Create an Expo Application for Nx.",
  "examples": [
    {
      "command": "nx g @nx/expo:app myapp --directory=nested",
      "description": "Generate apps/nested/myapp"
    },
    {
      "command": "nx g @nx/expo: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.",
      "type": "string",
      "pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
      "x-priority": "important"
    },
    "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-prompt": "Which linter would you like to use?",
      "x-priority": "important"
    },
    "unitTestRunner": {
      "type": "string",
      "enum": ["jest", "none"],
      "description": "Test runner to use for unit tests",
      "default": "none",
      "x-prompt": "Which unit test runner would you like to use?",
      "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"
    },
    "standaloneConfig": {
      "description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
      "type": "boolean",
      "default": true,
      "x-deprecated": "Nx only supports standaloneConfig"
    },
    "skipPackageJson": {
      "type": "boolean",
      "description": "Do not add dependencies to `package.json`.",
      "default": false
    },
    "useProjectJson": {
      "type": "boolean",
      "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
    }
  },
  "required": ["directory"]
}