configSchema.json

{
  "$schema": "http://json-schema.org/schema#",
  "$id": "http://raw.githubusercontent.com/nowarp/misti/master/configSchema.json",
  "title": "Misti configuration schema",
  "description": "JSON Schema for misti.config.json",
  "type": "object",
  "required": [
    "detectors"
  ],
  "properties": {
    "detectors": {
      "type": "array",
      "description": "List of Misti detectors to run, each potentially defined by a path and always by a class name. Built-in detectors don't have a path.",
      "items": {
        "type": "object",
        "properties": {
          "modulePath": {
            "type": "string",
            "description": "The file path of the detector module",
            "optional": true
          },
          "className": {
            "type": "string",
            "description": "The class name of the detector"
          }
        },
        "required": [
          "className"
        ],
        "additionalProperties": false
      }
    },
    "suppressions": {
      "type": "array",
      "description": "List of warning suppressions",
      "items": {
        "type": "object",
        "properties": {
          "detector": {
            "type": "string",
            "description": "The name of the detector"
          },
          "position": {
            "type": "string",
            "description": "The position of the suppression in the format 'fileName:line:column'"
          }
        },
        "required": [
          "detector",
          "position"
        ],
        "additionalProperties": false
      }
    },
    "ignoredProjects": {
      "type": "array",
      "description": "List of Tact projects that will be ignored by the analyzer",
      "items": {
        "type": "string"
      }
    },
    "soufflePath": {
      "type": "string",
      "description": "Directory to save generated Soufflé files. If not set, a temporary directory will be used.",
      "optional": true
    },
    "tactStdlibPath": {
      "type": "string",
      "description": "Path to Tact standard library. If not set, the default stdlib from the actual Tact setup will be used.",
      "optional": true
    },
    "unusedPrefix": {
      "type": "string",
      "description": "Identifiers starting with this prefix won't be reported as unused by built-in detectors.",
      "default": "_"
    },
    "verbosity": {
      "type": "string",
      "description": "Verbosity level of the logs output by the system.",
      "enum": [
        "quiet",
        "debug",
        "default"
      ],
      "default": "default"
    }
  }
}