settings-schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "JSON Schema for settings.json",
  "$id": "https://raw.githubusercontent.com/electric-package-manager/electric/master/settings-schema.json",
  "version": 1.0,
  "type": "object",
  "description": "Provides autocompletion and validation for settings.json files",
  "properties": {
    "showProgressBar": {
      "type": "boolean",
      "description": "Whether or not electric should show a progress bar during installation"
    },
    "progressBarType": {
      "type": "string",
      "description": "Type of progress bar to display during installation",
      "oneOf": [
        {
          "const": "accented",
          "description": "Display a clean progress bar with accents"
        },
        {
          "const": "zippy",
          "description": "Display a fast and zippy looking progress bar"
        }
      ]
    },
    "electrifyProgressBar": {
      "type": "boolean",
      "description": "Whether or not to electrify the electric progress bar"
    },
    "useCustomProgressBar": {
      "type": "boolean",
      "description": "Whether or not to use a custom progress bar defined by the \"customProgressBar\" object"
    },
    "customProgressBar": {
      "type": "object",
      "description": "A custom progress bar to be displayed by electric",
      "properties": {
        "start_character": {
          "type": "string",
          "description": "A custom character which appears at the beginning of the progress bar"
        },
        "end_character": {
          "type": "string",
          "description": "A custom character which appears at the end of the progress bar"
        },
        "fill_character": {
          "type": "string",
          "description": "A custom character for the progress bar to fill whitespaces with."
        },
        "unfill_character": {
          "type": "string",
          "description": "A custom character for the progress bar to display instead of whitespaces."
        },
        "fill_character_color": {
          "type": "string",
          "description": "A custom color for the fill character.",
          "oneOf": [
            {
              "const": "red"
            },
            {
              "const": "green"
            },
            {
              "const": "blue"
            },
            {
              "const": "magenta"
            },
            {
              "const": "cyan"
            },
            {
              "const": "white"
            },
            {
              "const": "lightblack_ex"
            },
            {
              "const": "lightred_ex"
            },
            {
              "const": "lightgreen_ex"
            },
            {
              "const": "lightyellow_ex"
            },
            {
              "const": "lightblue_ex"
            },
            {
              "const": "lightmagenta_ex"
            },
            {
              "const": "lightcyan_ex"
            },
            {
              "const": "lightwhite_ex"
            }
          ]
        },
        "unfill_character_color": {
          "type": "string",
          "description": "A custom color for the unfill character.",
          "oneOf": [
            {
              "const": "red"
            },
            {
              "const": "green"
            },
            {
              "const": "blue"
            },
            {
              "const": "magenta"
            },
            {
              "const": "cyan"
            },
            {
              "const": "white"
            },
            {
              "const": "lightblack_ex"
            },
            {
              "const": "lightred_ex"
            },
            {
              "const": "lightgreen_ex"
            },
            {
              "const": "lightyellow_ex"
            },
            {
              "const": "lightblue_ex"
            },
            {
              "const": "lightmagenta_ex"
            },
            {
              "const": "lightcyan_ex"
            },
            {
              "const": "lightwhite_ex"
            }
          ]
        }
      }
    },
    "installMetrics": {
      "type": "boolean",
      "description": "Whether or not electric should increment a counter on the number of installs of a certain software"
    }
  }
}