Loading…

À propos de ce formateur YAML Formateur et Beautificateur YAML en Ligne

Vous travaillez avec des `values.yaml`, `docker-compose.yml` ou workflows GitHub Actions désordonnés ? Ce formateur YAML normalise l'indentation et le retour à la ligne tout en préservant les ancres, alias et scalaires de bloc. Collez votre YAML, ajustez les paramètres d'indentation et copiez une configuration propre, prête pour la revue en quelques secondes. 🚀

Fonctionnalités principales de ce formateur YAML

  • Formatage basé sur Prettier optimisé pour les fichiers de configuration YAML 1.2
  • Indentation cohérente avec taille d'indentation configurable (1–8) et espaces vs tabulations
  • Longueur de ligne ajustable pour que les clés et valeurs longues restent lisibles
  • Gère correctement les ancres, alias, booléens-comme-chaînes et scalaires de bloc multilignes
  • Fonctionne avec les fichiers `.yaml` et `.yml` pour Kubernetes, Docker Compose, pipelines CI et plus
  • Collez du YAML depuis votre éditeur ou glissez-déposez des fichiers de configuration dans le formateur
  • Copie en un clic du YAML formaté vers votre éditeur ou dépôt
  • Le formatage s'exécute principalement côté client dans votre navigateur ; une solution de secours serveur sécurisée peut être utilisée uniquement si un analyseur/plugin requis est manquant

🔧 Comment formater les fichiers de configuration YAML for yaml-formatter

1

1. Collez ou téléchargez votre YAML

Copiez n'importe quel extrait YAML (manifeste Kubernetes, `docker-compose.yml`, workflow GitHub Actions, playbook Ansible, etc.) et collez-le dans l'éditeur, ou glissez-déposez un fichier `.yaml` / `.yml`.

2

2. Ajustez l'indentation et le retour à la ligne

Choisissez d'utiliser des espaces ou des tabulations, définissez la taille d'indentation (1–8 espaces) et ajustez la longueur de ligne pour correspondre au style de votre équipe. Une longueur de ligne de `0` désactive efficacement le retour à la ligne en utilisant une très grande `printWidth` interne.

3

3. Exécutez le formateur

Cliquez sur le bouton **Formater**. Le moteur YAML basé sur Prettier réécrit votre configuration avec une indentation cohérente tout en préservant les ancres, alias et scalaires de bloc pour que la sémantique ne change pas.

4

4. Copiez le YAML nettoyé

Vérifiez la sortie, puis copiez le YAML formaté dans votre éditeur, committez-le dans Git ou collez-le dans votre CI/CD ou interface de fournisseur cloud.

Spécifications techniques

Moteur de formatage & Support YAML

Cet outil est construit sur un formateur YAML basé sur Prettier avec des options de configuration accessibles dans l'interface utilisateur.

FonctionnalitéSupportNotes
Version YAML✅ YAML 1.2 (typique)Adapté au YAML de style configuration moderne utilisé dans Kubernetes, Docker, CI/CD et les applications.
Ancres et alias✅ PréservésConserve les références `&anchor` et `*alias` intactes tout en ré-indentant la structure environnante.
Scalaires de bloc✅ PréservésMaintient les scalaires de bloc `|` et `>` avec l'indentation interne respectée.
Booléens et nombres✅ Gestion prudenteLe formatage conserve les valeurs mais peut révéler des différences entre `yes` et "yes" ou `0012` et "0012".
YAML multi-document (`---`)✅ TypiqueLes documents multiples dans le même fichier sont conservés dans l'ordre et formatés de manière cohérente.
Si un extrait YAML donné utilise une syntaxe extrêmement exotique ou des balises personnalisées que l'analyseur YAML Prettier intégré ne comprend pas, vous pourriez voir une erreur d'analyse. Dans ce cas, simplifiez l'extrait ou exécutez le formatage localement avec votre propre chaîne d'outils.

Indentation, Longueur de Ligne et Style de Sortie

Le formateur expose des options clés pour que vous puissiez correspondre au style de votre projet aussi étroitement que possible.

