Formatteur YAML

Formatteur YAML — Description et aide

Cet outil permet de valider et formatter une chaîne YAML en ligne : indentation, retours à la ligne et mise en forme lisible.

Description

Le formateur YAML prend en entrée du texte (YAML minifié ou déjà partiellement formaté), vérifie qu’il s’agit de YAML valide, puis produit une version formatée avec indentation (2 espaces) et retours à la ligne. Idéal pour inspecter des fichiers de configuration (Docker Compose, Kubernetes, CI/CD), des paramètres d’application ou tout bloc YAML copié-collé. La sortie peut être copiée en un clic.

Comment faire

1. Collez ou saisissez votre YAML dans la zone de texte (ou déposez un fichier .yaml / .yml).
2. Cliquez sur « Formatter le YAML ».
3. Si le YAML est valide, le résultat formaté s’affiche dans le bloc ci-dessous avec indentation et retours à la ligne.
4. Utilisez le bouton « Copier » pour copier le YAML formaté dans le presse-papiers.
5. En cas d’erreur de syntaxe, un message indique la nature du problème (indentation, caractère inattendu, etc.).

Exemples

Entrée (compacte) :

name: Mon app
env: production
ports: [80, 443]

Sortie formatée :

name: Mon app
env: production
ports:
  - 80
  - 443

Avec listes et sous-clés :

server:
  host: 0.0.0.0
  port: 8080

devient une version indentée claire et lisible.

Qu’est-ce que le YAML ?

YAML (YAML Ain’t Markup Language) est un format de sérialisation de données lisible par un humain. Créé au début des années 2000, il vise à être plus simple que le XML et plus lisible que le JSON pour les fichiers de configuration. Les données sont représentées par des paires clé-valeur, des listes et des structures imbriquées, avec une syntaxe qui repose sur l’indentation (et non sur des accolades ou des crochets). Les extensions de fichier courantes sont .yaml et .yml.

Syntaxe YAML : les bases

• Clés et valeurs : une clé suivie de : et d’un espace, puis la valeur (ex. nom: Dupont).
• Listes : chaque élément est préfixé par - (tiret + espace). Sans espace, -80 est le nombre -80, pas un élément de liste.
• Imbrication : l’indentation définit la structure ; utilisez des espaces (pas de tabulations). Une indentation incohérente est la cause fréquente d’erreurs.
• Chaînes : les guillemets sont optionnels sauf si la valeur contient des caractères spéciaux (:, #, {, [, etc.).
• Commentaires : tout ce qui suit # sur une ligne est ignoré.

Où utilise-t-on le YAML ?

Le YAML est très présent dans l’écosystème DevOps et le développement logiciel : Docker Compose (docker-compose.yml), Kubernetes (manifests), GitHub Actions, GitLab CI, Ansible, CircleCI, Travis, et beaucoup de fichiers de configuration d’applications (paramètres, thèmes, etc.). Formatter ou valider un extrait avant de le coller dans un pipeline ou un déploiement évite des erreurs difficiles à déboguer.

YAML et JSON

YAML est un sur-ensemble conceptuel du JSON : tout document JSON valide est du YAML valide. En pratique, le YAML permet en plus les commentaires, les chaînes sur plusieurs lignes, et une syntaxe plus concise. Notre formateur convertit le YAML en structure interne puis le réécrit avec une indentation uniforme (style bloc), ce qui le rend plus lisible tout en conservant les données.

FAQ