forgevsc.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ForgeVSC Config",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "customFunctionPaths": {
      "type": ["string", "array"],
      "items": {
        "type": "string"
      },
      "default": [],
      "uniqueItems": true,
      "description": "Path(s) to your custom functions folder(s). This is used to generate metadata and to provide full extension feature support for your custom functions."
    },
    "additionalPackages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "description": "Additional packages/extensions to fetch metadata from. By default, installed Forge packages are detected automatically. This property is only needed if metadata fetching fails or you want to include extra packages."
    },
    "colors": {
      "type": "object",
      "additionalProperties": false,
      "description": "The individual highlight colors used for syntax highlighting.",
      "properties": {
        "function": {
          "type": "object",
          "additionalProperties": false,
          "description": "The highlight colors used for single function parts.",
          "properties": {
            "name": {
              "type": "string",
              "default": "#AC75FF",
              "description": "The highlight color used for function names.",
              "pattern": "^(?:#?(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?))?$",
              "errorMessage": "Input must be a valid hex color, e.g. #AC75FF"
            },
            "dollar": {
              "type": "string",
              "default": "#FE7CEB",
              "description": "The highlight color used for function dollar signs ($).",
              "pattern": "^(?:#?(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?))?$",
              "errorMessage": "Input must be a valid hex color, e.g. #FE7CEB"
            },
            "semicolon": {
              "type": "string",
              "default": "#C586C0",
              "description": "The highlight color used for function semicolons (;).",
              "pattern": "^(?:#?(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?))?$",
              "errorMessage": "Input must be a valid hex color, e.g. #C586C0"
            }
          }
        },
        "arguments": {
          "type": "object",
          "additionalProperties": false,
          "description": "The highlight colors used for function argument parts.",
          "properties": {
            "condition": {
              "type": "string",
              "default": "#4FC1FF",
              "description": "The highlight color used for argument condition operators.",
              "pattern": "^(?:#?(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?))?$",
              "errorMessage": "Input must be a valid hex color, e.g. #4FC1FF"
            }
          }
        },
        "operators": {
          "type": "object",
          "additionalProperties": false,
          "description": "The highlight colors used for function operators.",
          "properties": {
            "negation": {
              "type": "string",
              "default": "#4FA3FF",
              "description": "The highlight color used for the negation operator (!).",
              "pattern": "^(?:#?(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?))?$",
              "errorMessage": "Input must be a valid hex color, e.g. #4FA3FF"
            },
            "silent": {
              "type": "string",
              "default": "#FF9F43",
              "description": "The highlight color used for the silent operator (#).",
              "pattern": "^(?:#?(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?))?$",
              "errorMessage": "Input must be a valid hex color, e.g. #FF9F43"
            },
            "count": {
              "type": "string",
              "default": "#33D17A",
              "description": "The highlight color used for the count operator (@[x]).",
              "pattern": "^(?:#?(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?))?$",
              "errorMessage": "Input must be a valid hex color, e.g. #33D17A"
            },
            "countDelimiter": {
              "type": "string",
              "default": "#76E3A0",
              "description": "The highlight color used for the count operator delimiter (separator).",
              "pattern": "^(?:#?(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?))?$",
              "errorMessage": "Input must be a valid hex color, e.g. #76E3A0"
            }
          }
        }
      }
    },
    "features": {
      "type": "object",
      "additionalProperties": false,
      "description": "The default features included within the extension. You can choose individually which ones to enable or disable.",
      "properties": {
        "folding": {
          "type": "boolean",
          "default": true,
          "description": "Whether folding for multi-line function contents should be enabled."
        },
        "hoverInfo": {
          "type": "boolean",
          "default": true,
          "description": "Whether hover info cards for functions and operators should be enabled."
        },
        "suggestions": {
          "type": "boolean",
          "default": true,
          "description": "Whether suggestions for bracket placement should be enabled."
        },
        "signatureHelp": {
          "type": "boolean",
          "default": true,
          "description": "Whether signature help for function arguments should be enabled."
        },
        "diagnostics": {
          "type": "boolean",
          "default": true,
          "description": "Whether diagnostics for function validation should be enabled."
        },
        "autocompletion": {
          "type": "boolean",
          "default": true,
          "description": "Whether autocompletion for functions and arguments should be enabled."
        }
      }
    }
  }
}