@nx/workspace/src/generators/new/schema.json

The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.

{
  "$schema": "https://json-schema.org/schema",
  "$id": "NxWorkspaceNew",
  "title": "Create an empty workspace",
  "description": "Create an empty workspace.",
  "type": "object",
  "cli": "nx",
  "properties": {
    "name": {
      "description": "The name of the workspace.",
      "type": "string",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "What name would you like to use for the workspace?"
    },
    "style": {
      "description": "The file extension to be used for style files.",
      "type": "string",
      "default": "css"
    },
    "routing": {
      "description": "Add routing to the generated application.",
      "type": "boolean",
      "default": true
    },
    "useReactRouter": {
      "description": "Use React Router for routing.",
      "type": "boolean",
      "default": false
    },
    "standaloneApi": {
      "description": "Use Standalone Components if generating an Angular application.",
      "type": "boolean",
      "default": false
    },
    "defaultBase": {
      "type": "string",
      "description": "Default base branch for affected."
    },
    "skipInstall": {
      "description": "Skip installing dependency packages.",
      "type": "boolean",
      "default": false
    },
    "preset": {
      "description": "What to create in the new workspace.",
      "type": "string"
    },
    "appName": {
      "type": "string",
      "description": "Application name."
    },
    "linter": {
      "description": "The tool to use for running lint checks.",
      "type": "string",
      "enum": ["eslint", "none"],
      "default": "eslint"
    },
    "packageManager": {
      "description": "The package manager used to install dependencies.",
      "type": "string",
      "enum": ["npm", "yarn", "pnpm", "bun"]
    },
    "framework": {
      "description": "The framework which the application is using",
      "type": "string",
      "enum": ["express", "koa", "fastify", "nest", "none"]
    },
    "nextAppDir": {
      "description": "Enable the App Router for this project.",
      "type": "boolean",
      "default": true
    },
    "nextSrcDir": {
      "description": "Generate a `src` directory for this project.",
      "type": "boolean",
      "default": true
    },
    "unitTestRunner": {
      "description": "The tool to use for running unit tests.",
      "type": "string",
      "enum": ["jest", "vitest", "none"]
    },
    "e2eTestRunner": {
      "description": "The tool to use for running e2e tests.",
      "type": "string",
      "enum": ["playwright", "cypress", "jest", "detox", "none"]
    },
    "ssr": {
      "description": "Enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) for the Angular application.",
      "type": "boolean",
      "default": false
    },
    "serverRouting": {
      "description": "Use the Angular Server Routing and App Engine APIs (Developer Preview).",
      "type": "boolean"
    },
    "prefix": {
      "description": "The prefix to use for Angular component and directive selectors.",
      "type": "string"
    },
    "formatter": {
      "description": "The tool to use for code formatting.",
      "type": "string",
      "enum": ["none", "prettier"],
      "default": "none"
    },
    "workspaces": {
      "description": "Whether to use package manager workspaces.",
      "type": "boolean",
      "default": true
    },
    "useProjectJson": {
      "type": "boolean",
      "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
    }
  },
  "additionalProperties": true
}