Prickle

Prickle — это основанный на JSON формат конфигурации. Этот мод позволяет использовать данный формат в Minecraft! Техническую документацию смотрите на странице GitHub.

FaQ

Какие преимущества даёт Prickle?
Prickle основан на JSON, но добавляет несколько полезных возможностей, таких как комментарии и декораторы. Prickle на 100% обратно совместим с JSON и поддерживает все его функции, инструменты и подсветку синтаксиса.

Почему он называется Prickle?
Prickle — это собирательное существительное для группы ежей. Ежи — одни из моих любимых животных, и, по-моему, они отлично подходят в качестве метафоры для конфигурационных файлов. Например, и те, и другие поначалу могут казаться пугающими, но становятся приятными, когда узнаёшь и понимаешь их.

Почему бы не использовать существующий формат?
В прошлом я использовал JSON для своих конфигурационных файлов, но было несколько проблем, таких как отсутствие комментариев и значений по умолчанию. Prickle добавляет эти возможности в JSON, оставаясь на 100% обратно совместимым. Я пробовал другие форматы, например TOML, но был разочарован многими их реализациями на Java. Им часто не хватает функций, которые я считаю важными, в них есть серьёзные баги, и их больше не поддерживают. Minecraft уже использует JSON для датапаков и команд, что делает его привычным выбором для большинства игроков.

Спецификации формата

В Prickle значения свойств оборачиваются в объект JSON. Это позволяет приписывать свойству метаданные, такие как комментарии.

Например, стандартный JSON-файл выглядел бы так.

{
  "database_host": "192.168.1.222"
}

Тот же JSON в виде файла Prickle выглядел бы так.

{
  "database_host": {
    "//": "The IP address of the database to connect to.",
    "value": "192.168.1.222"
  }
}

Комментарии

Ключ // зарезервирован для комментариев. Комментарии используются только для предоставления читателю дополнительного контекста и никогда не должны влиять на то, как парсится файл. Комментарии могут быть строкой JSON или массивом строк для многострочных комментариев.

{
  "database_host": {
    "//": [
      "The IP address of the database to connect to.",
      "The port can be defined at the end using an :"
    ],
    "value": "192.168.1.222:1273"
  }
}

Декораторы

Декораторы — это именованные комментарии, которые передают определённый атрибут свойства. Распространённый пример декоратора — //default, который можно использовать для отображения значения свойства по умолчанию. Как и комментарии, декораторы не влияют на то, как парсится файл, они лишь описывают, как свойство будет распарсено.

В файлах prickle вы можете встретить некоторые из следующих декораторов.

• //default — значение свойства по умолчанию.
• //reference — ресурс, который можно использовать, чтобы узнать больше, например ссылка на страницу вики.
• //range — допустимый диапазон для значения. Например >=5.
• //regex — шаблон regex, которому должно соответствовать значение.
• //empty-allowed — может ли значение быть пустым или нет. (по умолчанию true).