paths.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "title": "Advent of Code solution paths manifest",
  "description": "A manifest describing where the main sources for each day are located.",
  "definitions": {
    "lang": {
      "type": "object",
      "properties": {
        "codemirror": {
          "type": "string",
          "description": "The CodeMirror language mode of the implementation language",
          "examples": [
            "apl", "asn.1", "asterisk", "brainfuck", "clike", "clojure", "css",
            "cmake", "cobol", "coffeescript", "commonlisp", "crystal", "cypher",
            "python", "d", "dart", "django", "dockerfile", "diff", "dtd",
            "dylan", "ebnf", "ecl", "eiffel", "elixir", "elm", "erlang",
            "factor", "fcl", "forth", "fortran", "mllike", "gas", "gherkin",
            "go", "groovy", "haml", "handlebars", "haskell", "haxe",
            "htmlembedded", "htmlmixed", "idl", "javascript", "jinja2", "julia",
            "livescript", "lua", "markdown", "mathematica", "mbox", "mirc",
            "modelica", "mscgen", "mumps", "nginx", "nsis", "ntriples",
            "octave", "oz", "pascal", "pegjs", "perl", "asciiarmor", "php",
            "pig", "powershell", "properties", "protobuf", "pug", "puppet", "q",
            "r", "rpm", "rst", "ruby", "rust", "sas", "sass", "spreadsheet",
            "scheme", "shell", "sieve", "slim", "smalltalk", "smarty", "solr",
            "soy", "stylus", "sql", "sparql", "swift", "stex", "tcl", "textile",
            "tiddlywiki", "tiki", "toml", "tornado", "troff", "ttcn",
            "ttcn-cfg", "turtle", "twig", "vb", "vbscript", "velocity",
            "verilog", "vhdl", "vue", "webidl", "wast", "xml", "xquery",
            "yacas", "yaml", "yaml-frontmatter", "z80"
          ]
        },
        "name": {
          "type": "string",
          "description": "The human-readable name of the language."
        }
      },
      "required": ["name"]
    },
    "solution": {
      "type": ["object", "null"],
      "description": "A solution.",
      "properties": {
        "lang": {
          "$ref": "#/definitions/lang"
        },
        "path": {
          "type": "string",
          "description": "The path to the main source file"
        },
        "encoding": {
          "type": "string",
          "default": "utf-8",
          "description": "Optionally a custom text encoding that the file uses (e.g. because the compiler/interpreter/IDE only supports the given encoding). See https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder/encoding#value for values.",
          "examples": [
            "utf-8", "ibm866", "iso-8859-2", "iso-8859-3", "iso-8859-4",
            "iso-8859-5", "iso-8859-6", "iso-8859-7", "iso-8859-8",
            "iso-8859-8i", "iso-8859-10", "iso-8859-13", "iso-8859-14",
            "iso-8859-15", "iso-8859-16", "koi8-r", "koi8-u", "macintosh",
            "windows-874", "windows-1250", "windows-1251", "windows-1252",
            "windows-1253", "windows-1254", "windows-1255", "windows-1256",
            "windows-1257", "windows-1258", "x-mac-cyrillic", "utf16-be",
            "utf16-le", "replacement"
          ]
        },
        "binary": {
          "type": "boolean",
          "description": "Whether the file is in a binary (i.e. non-text) format.",
          "default": false
        },
        "additionalNotes": {
          "type": "string",
          "description": "Additional notes to be added to the README."
        }
      },
      "required": ["path"]
    },
    "day": {
      "description": "The solutions for a day.",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "completed": {
              "type": "boolean",
              "description": "Whether the day has been completed (fully).",
              "default": false
            }
          }
        },
        {
          "anyOf": [
            {
              "$ref": "#/definitions/solution"
            },
            {
              "type": "object",
              "properties": {
                "parts": {
                  "type": "array",
                  "items": {
                    "$ref": "#/definitions/solution"
                  }
                }
              },
              "required": ["parts"]
            }
          ]
        }
      ]
    }
  },
  "type": "array",
  "items": {
    "$ref": "#/definitions/day"
  }
}