• DESCRIPTION :

~progression_qc~ est un compilateur/validateur pour la production de d'exercices pour [[https://progression.pages.dti.crosemont.quebec/progression_backend/][Progression]]. ~progression_qc~ reçoit sur l'entrée standard ou en paramètre un fichier YAML contenant la description d'une question et reproduit sur la sortie standard le résultat traité et validé.

• UTILISATION :

  ~progression_qc [-h|--help|-V]~

  ~progression_qc [-q|--quiet|-v|--verbose] [-j|--json] [--strict] [fichier]~

Où ~fichier~ est le chemin d'accès du fichier YAML composant l'exercice (~info.yml~ dans [[https://progression.pages.dti.crosemont.quebec/documentation/contenu/structure_exercice.html][documentation des exercices]]). En son absence, le contenu est récupéré depuis ~/dev/stdin~.

~-h, --help~ : affiche cette page d'aide.

~-V~ : affiche la version.

• OPTIONS :

  ~-j, --json~ : affiche le résultat et les erreurs/avertissements de validation en format JSON. Par défaut, le résultat est affiché en YAML et les erreurs/avertissements de la validation est en format humainement lisible.

  ~-q, --quiet~ : ne produit aucun affichage.

  ~--v, --verbose~ : affiche plus d'information.

  ~--strict~ : l'exercice n'est considéré valide que si aucune erreur ni avertissement n'a été produit.

• RETOUR :

  • 0 : l'exercice est valide. Des avertissements peuvent avoir été produits si le drapeau ~--strict~ n'a pas été utilisé.
  • 1 : l'exercice n'est pas valide. Des erreurs ont été produites.
  • 2 : l'exercice est valide mais des avertissements ont été produits et le drapeau ~--strict~ a été utilisé.
  • 255 : Erreur de lecture du fichier

• EXEMPLES :

  Valider la question contenue dans le fichier ~mesquestion/maquestion/info.yml~ en format humainement lisible :

  ~progression_qc ./mesquestions/maquestion/info.yml~

  Valider la question contenue dans le fichier ~mesquestion/maquestion/info.yml~ en format JSON :

  ~progression_qc --json ./mesquestions/maquestion/info.yml~

• COPYRIGHT :

Copyright © 2021. License GPLv3+: GNU GPL version 3 or later https://gnu.org/licenses/gpl.html.

This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.