@nx/nest/src/generators/guard/schema.json

The Nx Plugin for Nest contains executors and generators for allowing your workspace to create powerful Nest best in class APIs.

{
  "$schema": "https://json-schema.org/schema",
  "$id": "NxNestGuardGenerator",
  "title": "Nest Guard Options Schema",
  "description": "Nest Guard Options Schema.",
  "cli": "nx",
  "type": "object",
  "examples": [
    {
      "description": "Generate the guard `FooGuard` at `myapp/src/app/foo.guard.ts`",
      "command": "nx g @nx/nest:guard myapp/src/app/foo.guard.ts"
    },
    {
      "description": "Generate the guard without providing the file extension. It results in the guard `FooGuard` at `myapp/src/app/foo.guard.ts`",
      "command": "nx g @nx/nest:guard myapp/src/app/foo"
    }
  ],
  "properties": {
    "path": {
      "description": "The file path to the guard. Relative to the current working directory.",
      "type": "string",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "What is the guard file path?"
    },
    "skipFormat": {
      "description": "Skip formatting files.",
      "type": "boolean",
      "default": false,
      "x-priority": "internal"
    },
    "unitTestRunner": {
      "description": "Test runner to use for unit tests.",
      "type": "string",
      "enum": ["jest", "none"],
      "default": "jest"
    },
    "language": {
      "description": "Nest guard language.",
      "type": "string",
      "enum": ["js", "ts"]
    }
  },
  "additionalProperties": false,
  "required": ["path"]
}