Prickle

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

Фаворк

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

Почему это называется укол? 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, который может быть использован для отображения значения объекта по умолчанию. Как и комментарии, декораторы не влияют на то, как разбирается файл, они только описывают, как будет разбираться свойство.

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

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

Спонсоры

Проект спонсируется компанией Nodecraft. Используйте DARKHAX на 30% скидку за первый месяц работы! (DARKHAX)