packages/workspace/src/generators/run-commands/schema.json

{
  "$schema": "https://json-schema.org/schema",
  "$id": "SchematicsRunCommands",
  "title": "Create a custom target to run any command",
  "description": "Create a custom target to run any command.",
  "type": "object",
  "cli": "nx",
  "examples": [
    {
      "command": "nx g @nx/workspace:run-commands printhello --project my-feature-lib --command 'echo hello'",
      "description": "Add the `printhello` target to `my-feature-lib`"
    }
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Target name.",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "What name would you like to use to invoke the command?"
    },
    "project": {
      "description": "Project name.",
      "type": "string",
      "x-prompt": "What project does the target belong to?",
      "x-dropdown": "projects"
    },
    "command": {
      "description": "Command to run.",
      "type": "string",
      "x-prompt": "What command would you like to run?"
    },
    "cwd": {
      "description": "Current working directory of the command.",
      "type": "string"
    },
    "outputs": {
      "description": "Allows you to specify where the build artifacts are stored. This allows Nx Cloud to pick them up correctly, in the case that the build artifacts are placed somewhere other than the top level dist folder.",
      "type": "string"
    },
    "envFile": {
      "description": "Env files to be loaded before executing the commands.",
      "type": "string"
    }
  },
  "required": ["name", "command", "project"]
}