@jnxplus/nx-maven/src/generators/application/schema.json

[](https://badge.fury.io/js/@jnxplus%2Fnx-maven)

{
  "$schema": "http://json-schema.org/schema",
  "$id": "NxMavenApp",
  "title": "Create an application",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "What name would you like to use?",
      "pattern": "^[a-zA-Z].*$"
    },
    "tags": {
      "type": "string",
      "description": "Add tags to the project (used for linting)",
      "alias": "t"
    },
    "directory": {
      "type": "string",
      "description": "A directory where the project is placed",
      "alias": "dir"
    },
    "simpleName": {
      "description": "Don't include the directory in the app name",
      "type": "boolean",
      "default": true
    },
    "simplePackageName": {
      "description": "Don't include the directory in the package name",
      "type": "boolean",
      "default": true
    },
    "language": {
      "description": "Language of the project",
      "type": "string",
      "default": "java",
      "x-prompt": {
        "message": "Which language would you like to use?",
        "type": "list",
        "items": [
          {
            "value": "java",
            "label": "Java"
          },
          {
            "value": "kotlin",
            "label": "Kotlin"
          }
        ]
      }
    },
    "groupId": {
      "type": "string",
      "default": "com.example",
      "x-prompt": "What groupId would you like to use?"
    },
    "projectVersion": {
      "type": "string",
      "default": "0.0.1-SNAPSHOT",
      "description": "Version of the project to generate",
      "alias": "v",
      "x-prompt": "What project version would you like to use?"
    },
    "packaging": {
      "description": "Packaging of the project",
      "type": "string",
      "enum": ["jar", "war"],
      "default": "jar"
    },
    "framework": {
      "description": "framework",
      "type": "string",
      "default": "spring-boot",
      "enum": ["spring-boot", "quarkus", "micronaut", "none"],
      "x-prompt": {
        "message": "Which framework to use? or 'none' to skip.",
        "type": "list",
        "items": [
          {
            "value": "spring-boot",
            "label": "spring-boot"
          },
          {
            "value": "quarkus",
            "label": "quarkus"
          },
          {
            "value": "micronaut",
            "label": "micronaut"
          },
          {
            "value": "none",
            "label": "none"
          }
        ]
      }
    },
    "configFormat": {
      "description": "Configuration format of the project",
      "type": "string",
      "default": ".properties",
      "x-prompt": {
        "message": "Which configuration format would you like to use?",
        "type": "list",
        "items": [
          {
            "value": ".properties",
            "label": "Properties"
          },
          {
            "value": ".yml",
            "label": "Yaml"
          }
        ]
      }
    },
    "parentProject": {
      "type": "string",
      "default": "",
      "description": "ArtifactId of the parent project",
      "x-prompt": "Which artifactId to use for parent project?"
    },
    "aggregatorProject": {
      "type": "string",
      "description": "ArtifactId of the aggregator project (that manages a group of submodules) or leave it blank for the root project"
    },
    "minimal": {
      "description": "Generate an app with a minimal setup",
      "type": "boolean",
      "default": false
    },
    "port": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ],
      "default": 8080,
      "description": "Port to start the server at. Default is 8080."
    },
    "skipFormat": {
      "description": "Skip formatting files.",
      "type": "boolean",
      "default": false
    }
  },
  "required": [
    "name",
    "language",
    "groupId",
    "projectVersion",
    "configFormat",
    "parentProject"
  ]
}