nx-electron/src/generators/nx-electron/schema.json

Electron Plugin for Nx

{
  "$schema": "https://json-schema.org/schema",
  "$id": "SchematicsNxElectronApp",
  "title": "Nx Application Options Schema",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the application.",
      "type": "string",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "What name would you like to use for the electron application?"
    },
    "frontendProject": {
      "type": "string",
      "description": "Frontend project that needs to access this application.",
      "x-prompt": "What's the name of the web application in your workspace you'd like to use inside Electron?"
    },
    "directory": {
      "type": "string",
      "description": "The directory of the new application."
    },
    "extraProjects": {
      "type": "array",
      "description": "Extra frontend project that needs to access this application.",
      "default": [],
      "uniqueItems": true,
      "items": {
        "type": "string"
      }
    },
    "addProxy": {
      "type": "boolean",
      "default": false,
      "description": "Add proxy configuration to the frontend project."
    },
    "proxyPort": {
      "type": "number",
      "default": 3000,
      "description": "Proxy server port number."
    },
    "skipFormat": {
      "description": "Skip formatting files",
      "type": "boolean",
      "default": false
    },
    "skipPackageJson": {
      "type": "boolean",
      "default": false,
      "description": "Do not add dependencies to package.json."
    },
    "linter": {
      "description": "The tool to use for running lint checks.",
      "type": "string",
      "enum": [
        "eslint",
        "tslint"
      ],
      "default": "eslint"
    },
    "unitTestRunner": {
      "type": "string",
      "enum": [
        "jest",
        "none"
      ],
      "description": "Test runner to use for unit tests",
      "default": "jest"
    },
    "tags": {
      "type": "string",
      "description": "Add tags to the application (used for linting)"
    },
    "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
    }
  },
  "required": [
    "name"
  ]
}