rougail/doc/check/function.md

# Fonction de vérification

## Vérification stricte des valeurs

Une fonction de vérification est une fonction complémentaire au type qui permet de valider plus précisement le contenu d'une variable.

Voici un exemple simple de validation des valeurs :

```yml
---
version: '1.0'
my_variable:
  validators:
    - type: jinja
      jinja: |+
        {% if rougail.my_variable and not rougail.my_variable.islower() %}
        {{ rougail.my_variable }} is not lowercase string
        {% endif %}
```

Une fonction de vérification doit prendre en compte 2 aspects important :

- la valeur peut ne pas être renseigné (même si la variable est obligatoire), la valeur None doit être prise en compte
- si la valeur est invalide, il faut renvoyer une phrase avec un message explicite.

À partir de maintenant seule None et des valeurs en minuscule seront autorisés.

Il est possible de définir des [paramètres](../param/README.md) à cette fonction.

## Vérification des valeurs avec avertissement

Dans la contrainte, il est possible de spécifier le niveau d'erreur et le mettre en avertissement :

```yml
---
version: '1.0'
my_variable:
  validators:
    - type: jinja
      jinja: |+
        {% if rougail.my_variable and not rougail.my_variable.islower() %}
        {{ rougail.my_variable }} is not lowercase string
        {% endif %}
      params:
        warning: true
```

Dans ce cas une valeur avec une majuscule sera accepté, mais un message d'avertissement apparaitra.