Aller au contenu

Les options

Les options sont un ensemble de paramètres définis de manière globale dans un script. Elles permettent de faciliter la configuration d'un script pour modifier son fonctionnement.

Définir une option

Pour créer une option, il suffit de l'inclure dans un bloc définit par options: :

options:
    mon_option: 5

Une option peut prendre n'importe quelle valeur, il peut également s'agir d'un tableau, ou de n'importe quel type de variable, tant qu'elle peut être définie en dehors d'un contexte d'exécution.

Warning

Le nom de l'option ne doit pas contenir d'espaces ni de caractères spéciaux. Il ne peut être constitué que par des lettres non accentuées, des nombres ou l'underscore _.

Obtenir la valeur d'une option

Pour récupérer la valeur d'une option, il suffit d'utiliser l'arobase @ suivie du nom de l'option :

options:
    mon_option: 5

on script load:
    print @mon_option #Affiche 5
Retour en haut de la page