schema.json

{
	"$schema": "https://json-schema.org/draft-04/schema#",
	"$id": "https://example.com/packages.schema.json",
	"title": "Applications / Packages",
	"description": "A schema for defining applications or packages to install on Windows machine.",
	"required": ["package_source", "powershell_modules", "package_plugins"],
	"type": "object",
	"properties": {
		"environment_variables": {
			"type": "array",
			"items": {
				"type": "object",
				"required": ["name", "value", "command"],
				"properties": {
					"value": { "type": "string" },
					"name": { "type": "string" },
					"command": { "type": "string" }
				},
				"uniqueItems": true
			}
		},
		"package_source": {
			"description": "The source (command line) to get package from",
			"type": "object",
			"required": ["winget", "scoop", "choco"],
			"properties": {
				"winget": {
					"type": "object",
					"description": "Install applications using `winget` cli.",
					"required": ["auto_install", "packages"],
					"properties": {
						"auto_install": {
							"type": "boolean",
							"description": "Whether or not automatically install `winget` cli and install packages from the list if it is not found."
						},
						"packages": {
							"type": "array",
							"description": "List of winget packages' IDs to install.",
							"uniqueItems": true,
							"required": ["id"],
							"properties": {
								"id": {
									"type": "string",
									"description": "Winget Package ID"
								},
								"source": {
									"type": "string",
									"enum": ["msstore", "winget"]
								}
							}
						},
						"additional_args": {
							"type": "array",
							"description": "Additional args for `winget install [package]`"
						}
					}
				},
				"choco": {
					"type": "object",
					"description": "Install applications using `choco` cli: To add programs for developers which will be available for all users",
					"required": ["auto_install", "packages"],
					"properties": {
						"auto_install": {
							"type": "boolean",
							"description": "Whether or not automatically install `choco` cli and install packages from the list if it is not found."
						},
						"packages": {
							"type": "array",
							"description": "List of choco packages' names to install.",
							"uniqueItems": true
						},
						"additional_args": {
							"type": "array",
							"description": "Additional args for `choco install [package]`"
						}
					}
				},
				"scoop": {
					"type": "object",
					"description": "Install applications using `scoop` cli: To add packages which installed for current user.",
					"required": ["auto_install", "packages", "buckets"],
					"properties": {
						"auto_install": {
							"type": "boolean",
							"description": "Whether or not automatically install `scoop` cli and install packages from the list if it is not found."
						},
						"packages": {
							"type": "array",
							"description": "List of scoop packages' names to install.",
							"uniqueItems": true
						},
						"buckets": {
							"type": "array",
							"description": "List of scoop buckets to add.",
							"uniqueItems": true
						},
						"additional_args": {
							"type": "array",
							"description": "Additional args for `scoop install [package]`"
						}
					}
				}
			}
		},
		"package_plugins": {
			"description": "Addons for installed packages",
			"type": "array",
			"items": {
				"type": "object",
				"required": ["command_name", "invoke_command", "check_command", "plugins", "install"],
				"properties": {
					"command_name": {
						"type": "string",
						"description": "Installed command name"
					},
					"invoke_command": {
						"type": "string",
						"description": "Command to invoke to install an addon"
					},
					"check_command": {
						"type": "string",
						"description": "Command to if an addon is installed or not"
					},
					"install": {
						"type": "boolean",
						"description": "Whether or not to install provided plugins/extensions for application in the list"
					},
					"plugins": {
						"type": "array",
						"uniqueItems": true
					}
				},
				"uniqueItems": true
			}
		},
		"powershell_modules": {
			"type": "object",
			"description": "Powershell Core",
			"uniqueItems": true,
			"required": ["modules", "install"],
			"properties": {
				"install": {
					"type": "boolean",
					"description": "Whether or not to install powershell modules in provided list"
				},
				"modules": {
					"type": "array",
					"description": "List of powershell modules"
				},
				"additional_args": {
					"type": "array",
					"description": "Additional args for `Install-Module [module name]`"
				}
			}
		}
	}
}