@nestjsplus/lib-starter/schematics/install/schema.json

Boilerplate for building installable NestJS libraries

{
  "$schema": "http://json-schema.org/schema",
  "id": "SchematicsNestEngineInstall",
  "title": "@nestjsplus/config Options Schema",
  "type": "object",
  "properties": {
    "sourceRoot": {
      "description": "Source root",
      "type": "string"
    },
    "name": {
      "description": "Name of the 'Config' Module, that imports ConfigManagerModule",
      "type": "string",
      "default": "Config",
      "x-prompt": "Config module name ('Module' automatically appended):"
    },
    "skipInstall": {
      "description": "Skip installing dependency packages.",
      "type": "boolean",
      "default": false
    },
    "dbg": {
      "description": "Debug?",
      "type": "boolean",
      "default": false
    },
    "genEnv": {
      "description": "Generate environments folder",
      "type": "boolean",
      "default": true,
      "x-prompt": "Create environments folder?"
    },
    "envDir": {
      "description": "Folder containing .env files.",
      "type": "string",
      "default": "environments"
    },
    "genDemo": {
      "description": "Create demo module?",
      "type": "boolean",
      "default": true,
      "x-prompt": "Create demo module?"
    },
    "testMessage": {
      "description": "Test environment variable value",
      "type": "string",
      "default": "Hello from ConfigModule",
      "x-prompt": "Env testing value (used only to confirm installation):"
    },
    "envStrategy": {
      "description": "Use a static file, or determine dynamically by value of NODE_ENV",
      "enum": ["static", "NODE_ENV"],
      "default": "static",
      "x-prompt": "Use a static .env file, or determine location dynamically by value of NODE_ENV:"
    }
  },
  "required": []
}