Formatter Markdown

Cosa corregge il formatter

• Marcatori di lista. *, -, + vengono normalizzati a un carattere coerente (predefinito -).
• Gerarchia delle intestazioni. Avvisa (o promuove) quando H2 è seguito da H4 senza H3 in mezzo.
• Righe vuote. Esattamente una riga vuota tra i blocchi; nessuna sequenza di tre o più.
• Tabelle. Aggiunge padding a ciascuna colonna affinché i pipe si allineino nel sorgente, anche se i renderer Markdown non se ne curano.
• Spazi bianchi finali. Rimuove gli spazi finali su ogni riga tranne il marcatore di interruzione di riga intenzionale a due spazi.
• Link di riferimento. Raccoglie le definizioni [label]: url alla fine del documento, ordinate alfabeticamente.
• Code fences. Il tag di lingua è normalizzato in minuscolo; i blocchi di codice basati su indentazione diventano blocchi delimitati.

Opzioni di stile che puoi impostare

Perché il Markdown coerente è importante

In un repository di team, un Markdown incoerente produce diff rumorosi: ogni volta che qualcuno salva un file con un editor diverso, i marcatori delle liste cambiano e le tabelle si riformattano. Un formatter impone uno stile affinché i revisori delle richieste di pull vedano solo le modifiche di contenuto. Pensalo come prettier per la prosa.

Quando non formattare

• Blocchi di codice delimitati rimangono intatti byte per byte, il formatter non toccherà mai il contenuto di un blocco di codice. Se la formattazione cambia il codice, è un bug.
• Interruzioni di riga intenzionali a larghezze ridotte (readme.md su un progetto terminale) vengono riavvolte se abiliti l’avvolgimento della colonna. Disabilita l’avvolgimento se mantieni interruzioni di riga manuali.
• Blocchi HTML incorporati passano attraverso invariati.

Sostituzioni drop-in

Se preferisci un CLI locale, il formatter utilizza le stesse regole AST di remark-stringify con il plugin remark-gfm. prettier --parser markdown produce un risultato simile.