@nx/plugin/src/generators/e2e-project/schema.json

This plugin is used to create Nx plugins! It contains generators for generating common plugin features like generators, executors, migrations and more.

{
  "$schema": "https://json-schema.org/schema",
  "cli": "nx",
  "$id": "NxPluginE2E",
  "title": "Create an E2E app for a Nx Plugin",
  "description": "Create an E2E app for a Nx Plugin.",
  "examplesFile": "../../../docs/generators/e2e-project-examples.md",
  "type": "object",
  "properties": {
    "pluginName": {
      "type": "string",
      "description": "the project name of the plugin to be tested.",
      "x-priority": "important"
    },
    "npmPackageName": {
      "type": "string",
      "description": "the package name of the plugin as it would be published to NPM.",
      "x-priority": "important"
    },
    "projectDirectory": {
      "type": "string",
      "description": "the directory where the plugin is placed."
    },
    "pluginOutputPath": {
      "type": "string",
      "description": "the output path of the plugin after it builds.",
      "x-priority": "important"
    },
    "jestConfig": {
      "type": "string",
      "description": "Jest config file."
    },
    "linter": {
      "description": "The tool to use for running lint checks.",
      "type": "string",
      "enum": ["none", "eslint"]
    },
    "minimal": {
      "type": "boolean",
      "description": "Generate the e2e project with a minimal setup. This would involve not generating tests for a default executor and generator.",
      "default": false
    },
    "skipFormat": {
      "description": "Skip formatting files.",
      "type": "boolean",
      "default": false,
      "x-priority": "internal"
    },
    "useProjectJson": {
      "type": "boolean",
      "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
    }
  },
  "required": ["pluginName", "npmPackageName"]
}