Loading…

O tym formatowaczu YAML Onlineowy Formatowacz i Upiększalnik YAML

Pracujesz z nieuporządkowanymi `values.yaml`, `docker-compose.yml` lub przepływami pracy GitHub Actions? Ten formatowacz YAML normalizuje wcięcia i zawijanie linii, zachowując kotwice, aliasy i blokowe skalary. Wklej swój YAML, dostosuj ustawienia wcięć i skopiuj czystą, gotową do przeglądu konfigurację w kilka sekund. 🚀

Kluczowe Funkcje Tego Formatowania YAML

  • Formatowanie oparte na Prettier dostosowane do plików konfiguracyjnych YAML 1.2
  • Spójne wcięcia z konfigurowalnym rozmiarem (1–8) i wyborem spacji lub tabulatorów
  • Dostosowywalna długość zawijania linii, aby długie klucze i wartości pozostały czytelne
  • Poprawnie obsługuje kotwice, aliasy, wartości logiczne jako ciągi znaków i wieloliniowe skalary blokowe
  • Działa z plikami `.yaml` i `.yml` dla Kubernetes, Docker Compose, potoków CI i innych
  • Wklej YAML z edytora lub przeciągnij i upuść pliki konfiguracyjne do formatowania
  • Jednoklikowe kopiowanie sformatowanego YAML z powrotem do edytora lub repozytorium
  • Formatowanie odbywa się głównie po stronie klienta w przeglądarce; bezpieczny serwer zapasowy może być używany tylko w przypadku braku wymaganego parsera/wtyczki

🔧 Jak Sformatować Pliki Konfiguracyjne YAML for yaml-formatter

1

1. Wklej lub Prześlij Swój YAML

Skopiuj dowolny fragment YAML (manifest Kubernetes, `docker-compose.yml`, workflow GitHub Actions, playbook Ansible itp.) i wklej go do edytora lub przeciągnij i upuść plik `.yaml` / `.yml`.

2

2. Dostosuj Wcięcia i Zawijanie

Wybierz, czy używać spacji czy tabulatorów, ustaw rozmiar wcięcia (1–8 spacji) i dostosuj długość zawijania linii, aby dopasować styl zespołu. Długość zawijania `0` skutecznie wyłącza zawijanie, używając bardzo dużego wewnętrznego `printWidth`.

3

3. Uruchom Formatowanie

Kliknij przycisk **Formatuj**. Silnik YAML oparty na Prettier przepisuje konfigurację ze spójnymi wcięciami, zachowując kotwice, aliasy i skalary blokowe, aby semantyka się nie zmieniła.

4

4. Skopiuj Czysty YAML

Przejrzyj wynik, a następnie skopiuj sformatowany YAML z powrotem do edytora, zatwierdź go w Git lub wklej do CI/CD lub interfejsu dostawcy chmury.

Specyfikacje Techniczne

Silnik Formatowania i Obsługa YAML

To narzędzie jest zbudowane na podstawie formatowania YAML opartego na Prettier z opcjami konfiguracji dostępnymi w interfejsie użytkownika.

FunkcjaObsługaUwagi
Wersja YAML✅ YAML 1.2 (typowe)Odpowiednie dla nowoczesnego stylu konfiguracji YAML używanej w Kubernetes, Docker, CI/CD i aplikacjach.
Kotwice i aliasy✅ ZachowaneZachowuje referencje `&anchor` i `*alias` nienaruszone podczas ponownego wcięcia otaczającej struktury.
Skalary blokowe✅ ZachowaneUtrzymuje skalary blokowe `|` i `>` z zachowaniem wewnętrznego wcięcia.
Wartości logiczne i liczbowe✅ Ostrożne przetwarzanieFormatowanie zachowuje wartości, ale może uwidocznić różnice między `yes` a "yes" lub `0012` a "0012".
YAML wielodokumentowy (`---`)✅ TypoweWiele dokumentów w tym samym pliku jest zachowywanych w kolejności i formatowanych spójnie.
Jeśli dany fragment YAML używa wyjątkowo egzotycznej składni lub niestandardowych tagów, których dołączony parser YAML Prettier nie rozumie, możesz zobaczyć błąd parsera. W takim przypadku uprość fragment lub uruchom formatowanie lokalnie z własnym łańcuchem narzędzi.

