Guida

YAML lint online: controlla la sintassi mentre scrivi

Incolla il tuo YAML: questo YAML lint online lo controlla mentre scrivi e spiega ogni problema di sintassi in parole semplici, con riga e colonna. Trova l'indentazione con i tab, le chiavi duplicate, le virgolette e le parentesi non chiuse e gli spazi non separabili invisibili che sembrano indentazione ma non lo sono. Il YAML viene controllato nel tuo browser e non viene mai caricato.


Come usare lo strumento passo per passo

Incolla o scrivi il tuo YAML nella casella YAML. Non c'è nessun pulsante di convalida: il testo viene controllato in tempo reale.

  1. Il testo incollato viene controllato subito. Quando scrivi, il controllo parte circa un quarto di secondo dopo l'ultimo tasto, un po' più tardi per testi molto grandi. Il risultato precedente resta attenuato finché non arriva quello nuovo.
  2. Leggi il riquadro sotto l'editor. Un riquadro verde YAML valido significa che la sintassi è corretta. Un riquadro rosso YAML non valido (o «YAML non valido: N problemi») elenca ciò che non va.
  3. Ogni problema riporta una frase, «Riga N, colonna M» e un frammento della riga con i numeri di riga: due righe sopra, una sotto e un ^ sotto la colonna.
  4. Premi Mostra nell'editor per selezionare quella riga nella casella, correggila e guarda il riquadro diventare verde.

Viene segnalato solo il primo errore di sintassi di ogni documento. Quelli successivi sono spesso effetti collaterali, per esempio una virgoletta mancante che inghiotte le righe sotto. Le chiavi duplicate e gli alias non definiti sono sempre elencati tutti, e si vedono fino a 20 problemi.

Problemi comuni di sintassi e come correggerli

Ogni problema è spiegato con una frase invece che con un messaggio grezzo del parser. Ecco i più frequenti:

Cosa significano i messaggi di altri parser

Arrivi da un messaggio nel terminale o in un log della CI? Ecco come le diciture più comuni corrispondono a ciò che segnala questo strumento. Incolla lo stesso file e ti mostra la riga.

Le diciture cambiano da un parser all'altro (PyYAML, js-yaml, Ruby, Go, i loader di Home Assistant ed ESPHome), e un parser segnala spesso una riga sotto l'errore vero. Questo strumento indica la riga che può mostrarti.

Tab e caratteri invisibili

I due errori più difficili da individuare in YAML sono quelli che non si vedono. Questo strumento li rende visibili.

Un esempio: in un file con server: e sotto port: 8080, l'ultima riga, host: example.com, inizia con due spazi non separabili invece di due spazi. YAML la legge come un'altra chiave di primo livello, e host non è figlia di server. Il riquadro giallo nomina il carattere e la riga.

Formattare il YAML e copiare il risultato

Attiva l'interruttore Formatta YAML sopra la casella. È disattivato di default. Quando il testo è valido compare un blocco YAML formattato con sopra un pulsante Copia, che diventa Copiato dopo la copia. La formattazione è prevedibile:

Si formatta solo YAML valido, quindi non può riparare un file rotto: correggi prima gli errori. Un output molto lungo viene mostrato troncato dopo 600.000 caratteri, e Copia lo copia comunque per intero.

Usi, dimensioni e limiti

Il controllo è lo stesso qualunque sia l'uso del YAML. Va bene per i workflow di GitHub Actions, docker-compose.yml, i manifest Kubernetes e i valori di Helm, i file OpenAPI, i playbook Ansible, la configurazione di Home Assistant, i modelli CloudFormation e la configurazione di mkdocs. Incolla il file prima del commit e gli errori di sintassi compaiono senza aspettare un'esecuzione della CI. Un file con più documenti separati da --- viene controllato documento per documento, e il riquadro verde dice quanti ne ha trovati. Ancore (&nome) e alias (*nome) vengono controllati. I tag personalizzati come !Ref, !Sub e !GetAtt di CloudFormation, o !reference di GitLab, sono accettati come validi.