ParamètreOptionsRecommandation Pratique
Style d'indentationEspaces / TabulationsLa plupart des guides de style YAML recommandent les espaces ; les tabulations uniquement si votre équipe les préfère explicitement.
Taille d'indentation1–8 espaces2 espaces est courant pour Kubernetes et Docker ; 4 espaces pour une clarté visuelle supplémentaire.
Retour à la ligne / longueur de ligne0–120 colonnes`0` désactive le retour à la ligne (utilise une `printWidth` interne très grande), 80–100 garde les diffs compacts.
Extensions de fichier.yaml, .ymlCorrespond aux `fileExtensions` et `acceptedFileTypes` dans la configuration de l'outil.
Alignez ces options avec le `.prettierrc` ou `.editorconfig` de votre dépôt pour que le formatage en ligne corresponde au développement local et aux vérifications CI.

Limites et Performances

Optimisé pour le formatage interactif des configurations YAML dans un onglet de navigateur.

ParamètreLimite / ComportementNotes
Taille maximale de texte en entrée≈ 2 Mo (~2 000 000 caractères)Limite de sécurité appliquée dans la fonction de formatage.
Taille maximale de téléchargement de fichier≈ 5 MoLimité par le paramètre `maxFileSize` de l'interface utilisateur pour plus de commodité et de fiabilité.
Délai d'expiration du formatage~25 secondesLes opérations longues sont interrompues pour éviter que le navigateur ne se bloque.
Exécution principaleCôté clientFonctionne via `runPrettier` et un plugin Prettier YAML directement dans votre navigateur.
Secours serveurUniquement en cas d'erreurs de parseur/pluginSi un plugin de parseur requis est manquant, un point de terminaison sécurisé `/api/yaml-formatter` peut être utilisé comme solution de secours.
Pour les gros ensembles YAML (charts Helm, bibliothèques CRD volumineuses, etc.), préférez les CLI comme `prettier` ou `yq` intégrés dans votre flux de travail local ou vos pipelines CI.

Alternatives en ligne de commande pour le formatage YAML

Utilisez le formateur en ligne pour des nettoyages rapides, et comptez sur les outils CLI pour les grands projets et les pipelines automatisés.

Linux / 🍏 macOS

Formater un fichier YAML avec yq (jolie impression)

yq eval -P config.yaml > config.formatted.yaml

Réécrit le YAML avec une indentation cohérente et un ordre des clés dépendant de la version de yq.

Normaliser le YAML avec Prettier

prettier --parser yaml --write "**/*.{yaml,yml}"

Exécute la même classe de moteur (parseur YAML Prettier) dans l'ensemble de votre dépôt.

Windows (PowerShell / cmd)

Formater YAML en utilisant PowerShell + yq

yq eval -P config.yaml | Set-Content config.formatted.yaml

Imprime joliment le YAML et écrit le résultat sur le disque.

YAML aller-retour via les objets PowerShell

Get-Content config.yaml -Raw | ConvertFrom-Yaml | ConvertTo-Yaml | Set-Content config.formatted.yaml

Utilise la prise en charge YAML de PowerShell pour normaliser la structure et l'indentation.

Combinez ce formateur en ligne avec une étape `prettier --check` ou `yq` dans votre pipeline CI pour garantir que tout le YAML du dépôt reste formaté de manière cohérente.

Cas d'utilisation pratiques du YAML

Infrastructure et manifestes Kubernetes

  • Formater les manifestes Kubernetes `Deployment`, `Service` et `Ingress` avant la revue de code.
  • Normaliser les fichiers `values.yaml` dans les charts Helm pour rendre les différences plus claires.
  • Maintenir les CRD, ConfigMaps et Secrets YAML avec une indentation cohérente entre les environnements.
apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app
spec:
  replicas: 3
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
    spec:
      containers:
        - name: my-app
          image: my-app:latest
          ports:
            - containerPort: 80

Docker Compose et configuration de développement local

  • Embellir `docker-compose.yml` avant de le partager dans la documentation ou les tickets.
  • Aligner l'indentation des services, réseaux et volumes pour faciliter la maintenance.
  • Préparer des extraits YAML propres pour les articles de blog et les guides d'intégration.
