schema.json

{
	"$schema": "https://json-schema.org/draft-07/schema#",
	"title": "Applications / Packages",
	"description": "Define applications / packages to install on Windows machine.",
	"required": ["installSource", "packageAddon", "powershell", "environmentVariable"],
	"type": "object",
	"properties": {
		"installSource": {
			"description": "Define which command used to install packages",
			"type": "object",
			"required": ["winget", "choco", "scoop"],
			"properties": {
				"winget": {
					"description": "Define `winget` cli settings to install packages",
					"type": "object",
					"required": ["autoInstall", "packageList", "additionalArgs"],
					"properties": {
						"autoInstall": {
							"type": "boolean",
							"description": "Whether or not automatically install `winget` if not found and install packages from the list"
						},
						"packageList": {
							"description": "List of winget packages",
							"type": "array",
							"uniqueItems": true,
							"items": {
								"required": ["packageId"],
								"type": "object",
								"properties": {
									"packageId": {
										"description": "winget package's id",
										"type": "string"
									},
									"packageSource": {
										"description": "winget package's source",
										"type": "string",
										"enum": [ "msstore", "winget" ]
									}
								}
							}
						},
						"additionalArgs": {
							"description": "Extra arguments passed in for `winget install [package]` command",
							"type": "array",
							"uniqueItems": true,
							"items": {
								"type": "string"
							}
						}
					}
				},
				"choco": {
					"description": "Define `choco` cli settings to install packages",
					"type": "object",
					"required": ["autoInstall", "packageList", "additionalArgs"],
					"properties": {
						"autoInstall": {
							"description": "Whether or not automatically install `choco` if not found and install packages from the list",
							"type": "boolean"
						},
						"packageList": {
							"description": "List of chocolatey packages",
							"type": "array",
							"uniqueItems": true,
							"items": {
								"type": "object",
								"required": ["packageName"],
								"properties": {
									"packageName": {
										"description": "Name of chocolatey package",
										"type": "string"
									},
									"packageVersion": {
										"description": "Version of specified chocolatey package",
										"type": "string"
									}
								}
							}
						},
						"additionalArgs": {
							"description": "Extra arguments passed in for `choco install [package]` command",
							"type": "array",
							"uniqueItems": true,
							"items": {
								"type": "string"
							}
						}
					}
				},
				"scoop": {
					"description": "Define `scoop` cli settings to install packages",
					"type": "object",
					"required": ["autoInstall", "packageList", "bucketList", "additionalArgs"],
					"properties": {
						"autoInstall": {
							"description": "Whether or not automatically install `scoop` if not found and install packages from the list",
							"type": "boolean"
						},
						"packageList": {
							"description": "List of scoop packages",
							"type": "array",
							"uniqueItems": true,
							"items": {
								"type": "object",
								"required": ["packageName"],
								"properties": {
									"packageName": {
										"description": "Name of scoop package",
										"type": "string"
									},
									"packageScope": {
										"description": "Install specified package for AllUsers (global) or CurrentUser (local) only",
										"type": "string",
										"enum": ["global", "local"]
									}
								}
							}
						},
						"bucketList": {
							"description": "List of scoop buckets to add",
							"type": "array",
							"uniqueItems": true,
							"items": {
								"type": "object",
								"properties": {
									"bucketName": {
										"description": "Name of a scoop bucket",
										"type": "string"
									},
									"bucketRepo": {
										"description": "Repository URL of a scoop bucket",
										"type": "string"
									}
								}
							}
						},
						"additionalArgs": {
							"description": "Extra arguments passed in for `scoop install [package]` command",
							"type": "array",
							"uniqueItems": true,
							"items": {
								"type": "string"
							}
						}
					}
				}
			}
		},
		"packageAddon": {
			"description": "Define extra addons for an installed package/application/tool",
			"type": "array",
			"uniqueItems": true,
			"items": {
				"type": "object",
				"required": ["commandName", "commandCheck", "commandInvoke", "addonList", "install"],
				"properties": {
					"install": {
						"description": "Whether or not to install the addons' list of a package",
						"type": "boolean"
					},
					"commandName": {
						"description": "Command (application) which to use to install addons to",
						"type": "string"
					},
					"commandCheck": {
						"description": "Command to check if an addon is installed or not",
						"type": "string"
					},
					"commandInvoke": {
						"description": "Command to invoke to install a specified addon from the list",
						"type": "string"
					},
					"addonList": {
						"description": "List of addons to install",
						"type": "array",
						"uniqueItems": true,
						"items": {
							"type": "string"
						}
					}
				}
			}
		},
		"powershell": {
			"description": "PowerShell Configuration (Modules + ...)",
			"type": "object",
			"required": ["psmodule", "psexperimentalfeature"],
			"properties": {
				"psmodule": {
					"description": "PowerShell Modules",
					"type": "object",
					"required": ["install", "moduleList", "additionalArgs"],
					"properties": {
						"install": {
							"description": "Whether or not to install the PowerShell modules in the list",
							"type": "boolean"
						},
						"moduleList": {
							"description": "List of PowerShell modules to install on the machine",
							"type": "array",
							"uniqueItems": true,
							"items": {
								"type": "object",
								"required": ["moduleName"],
								"properties": {
									"moduleName": {
										"description": "Name of the PowerShell Module",
										"type": "string"
									},
									"moduleVersion": {
										"description": "Version of the PowerShell Module",
										"type": "string"
									}
								}
							}
						},
						"additionalArgs": {
							"description": "Extra arguments passed in for `Install-Module [module name]` command",
							"type": "array",
							"uniqueItems": true,
							"items": {
								"type": "string"
							}
						}
					}
				},
				"psexperimentalfeature": {
					"description": "PowerShell Experimental Features",
					"type": "object",
					"required": ["enable", "featureList"],
					"properties": {
						"enable": {
							"description": "Whether or not to enable PowerShell Experimental Feature(s) defined in the list",
							"type": "boolean"
						},
						"featureList": {
							"description": "List of PowerShell Experimental Features to enable",
							"type": "array",
							"uniqueItems": true,
							"items": {
								"description": "Name of the PowerShell Experimental Features",
								"type": "string"
							}
						}
					}
				}
			}
		},
		"environmentVariable": {
			"description": "Define user environment variables and add them to the machine",
			"type": "array",
			"uniqueItems": true,
			"items": {
				"type": "object",
				"properties": {
					"commandName": {
						"description": "The command which will use this environment variable",
						"type": "string"
					},
					"environmentKey": {
						"description": "Environment variable key of specified command",
						"type": "string"
					},
					"environmentValue": {
						"description": "Value inherits from the specified `environmentKey`",
						"type": "string"
					}
				}
			}
		}
	}
}