yaml optimize

Yaml-Optimize

YAML Optimiser-это библиотека и набор инструментов командной строки, написанные в C ++. Библиотека помогает оптимизировать большие конфигурации YAML с использованием псевдонимов (якоря), ссылок и клавиш слияния (переопределения). Это использует библиотеку Rapidyaml для анализа и манипуляций YAML.

Проект направлен на то, чтобы обеспечить быстрый и удобный способ оптимизации больших конфигураций YAML.

Зависимости

• Rapidyaml: быстрый анализатор Yaml и излучатель для C ++.
• Lyra: простая в использовании, сочинение, только заголовок, анализатор аргументов командной строки для C ++ 11 и выше.
• FMT: библиотека форматирования, обеспечивающая быструю и безопасную альтернативу C Stdio и C ++ Iostreams.

Примеры

В настоящее время библиотека поддерживает только оптимизация полностью идентичных узлов:

 # YAML example with references and anchors

# Define an anchor for a nested sequence
- top_level :
    - nested :
        - - Apple
          - Orange
          - Banana

# Define an anchor for a nested mapping
- another_level :
    - even_deeper :
        - further :
            - key1 : value1
              key2 : value2

# Use the anchors in different parts of the YAML
- other_level :
    - some_key :
        - Apple
        - Orange
        - Banana
    - additional_key :
        key1 : value1
        key2 : value2

# Additional data
- SomeList :
    - 1
    - 2
    - 3
    - 4
- SomeValue : true

Таким образом, результатом будет (обратите внимание, что в настоящее время удалены отступления и комментарии):

- top_level :
    - nested :
        - &anchor_0
          - Apple
          - Orange
          - Banana
- another_level :
    - even_deeper :
        - further :
            - &anchor_1
              key1 : value1
              key2 : value2
- other_level :
    - some_key : *anchor_0
    - additional_key : *anchor_1
- SomeList :
    - 1
    - 2
    - 3
    - 4
- SomeValue : true 

Дорожная карта

• Заменить идентичные блоки на якоря на первое
• Заменить аналогичные блоки на ключи слияния
• Сохраните комментарии и интервал оригинального документа (?). Также сохранить формат блока/потока.

Установка

Установка довольно проста. Прежде всего, клонировать репо, рекурсивно загружая свои подмодули:

git clone https://github.com/Mr-S-Mirzoev/yaml-optimize.git --recursive

Если вы хотите только проверить функции репо, это может быть хорошей идеей клонировать только вершину репо:

git clone https://github.com/Mr-S-Mirzoev/yaml-optimize.git --recursive --depth=1

Затем, в каталоге репо, генерируйте проект с Cmake:

cmake -B build -DYO_BUILD_TOOLS=1 -DYO_BUILD_TESTS=1 -DCMAKE_BUILD_TYPE=Release

Здесь вы видите флаги, которые можно использовать при создании библиотеки YAML-Optimize. Yo_build_tools и yo_build_tests по умолчанию 0, так как я хочу, чтобы сборка была минимальной. Если вы отметите опцию yo_build_tools, инструменты yaml-optimize и yaml-resolve построены:

 USAGE:
  yaml-optimize [-?|-h|--help] [-l|--limit <optimization limit>] -i|--input <input> [-o|--output <output>] [-v|--verbose]

YAML Optimizer - A tool for optimising YAML configurations with the use of anchors, references and merge keys

OPTIONS, ARGUMENTS:
  -?, -h, --help          
  -l, --limit <optimization limit>
                          limit to when to stop optimisation
  -i, --input <input>     path to input file
  -o, --output <output>   path to output file (defaults to input filename + ".optimized")
  -v, --verbose           enable verbose mode

 USAGE:
  yaml-resolve [-?|-h|--help] -i|--input <input> [-o|--output <output>] [-v|--verbose]

YAML Resolver - A tool for resolving YAML optimised configurations with anchors, references, and merge keys, substituting them to obtain the complete YAML configuration

OPTIONS, ARGUMENTS:
  -?, -h, --help          
  -i, --input <input>     path to input file
  -o, --output <output>   path to output file (defaults to input filename + ".resolved")
  -v, --verbose           enable verbose mode

Теперь мы можем построить проект:

cmake --build build -j8 --config Debug