@nx/plugin/src/generators/plugin/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": "NxPluginPlugin",
  "title": "Create a Plugin for Nx",
  "description": "Create a Plugin for Nx.",
  "type": "object",
  "examples": [
    {
      "command": "nx g plugin my-plugin --directory=plugins --importPath=@myorg/my-plugin",
      "description": "Generates an Nx plugin project called `plugins-my-plugin` at `libs/plugins/my-plugin`. The project will have an npm package name and import path of `@myorg/my-plugin`."
    }
  ],
  "properties": {
    "directory": {
      "type": "string",
      "description": "A directory where the plugin is placed.",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "Which directory do you want to create the plugin in?"
    },
    "name": {
      "type": "string",
      "description": "Plugin name",
      "x-priority": "important"
    },
    "importPath": {
      "type": "string",
      "description": "How the plugin will be published, like `@myorg/my-awesome-plugin`. Note this must be a valid NPM name.",
      "x-priority": "important"
    },
    "linter": {
      "description": "The tool to use for running lint checks.",
      "type": "string",
      "enum": ["none", "eslint"],
      "x-priority": "important"
    },
    "unitTestRunner": {
      "description": "Test runner to use for unit tests.",
      "type": "string",
      "enum": ["none", "jest", "vitest"],
      "x-priority": "important"
    },
    "tags": {
      "type": "string",
      "description": "Add tags to the library (used for linting).",
      "alias": "t"
    },
    "skipFormat": {
      "description": "Skip formatting files.",
      "type": "boolean",
      "default": false,
      "x-priority": "internal"
    },
    "skipTsConfig": {
      "type": "boolean",
      "default": false,
      "description": "Do not update tsconfig.json for development experience.",
      "x-priority": "internal"
    },
    "skipLintChecks": {
      "type": "boolean",
      "default": false,
      "description": "Do not eslint configuration for plugin json files."
    },
    "e2eTestRunner": {
      "type": "string",
      "enum": ["jest", "none"],
      "description": "Test runner to use for end to end (E2E) tests.",
      "default": "none"
    },
    "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"
    },
    "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
    },
    "compiler": {
      "type": "string",
      "enum": ["tsc", "swc"],
      "default": "tsc",
      "description": "The compiler used by the build and test targets."
    },
    "publishable": {
      "type": "boolean",
      "description": "Generates a boilerplate for publishing the plugin to npm.",
      "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"]
}