version: "3.9"
services:
  web:
    image: myapp:latest
    ports:
      - "8080:80"
    environment:
      - NODE_ENV=production
  db:
    image: postgres:16
    environment:
      POSTGRES_PASSWORD: example

Pipelines CI/CD & Automatisation

  • Formater les workflows GitHub Actions (`.github/workflows/*.yml`).
  • Nettoyer GitLab CI (`.gitlab-ci.yml`) ou les YAML Azure Pipelines.
  • Maintenir la lisibilité des YAML d'automatisation et d'infrastructure-as-code entre les équipes.
name: CI
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
      - run: npm ci
      - run: npm test

❓ Frequently Asked Questions

Que fait ce formateur YAML ?

Il prend une entrée YAML (généralement des fichiers de configuration) et la réécrit avec une indentation et un habillage cohérents en utilisant un moteur YAML basé sur Prettier. La sémantique de votre configuration reste la même, mais la mise en page devient beaucoup plus facile à lire et à réviser.

🧩Quelles fonctionnalités YAML sont prises en charge ?

Le formateur est conçu pour les fonctionnalités courantes de YAML 1.2 utilisées dans les fichiers de configuration : mappages, listes, ancres et alias, scalaires en bloc (`|` / `>`), et fichiers multi-documents séparés par `---`. Les balises personnalisées et les constructions très exotiques peuvent ne pas être entièrement prises en charge par l'analyseur sous-jacent.

📏Y a-t-il une limite de taille pour l'entrée YAML ?

Pour la stabilité et les performances du navigateur, l'entrée de texte est limitée à environ 2 Mo (~2 000 000 caractères) et les fichiers téléchargés à environ 5 Mo. Pour les bases de code plus volumineuses ou le YAML généré, exécutez Prettier ou yq depuis votre CLI ou pipeline CI à la place.

🔐Mon YAML est-il téléchargé sur un serveur ?

Le formatage s'exécute principalement dans votre navigateur via `runPrettier` et le plugin YAML Prettier, donc votre YAML ne quitte pas le client en fonctionnement normal. Dans de rares cas où un plugin d'analyseur requis est manquant, l'outil peut basculer vers un point de terminaison sécurisé `/api/yaml-formatter`. Même dans ce cas, votre YAML n'est traité que temporairement et n'est pas stocké.

⚠️Pourquoi vois-je parfois des erreurs d'analyseur ?

Les erreurs d'analyseur signifient généralement que le YAML est mal formé (par exemple, indentation incohérente, `:` manquant ou éléments de liste mal alignés) ou utilise une syntaxe que l'analyseur intégré ne comprend pas. Validez l'indentation et la structure, ou essayez de simplifier l'extrait, puis relancez le formateur.

📚Quel est le lien avec ma configuration Prettier locale ?

Cet outil utilise un moteur YAML basé sur Prettier en arrière-plan, similaire à l'exécution de `prettier --parser yaml`. Vous pouvez l'utiliser pour des corrections rapides ponctuelles et toujours compter sur votre `.prettierrc` local et vos commandes CLI pour le formatage de projet complet.

Pro Tips

Best Practice

Normalisez tous les YAML dans un dépôt (Kubernetes, GitHub Actions, Docker Compose) avec le même style d'indentation pour faciliter les différences et les révisions.

Best Practice

Soyez prudent avec des valeurs comme `yes`, `no`, `on`, `off`, `0012` – mettez-les entre guillemets si vous voulez qu'elles soient traitées comme des chaînes plutôt que comme des booléens ou des nombres de type octal.

Best Practice

Utilisez ce formateur en ligne pour nettoyer rapidement des extraits pour la documentation ou les tickets, puis utilisez `prettier` ou `yq` dans les hooks de pré-commit pour les projets complets.

CI Tip

Lors du refactoring de grandes configurations, formatez d'abord pour que les changements sémantiques ressortent clairement dans les diffs Git au lieu d'être noyés dans le bruit de l'indentation.

Additional Resources

Other Tools