schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {
    "plugin-list": {
      "oneOf": [
        {
          "type": "array",
          "minItems": 1,
          "additionalProperties": false,
          "items": {
            "$ref": "#/$defs/plugin"
          }
        },
        {
          "$ref": "#/$defs/plugin"
        }
      ]
    },
    "plugin": {
      "type": "object",
      "oneOf": [
        {
          "$ref": "#/$defs/link"
        },
        {
          "$ref": "#/$defs/create"
        },
        {
          "$ref": "#/$defs/clean"
        },
        {
          "$ref": "#/$defs/shell"
        },
        {
          "$ref": "#/$defs/git"
        },
        {
          "$ref": "#/$defs/group"
        },
        {
          "$ref": "#/$defs/package"
        },
        {
          "$ref": "#/$defs/install"
        },
        {
          "$ref": "#/$defs/download"
        },
        {
          "$ref": "#/$defs/sharkdp"
        },
        {
          "$ref": "#/$defs/if"
        },
        {
          "$ref": "#/$defs/system"
        },
        {
          "$ref": "#/$defs/vars"
        },
        {
          "$ref": "#/$defs/extract"
        }
      ]
    },
    "dotbot": {
      "type": "object",
      "required": [
        "config"
      ],
      "properties": {
        "config": {
          "$ref": "#/$defs/plugin-list"
        },
        "profiles": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/nested-string-array"
          }
        },
        "default_profile": {
          "type": ["object", "array"],
          "minItems": 1,
          "items": {
            "type": ["string", "object"]
          }
        },
        "update_repo": {
          "type": "boolean",
          "description": "Pull dotfiles repository each time you run dotbot",
          "default": true
        },
        "update_dotbot": {
          "type": "boolean",
          "description": "Check and update dotbot automatically if a new version is available",
          "default": true
        },
        "show_total_time": {
          "type": "boolean",
          "description": "Prints out total time taken to run config",
          "default": true
        },
        "strip_path": {
          "type": ["boolean", "array"],
          "description": "Strip specified paths from PATH environment variable, particularly effective for WSL distros, setting it to `true` will exclude `/mnt/c`",
          "default": false,
          "minItems": 1,
          "items": {
            "type": "string"
          }
        },
        "vars": {
          "type": "object",
          "description": "Key-value pairs that are added to the template namespace",
          "properties": {
            "type": "string"
          }
        }
      }
    },
    "link": {
      "type": "object",
      "required": [
        "link"
      ],
      "properties": {
        "link": {
          "oneOf": [
            {
              "$ref": "#/$defs/link-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/link-config"
              }
            }
          ]
        }
      }
    },
    "link-config": {
      "type": "object",
      "additionalProperties": {
        "type": [
          "object",
          "string"
        ],
        "required": [
          "source"
        ],
        "properties": {
          "source": {
            "type": "string"
          },
          "mkdirs": {
            "type": "boolean",
            "default": true
          },
          "force": {
            "type": "boolean",
            "default": false,
            "description": "Overwrite target file if it exists"
          },
          "safe_force": {
            "type": "boolean",
            "default": false,
            "description": "Will rename the target file instead of overwriting it"
          }
        }
      }
    },
    "create": {
      "type": "object",
      "required": [
        "create"
      ],
      "properties": {
        "create": {
          "oneOf": [
            {
              "$ref": "#/$defs/create-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/create-config"
              }
            }
          ]
        }
      }
    },
    "create-config": {
      "type": [
        "object",
        "string"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "number",
          "null"
        ],
        "required": false,
        "properties": {
          "mode": {
            "type": "number"
          }
        }
      }
    },
    "clean": {
      "type": "object",
      "required": [
        "clean"
      ],
      "properties": {
        "clean": {
          "oneOf": [
            {
              "$ref": "#/$defs/clean-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/clean-config"
              }
            }
          ]
        }
      }
    },
    "clean-config": {
      "type": [
        "object",
        "string"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ],
        "required": false,
        "properties": {
          "force": {
            "type": "boolean",
            "default": false
          },
          "recursive": {
            "type": "boolean",
            "default": false
          }
        }
      }
    },
    "shell": {
      "type": "object",
      "required": [
        "shell"
      ],
      "properties": {
        "shell": {
          "oneOf": [
            {
              "$ref": "#/$defs/shell-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/shell-config"
              }
            }
          ]
        }
      }
    },
    "shell-config": {
      "type": "object",
      "properties": {
        "desc": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "const": false
            }
          ]
        },
        "command": {
          "type": "string"
        },
        "shell": {
          "type": "boolean",
          "default": true
        },
        "stdin": {
          "type": "boolean",
          "default": false
        },
        "stdout": {
          "type": "boolean",
          "default": true
        },
        "stderr": {
          "type": "boolean",
          "default": true
        },
        "capture": {
          "type": "boolean",
          "default": false
        },
        "sudo": {
          "type": "boolean",
          "default": false
        },
        "try_sudo": {
          "type": "boolean",
          "default": false
        }
      }
    },
    "git": {
      "type": "object",
      "required": [
        "git"
      ],
      "properties": {
        "git": {
          "oneOf": [
            {
              "$ref": "#/$defs/git-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/git-config"
              }
            }
          ]
        }
      }
    },
    "git-config": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "required": [
          "url"
        ],
        "properties": {
          "url": {
            "type": "string"
          },
          "desc": {
            "type": "string"
          },
          "method": {
            "type": "string",
            "enum": [
              "clone",
              "pull",
              "clone_pull"
            ],
            "default": "clone_pull"
          }
        }
      }
    },
    "group": {
      "type": "object",
      "required": [
        "group"
      ],
      "properties": {
        "group": {
          "oneOf": [
            {
              "$ref": "#/$defs/group-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/group-config"
              }
            }
          ]
        }
      }
    },
    "group-config": {
      "type": [
        "object",
        "string"
      ],
      "additionalProperties": {
        "$ref": "#/$defs/plugin-list"
      }
    },
    "package": {
      "type": "object",
      "required": [
        "package"
      ],
      "properties": {
        "package": {
          "oneOf": [
            {
              "$ref": "#/$defs/package-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/package-config"
              }
            }
          ]
        }
      }
    },
    "package-config": {
      "type": [
        "object",
        "string"
      ],
      "properties": {
        "apt": {
          "$ref": "#/$defs/package-item"
        },
        "apk": {
          "$ref": "#/$defs/package-item"
        }
      }
    },
    "package-item": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "install": {
      "type": "object",
      "required": [
        "install"
      ],
      "properties": {
        "install": {
          "oneOf": [
            {
              "$ref": "#/$defs/install-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/install-config"
              }
            }
          ]
        }
      }
    },
    "install-config": {
      "type": [
        "object",
        "string"
      ],
      "required": [
        "url"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "version": {
          "type": ["string", "object"],
          "properties": {
            "url": {
              "type": "string"
            },
            "regex": {
              "type": "string"
            }
          }
        },
        "sudo": {
          "type": "boolean",
          "default": false
        },
        "try_sudo": {
          "type": "boolean",
          "default": false
        },
        "download": {
          "type": "object",
          "required": [
            "url"
          ],
          "properties": {
            "name": {
              "type": "string"
            },
            "url": {
              "type": "string"
            },
            "path": {
              "type": "string"
            },
            "force": {
              "type": "boolean",
              "default": false
            },
            "mkdirs": {
              "type": "boolean",
              "default": true
            },
            "mode": {
              "$ref": "#/$defs/file-mode"
            },
            "extract": {
              "$ref": "#/$defs/extract-base"
            }
          }
        },
        "shell": {
          "$ref": "#/$defs/shell-config"
        },
        "then": {
          "$ref": "#/$defs/plugin-list"
        }
      },
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ],
        "required": false,
        "properties": {
          "force": {
            "type": "boolean",
            "default": false
          },
          "recursive": {
            "type": "boolean",
            "default": false
          }
        }
      }
    },
    "download": {
      "type": "object",
      "required": [
        "download"
      ],
      "properties": {
        "download": {
          "oneOf": [
            {
              "$ref": "#/$defs/download-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/download-config"
              }
            }
          ]
        }
      }
    },
    "download-config": {
      "type": "object",
      "additionalProperties": {
        "type": [
          "object",
          "string"
        ],
        "required": [
          "url"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "force": {
            "type": "boolean",
            "default": false
          },
          "mkdirs": {
            "type": "boolean",
            "default": true
          },
          "mode": {
            "$ref": "#/$defs/file-mode"
          },
          "extract": {
            "$ref": "#/$defs/extract-base"
          }
        }
      }
    },
    "sharkdp": {
      "type": "object",
      "required": [
        "sharkdp"
      ],
      "properties": {
        "sharkdp": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "type": "string"
              }
            }
          ]
        }
      }
    },
    "if": {
      "type": "object",
      "required": [
        "if"
      ],
      "properties": {
        "if": {
          "oneOf": [
            {
              "$ref": "#/$defs/if-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/if-config"
              }
            }
          ]
        }
      }
    },
    "if-config": {
      "type": "object",
      "required": [
        "condition"
      ],
      "properties": {
        "condition": {
          "$ref": "#/$defs/nested-string-array"
        },
        "then": {
          "$ref": "#/$defs/plugin-list"
        },
        "else": {
          "$ref": "#/$defs/plugin-list"
        }
      }
    },
    "system": {
      "type": "object",
      "required": [
        "system"
      ],
      "properties": {
        "system": {
          "oneOf": [
            {
              "$ref": "#/$defs/system-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/system-config"
              }
            }
          ]
        }
      }
    },
    "system-config-os": {
      "type": "string",
      "enum": ["windows", "linux", "darwin", "freebsd", "openbsd", "netbsd", "plan9", "solaris", "android"]
    },
    "system-config-arch": {
      "type": "string",
      "enum": ["amd64", "386", "arm64", "arm"]
    },
    "system-config-libc": {
      "type": "string",
      "enum": ["gnu", "musl"]
    },
    "system-config": {
      "type": "object",
      "properties": {
        "os": {
          "oneOf": [
            {
              "$ref": "#/$defs/system-config-os"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/system-config-os"
              }
            }
          ]
        },
        "arch": {
          "oneOf": [
            {
              "$ref": "#/$defs/system-config-arch"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/system-config-arch"
              }
            }
          ]
        },
        "platform": {
          "type": ["string", "array"]
        },
        "family": {
          "type": ["string", "array"],
          "description": "Group the distro belongs to e.g. ubuntu is part of the debian family"
        },
        "libc": {
          "oneOf": [
            {
              "$ref": "#/$defs/system-config-libc"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/system-config-libc"
              }
            }
          ]
        },
        "distro": {
          "type": ["string", "array"],
          "description": "The distro name e.g. kali"
        },
        "is_root": {
          "type": "boolean"
        },
        "can_sudo": {
          "type": "boolean",
          "description": "True if the user is allowed to use the sudo command"
        },
        "then": {
          "$ref": "#/$defs/plugin-list"
        }
      }
    },
    "vars": {
      "type": "object",
      "required": [
        "vars"
      ],
      "properties": {
        "vars": {
          "oneOf": [
            {
              "$ref": "#/$defs/vars-config"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/vars-config"
              }
            }
          ]
        }
      }
    },
    "vars-config": {
      "type": "object"
    },
    "extract": {
      "type": "object",
      "required": [
        "extract"
      ],
      "properties": {
        "extract": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/extract-base"
          }
        }
      }
    },
    "extract-base": {
      "oneOf": [
        {
          "$ref": "#/$defs/extract-config"
        },
        {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "#/$defs/extract-config"
          }
        }
      ]
    },
    "extract-config": {
      "type": "object",
      "additionalProperties": {
        "type": [
          "object",
          "string"
        ],
        "required": [
          "path"
        ],
        "properties": {
          "path": {
            "type": "string"
          },
          "strip": {
            "type": "integer",
            "default": 0
          },
          "replace": {
            "type": "boolean",
            "default": false,
            "description": "Will delete the destination before extracting to it"
          }
        }
      }
    },
    "file-mode": {
      "type": [
        "integer",
        "string"
      ]
    },
    "nested-string-array": {
      "type": ["string", "array"],
      "minItems": 1,
      "items": {
        "$ref": "#/$defs/nested-string-array"
      }
    }
  },
  "oneOf": [
    {
      "$ref": "#/$defs/plugin-list"
    },
    {
      "$ref": "#/$defs/dotbot"
    }
  ]
}