Il controllo gira in un Web Worker nel tuo browser. I tipici file di configurazione, CI e Kubernetes si controllano in un attimo. Il limite è di 5.000.000 di caratteri, e un testo vicino al limite richiede qualche secondo e molta memoria. Oltre il limite ti viene chiesto di incollare un frammento più piccolo.

Si controlla solo la sintassi YAML. Lo strumento non sa cosa si aspetta un dato programma, quindi i campi di Kubernetes, le chiavi di GitHub Actions o Docker Compose e le regole di JSON Schema non vengono controllati, e un nome di chiave scritto male passa lo stesso. Segue YAML 1.2, quindi le parole yes, no, on e off di YAML 1.1 sono testo normale e non vengono mai giudicate. Non esegue, non scarica e non carica nulla, e un vecchio ritorno a capo Mac isolato non è trattato come un a capo.

Lavori con altri formati? Riordina e controlla JSON con il Formattatore JSON, verificalo rispetto a uno schema con il Validatore JSON Schema, oppure controlla il markup con il Validatore XML. Cerchi un pattern nella tua configurazione? Provalo nel Tester di regex.


Domande frequenti

Come faccio un controllo YAML lint online?

Incolla il tuo YAML nella casella «YAML». Il testo viene controllato mentre incolli o scrivi, quindi non c'è nessun pulsante da premere. Un riquadro verde «YAML valido» significa che la sintassi è corretta. Un riquadro rosso «YAML non valido» riporta ogni problema in parole semplici, con «Riga N, colonna M» e un frammento della riga.

Perché YAML dice che i tab non sono ammessi per l'indentazione?

YAML ammette solo spazi per indentare, e un tab a inizio riga è un errore di sintassi. Gli editor spesso inseriscono tab quando premi il tasto Tab, oppure il tab arriva con un testo incollato. Lo strumento segnala che la riga è indentata con un tab. Sostituiscilo con degli spazi.

Cosa significa «mapping values are not allowed here» in YAML?

Di solito c'è un secondo due punti su una riga, come in «a: b: c», oppure un valore senza virgolette contiene i due punti. Può anche essere una riga indentata sotto una chiave che ha già un valore. Metti il valore tra virgolette oppure scrivi la coppia interna su una riga indentata a sé.

Cosa significa «did not find expected key» in YAML?

Una riga non è allineata con le altre chiavi della sua mappa. Di solito una chiave ha uno spazio in più o in meno delle vicine. Dai a tutte le chiavi dello stesso livello la stessa indentazione. Lo strumento lo segnala dicendo che la riga non è allineata con le altre chiavi.

Come trovo le chiavi duplicate in un file YAML?

Incolla il testo. Le chiavi duplicate nella stessa mappa vengono sempre elencate tutte, ciascuna con riga e colonna. Di solito un blocco copiato ha lasciato una chiave ripetuta. Unisci le voci o elimina il doppione.

Perché un file valido mostra «Valido, ma controlla questa riga»?

Una riga inizia con uno spazio invisibile, per esempio uno spazio non separabile. YAML lo legge come parte della chiave, quindi la riga non è davvero indentata anche se il file è valido. Il riquadro giallo nomina il carattere e la riga. Eliminalo e digita spazi normali.

Posso controllare qui un file di GitHub Actions, Docker Compose o Kubernetes?

Sì, il controllo di sintassi è lo stesso per qualsiasi YAML. Va bene per i workflow, docker-compose.yml, i manifest Kubernetes e molti altri file. Si controlla solo la sintassi: lo strumento non sa quali chiavi si aspetta ciascun programma, e un nome di chiave scritto male passa lo stesso.

Quanto può essere grande un file YAML da controllare?

Il limite è di 5.000.000 di caratteri. I normali file di configurazione si controllano in un attimo, e un testo vicino al limite richiede qualche secondo e molta memoria. Oltre il limite ti viene chiesto di incollare un frammento più piccolo.

Consigliati

Aiuta a mantenere gratuiti gli strumenti. ✨

Le immagini sono solo a scopo illustrativo. In qualità di Affiliato Amazon io ricevo un guadagno dagli acquisti idonei.