Wcięcie, Długość Zawijania i Styl Wyjścia

Formatowanie udostępnia kluczowe opcje, abyś mógł jak najdokładniej dopasować styl swojego projektu.

UstawienieOpcjePraktyczna rekomendacja
Styl wcięciaSpacje / TabulatoryWiększość przewodników stylu YAML zaleca spacje; tabulatory tylko jeśli twoja drużyna wyraźnie je preferuje.
Rozmiar wcięcia1–8 spacji2 spacje są powszechne dla Kubernetes i Docker; 4 spacje dla dodatkowej przejrzystości wizualnej.
Zawijanie / długość linii0–120 kolumn`0` wyłącza zawijanie (używa bardzo dużego wewnętrznego `printWidth`), 80–100 utrzymuje różnice kompaktowe.
Rozszerzenia plików.yaml, .ymlPasuje do `fileExtensions` i `acceptedFileTypes` w konfiguracji narzędzia.
Wyrównaj te opcje z `.prettierrc` lub `.editorconfig` twojego repozytorium, aby formatowanie online pasowało do lokalnego rozwoju i kontroli CI.

Limity i Wydajność

Zoptymalizowane do interaktywnego formatowania konfiguracji YAML w karcie przeglądarki.

ParametrLimit / ZachowanieUwagi
Maksymalny rozmiar tekstu wejściowego≈ 2 MB (~2 000 000 znaków)Limit bezpieczeństwa wymuszony wewnątrz funkcji formatującej.
Maksymalny rozmiar przesyłanego pliku≈ 5 MBOgraniczone przez ustawienie `maxFileSize` w interfejsie użytkownika dla wygody i niezawodności.
Limit czasu formatowania~25 sekundDługotrwałe operacje są przerywane, aby zapobiec zawieszaniu się przeglądarki.
Główne wykonaniePo stronie klientaDziała za pomocą `runPrettier` i wtyczki Prettier YAML bezpośrednio w przeglądarce.
Awaryjny serwerTylko przy błędach parsera/wtyczkiJeśli wymagana wtyczka parsera jest brakująca, bezpieczny punkt końcowy `/api/yaml-formatter` może być użyty jako zapasowy.
Dla dużych pakietów YAML (wykresy Helm, ogromne biblioteki CRD itp.), preferuj narzędzia CLI jak `prettier` lub `yq` zintegrowane z lokalnym przepływem pracy lub potokami CI.

Alternatywy CLI do formatowania YAML

Używaj formatowania online do szybkich poprawek, a polegaj na narzędziach CLI dla dużych projektów i zautomatyzowanych potoków.

Linux / 🍏 macOS

Sformatuj plik YAML za pomocą yq (ładne drukowanie)

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

Przepisuje YAML z konsekwentnym wcięciem i porządkowaniem kluczy w zależności od wersji yq.

Normalizuj YAML za pomocą Prettier

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

Uruchamia tę samą klasę silnika (parser YAML Prettier) w całym repozytorium.

Windows (PowerShell / cmd)

Formatuj YAML używając PowerShell + yq

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

Ładnie drukuje YAML i zapisuje wynik z powrotem na dysk.

Przetwarzaj YAML przez obiekty PowerShell

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

Wykorzystuje obsługę YAML w PowerShell do normalizacji struktury i wcięć.

Połącz ten formatowanie online z krokiem `prettier --check` lub `yq` w potoku CI, aby zagwarantować, że cały YAML w repozytorium pozostaje konsekwentnie sformatowany.

Praktyczne zastosowania YAML

Infrastruktura & manifesty Kubernetes

  • Formatuj manifesty Kubernetes `Deployment`, `Service` i `Ingress` przed przeglądem kodu.
  • Normalizuj pliki `values.yaml` w wykresach Helm, aby różnice były czystsze.
  • Utrzymuj CRD, ConfigMaps i Secrets YAML konsekwentnie wcięte w różnych środowiskach.
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 & konfiguracja lokalnego rozwoju

  • Upiększ `docker-compose.yml` przed udostępnieniem go w dokumentacji lub zgłoszeniach.
  • Wyrównaj wcięcia usług, sieci i wolumenów dla łatwiejszej konserwacji.
  • Przygotuj czyste fragmenty YAML do postów na blogu i przewodników wprowadzających.
