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

The Nx Plugin for Web Components contains generators for managing Web Component applications and libraries within an Nx workspace. It provides: - Integration with libraries such as Jest, Playwright, Cypress, and Storybook. - Scaffolding for creating bu

{
  "$schema": "https://json-schema.org/schema",
  "cli": "nx",
  "$id": "NxWebApp",
  "title": "Create a Web Application for Nx",
  "description": "Create a web application using `swc` or `babel` as compiler.",
  "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-Z][^:]*$",
      "x-priority": "important"
    },
    "style": {
      "description": "The file extension to be used for style files.",
      "type": "string",
      "default": "css",
      "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": "less",
            "label": "LESS         [ https://lesscss.org     ]"
          }
        ]
      }
    },
    "compiler": {
      "type": "string",
      "description": "The compiler to use",
      "enum": ["swc", "babel"],
      "default": "swc",
      "x-priority": "important"
    },
    "bundler": {
      "type": "string",
      "description": "The bundler to use.",
      "enum": ["vite", "webpack", "none"],
      "default": "vite",
      "x-prompt": "Which bundler do you want to use?",
      "x-priority": "important"
    },
    "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?"
    },
    "skipFormat": {
      "description": "Skip formatting files",
      "type": "boolean",
      "default": false,
      "x-priority": "internal"
    },
    "unitTestRunner": {
      "type": "string",
      "enum": ["vitest", "jest", "none"],
      "default": "none",
      "description": "Test runner to use for unit tests. Default value is 'jest' when using 'webpack' or 'none' as the bundler and 'vitest' when using 'vite' as the bundler",
      "x-prompt": "What unit test runner should be used?"
    },
    "inSourceTests": {
      "type": "boolean",
      "default": false,
      "description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files."
    },
    "e2eTestRunner": {
      "type": "string",
      "enum": ["playwright", "cypress", "none"],
      "x-prompt": "Which E2E test runner would you like to use?",
      "description": "Test runner to use for end to end (e2e) tests",
      "default": "playwright"
    },
    "tags": {
      "type": "string",
      "description": "Add tags to the application (used for linting)"
    },
    "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
    },
    "strict": {
      "type": "boolean",
      "description": "Creates an application with strict mode and strict type checking.",
      "default": true
    },
    "useProjectJson": {
      "type": "boolean",
      "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
    }
  },
  "required": ["directory"],
  "examplesFile": "../../../docs/application-examples.md"
}