yaml optimize

yaml-optimiser

YAML Optimiser est une bibliothèque et un ensemble d'outils de ligne de commande écrits en C ++. La bibliothèque aide à optimiser les grandes configurations YAML à l'aide d'alias (ancres), de références et de touches de fusion (remplacements). Il exploite la bibliothèque RapidyAml pour l'analyse et la manipulation YAML.

Le projet vise à fournir un moyen rapide et pratique d'optimiser les grandes configurations YAML.

Dépendances

• RapidyAml: un analyseur YAML rapide et émetteur pour C ++.
• Lyra: un analyseur d'arguments de ligne de commande simple à utiliser, en composition, en tête uniquement pour C ++ 11 et au-delà.
• FMT: Une bibliothèque de formatage offrant une alternative rapide et sûre à C STdio et C ++ IoStreams.

Exemples

Actuellement, la bibliothèque prend en charge uniquement l'optimisation des nœuds entièrement identiques:

 # 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

Le résultat serait donc (notez que les indentations et les commentaires sont actuellement supprimés):

- 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 

Feuille de route

• Remplacez les blocs identiques par des ancres au premier
• Remplacer des blocs similaires par des touches de fusion
• Préservez les commentaires et l'espacement du document d'origine (?). Aussi, préservez le format de bloc / débit.

Installation

L'installation est assez facile. Tout d'abord, clone le repo, téléchargeant ses sous-modules récursivement:

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

Si vous voulez seulement tester les fonctionnalités du repo, ce peut être une bonne idée de cloner uniquement le haut du référentiel:

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

Ensuite, dans le répertoire Repo, générez le projet avec CMake:

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

Ici, vous voyez les drapeaux qui peuvent être utilisés lors de la construction de la bibliothèque YAML-Optimize. Yo_build_tools et yo_build_tests sont 0 par défaut, car je veux que la construction soit minime. Si vous cochez l'option yo_build_tools, les outils yaml-optimize et yaml-résive sont construits:

 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

Maintenant, nous pouvons construire le projet:

cmake --build build -j8 --config Debug