version: "3.9"
services:
  web:
    image: myapp:latest
    ports:
      - "8080:80"
    environment:
      - NODE_ENV=production
  db:
    image: postgres:16
    environment:
      POSTGRES_PASSWORD: example

Potoki CI/CD i Automatyzacja

  • Formatuj przepływy pracy GitHub Actions (`.github/workflows/*.yml`).
  • Oczyść GitLab CI (`.gitlab-ci.yml`) lub YAML Azure Pipelines.
  • Utrzymuj YAML automatyzacji i infrastruktury jako kod czytelnym między zespołami.
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

Co robi ten formatator YAML?

Pobiera dane wejściowe YAML (zwykle pliki konfiguracyjne) i przepisuje je z konsekwentnym wcięciem i zawijaniem, używając silnika YAML opartego na Prettier. Semantyka twojej konfiguracji pozostaje taka sama, ale układ staje się znacznie łatwiejszy do czytania i przeglądania.

🧩Które funkcje YAML są obsługiwane?

Formatator jest zaprojektowany dla typowych funkcji YAML 1.2 używanych w plikach konfiguracyjnych: mapowania, listy, kotwice i aliasy, skalary blokowe (`|` / `>`), oraz pliki wielodokumentowe oddzielone przez `---`. Niestandardowe tagi i bardzo egzotyczne konstrukcje mogą nie być w pełni obsługiwane przez podstawowy parser.

📏Czy istnieje limit rozmiaru dla danych wejściowych YAML?

Dla stabilności i wydajności przeglądarki, tekst wejściowy jest ograniczony do około 2 MB (~2 000 000 znaków), a przesyłane pliki do około 5 MB. Dla większych baz kodu lub wygenerowanego YAML, uruchom Prettier lub yq z poziomu CLI lub potoku CI.

🔐Czy mój YAML jest przesyłany na serwer?

Formatowanie odbywa się głównie w twojej przeglądarce za pomocą `runPrettier` i wtyczki Prettier YAML, więc twój YAML nie opuszcza klienta w normalnej pracy. W rzadkich przypadkach, gdy brakuje wymaganej wtyczki parsera, narzędzie może przejść na bezpieczny punkt końcowy `/api/yaml-formatter`. Nawet wtedy twój YAML jest przetwarzany tylko przejściowo i nie jest przechowywany.

⚠️Dlaczego czasami widzę błędy parsera?

Błędy parsera zwykle oznaczają, że YAML jest źle sformułowany (np. niespójne wcięcia, brakujące `:` lub niewyrównane elementy listy) lub używa składni, której dołączony parser nie rozumie. Sprawdź poprawność wcięć i struktury lub spróbuj uprościć fragment, a następnie uruchom formatator ponownie.

📚Jak to się ma do mojej lokalnej konfiguracji Prettier?

To narzędzie używa pod spodem silnika YAML opartego na Prettier, podobnie jak uruchomienie `prettier --parser yaml`. Możesz go używać do szybkich jednorazowych napraw i nadal polegać na lokalnym `.prettierrc` i poleceniach CLI do formatowania całego projektu.

Pro Tips

Best Practice

Znormalizuj cały YAML w repozytorium (Kubernetes, GitHub Actions, Docker Compose) z tym samym stylem wcięć, aby znacznie ułatwić porównywanie różnic i przeglądy.

Best Practice

Uważaj na wartości takie jak `yes`, `no`, `on`, `off`, `0012` – umieść je w cudzysłowie, jeśli chcesz, aby były traktowane jako ciągi znaków zamiast wartości logicznych lub liczb ósemkowych.

Best Practice

Użyj tego formatowania online, aby szybko oczyścić fragmenty kodu do dokumentacji lub zgłoszeń, a następnie korzystaj z `prettier` lub `yq` w hakach pre-commit dla pełnych projektów.

CI Tip

Podczas refaktoryzacji dużych konfiguracji, najpierw sformatuj, aby zmiany semantyczne były wyraźnie widoczne w różnicach Git, zamiast być ukryte w szumie wcięć.

Additional Resources

Other Tools