toolkits.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Schema for the toolkit manifest, detailing the installation process for various toolkits on Mac/Windows/Linux OS.",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Brief overview of the toolkit manifest."
    },
    "version": {
      "type": "string",
      "description": "Version of the toolkit manifest."
    },
    "author": {
      "type": "string",
      "description": "Author of the toolkit manifest."
    },
    "toolkits": {
      "type": "array",
      "description": "The list of toolkits to be installed by the toolkit.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the tool."
          },
          "description": {
            "type": "string",
            "description": "Brief description of the tool."
          },
          "installations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "os": {
                  "type": "string",
                  "enum": [
                    "macos",
                    "windows",
                    "linux"
                  ],
                  "description": "Operating system for which the tool is to be installed."
                },
                "arch": {
                  "type": "string",
                  "enum": [
                    "x86_64",
                    "aarch64"
                  ],
                  "description": "Architecture for which the tool is to be installed."
                },
                "id": {
                  "type": "string",
                  "description": "The ID of the tool which is used to identify whether the tool is installed or not. For example, 'brew' for Homebrew, 'Visual Studio Code.app' for Visual Studio Code, etc."
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "dmg",
                    "zip",
                    "exe",
                    "shell",
                    "deb"
                  ],
                  "description": "Type of the installation tool. Toolkit will use different methods to install the package based on the type."
                },
                "source": {
                  "type": "string",
                  "description": "The Source which how to download and install the tool."
                },
                "postInstall": {
                  "type": "string",
                  "description": "The command to run after the installation of the tool."
                }
              },
              "required": [
                "os",
                "id",
                "type",
                "source"
              ]
            }
          }
        }
      }
    }
  }
}