@nx/plugin/src/generators/executor/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": "NxPluginExecutor",
  "title": "Create an Executor for an Nx Plugin",
  "description": "Create an Executor for an Nx Plugin.",
  "examplesFile": "../../../docs/generators/executor-examples.md",
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "The file path to the executor. Relative to the current working directory.",
      "x-prompt": "What is the executor file path?",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-priority": "important"
    },
    "name": {
      "type": "string",
      "description": "The executor name to export in the plugin executors collection."
    },
    "description": {
      "type": "string",
      "description": "Executor description.",
      "x-priority": "important"
    },
    "unitTestRunner": {
      "type": "string",
      "enum": ["jest", "vitest", "none"],
      "description": "Test runner to use for unit tests.",
      "default": "jest"
    },
    "includeHasher": {
      "type": "boolean",
      "default": false,
      "description": "Should the boilerplate for a custom hasher be generated?"
    },
    "skipLintChecks": {
      "type": "boolean",
      "default": false,
      "description": "Do not add an eslint configuration for plugin json files."
    },
    "skipFormat": {
      "type": "boolean",
      "description": "Skip formatting files.",
      "default": false,
      "x-priority": "internal"
    }
  },
  "required": ["path"],
  "additionalProperties": false
}