Poslední aktualizace: duben 2026
Co je formátování TOML?
TOML (Tom's Obvious Minimal Language) je formát konfiguračních souborů, který vytvořil Tom Preston-Werner v roce 2013. Přímo se mapuje na hashovací tabulku a používá explicitní typování pro všechny hodnoty. TOML formátovač vezme surový nebo nekonzistentně stylizovaný TOML a znovu jej serializuje s jednotným odsazením, správným zarovnáním a kanonickým řazením klíčů. Výsledkem je soubor dodržující stejné konvence v celém projektu, což usnadňuje přehled změn konfigurace v diffech.
Specifikace TOML v1.0.0, finalizovaná v lednu 2021, definuje gramatiku natolik striktně, že každý vyhovující parser produkuje ze stejného vstupu identickou datovou strukturu. Formátování nemění sémantický obsah souboru TOML. Upravuje pouze bílé znaky, seskupení klíčů a styl uvozování. Soubory TOML proto můžete formátovat volně, aniž byste se museli obávat narušení chování aplikace.
Na rozdíl od JSON podporuje TOML komentáře, nativní typy datum/čas a více forem řetězců (základní, literální a víceřádkové). Dobrý formátovač zachovává komentáře a respektuje rozdíl mezi inline tabulkami a standardními záhlavími tabulek. Správně zpracovává také pole tabulek a zachovává seskupení sekcí, takže soubor zůstává čitelný jak pro lidi, tak pro parsery.
title="My App" version="1.0.0" debug=false [database] host="localhost" port=5432 name="mydb" [database.pool] max_connections=25 timeout=30 [[servers]] name="web" host="web.example.com" [[servers]] name="api" host="api.example.com"
title = "My App" version = "1.0.0" debug = false [database] host = "localhost" port = 5432 name = "mydb" [database.pool] max_connections = 25 timeout = 30 [[servers]] name = "web" host = "web.example.com" [[servers]] name = "api" host = "api.example.com"
Proč používat TOML formátovač?
Konfigurační soubory postupem času akumulují stylistické odchylky, jak je upravují různí členové týmu. Tabulátory se mísí s mezerami, některé klíče jsou zbytečně uvozovány a sekce tabulek ztrácejí vizuální seskupení. TOML formátovač toto vše normalizuje v jednom průchodu.
Případy použití TOML formátovače
Reference syntaxe TOML
TOML má malou sadu konstruktů. Níže uvedená tabulka uvádí každý strukturální prvek definovaný ve specifikaci TOML v1.0.0. Formátovač aplikuje konzistentní mezery a seskupení na všechny z nich.
| Syntaxe | Název | Poznámky |
|---|---|---|
| key = "value" | Basic key-value pair | Keys are bare or quoted; values are typed |
| [table] | Standard table | Creates a named section (hash table) |
| [a.b.c] | Dotted table | Shorthand for nested tables |
| [[array]] | Array of tables | Each [[name]] block appends to an array |
| key = """...\n""" | Multi-line basic string | Allows newlines, escapes processed |
| key = '''...\n''' | Multi-line literal string | Allows newlines, no escape processing |
| # comment | Comment | Extends to end of line; not in JSON output |
| {inline = true} | Inline table | Single-line table, no newlines allowed |
TOML vs JSON vs YAML
TOML, JSON a YAML řeší překrývající se problémy, ale přistupují k nim odlišně.
| Funkce | TOML | JSON | YAML |
|---|---|---|---|
| Komentáře | # řádkové komentáře | Nepodporováno | # řádkové komentáře |
| Typované hodnoty | Řetězec, celé číslo, desetinné číslo, bool, datum/čas | Řetězec, číslo, bool, null | Odvozené (náchylné k chybám) |
| Vnořování | Záhlaví [tabulky] | Složené závorky | Na základě odsazení |
| Striktnost specifikace | Striktní (jeden výsledek parsování) | Striktní (RFC 8259) | Volná (více platných parsování) |
| Podpora datum/čas | 4 nativní typy | Žádná (použijte řetězce) | Implicitní (nespolehlivé) |
| Závěrečné čárky | Není povoleno | Není povoleno | Nevztahuje se (žádné čárky) |
Příklady kódu
Níže uvedené příklady formátují TOML programově v různých jazycích a nástrojích. Každý načte soubor, zparsuje jej a zapíše naformátovanou verzi.
import { parse, stringify } from '@iarna/toml'
import fs from 'fs'
const raw = fs.readFileSync('config.toml', 'utf-8')
const doc = parse(raw)
const formatted = stringify(doc)
// stringify() outputs canonical TOML with consistent spacing
fs.writeFileSync('config.toml', formatted)
// Quick one-liner with npx:
// npx taplo fmt config.tomlimport tomllib # Python 3.11+ (read-only)
import tomli_w # pip install tomli-w (write)
# Parse and re-serialize to format
with open("config.toml", "rb") as f:
data = tomllib.load(f)
formatted = tomli_w.dumps(data)
# tomli_w produces sorted keys, consistent quoting, and
# proper whitespace around = signs
print(formatted)
# CLI alternative: taplo fmt config.tomlpackage main
import (
"fmt"
"os"
"github.com/BurntSushi/toml"
"bytes"
)
func main() {
var data map[string]interface{}
_, err := toml.DecodeFile("config.toml", &data)
if err != nil {
fmt.Fprintln(os.Stderr, err) // parse error with line number
os.Exit(1)
}
var buf bytes.Buffer
enc := toml.NewEncoder(&buf)
enc.Indent = " "
enc.Encode(data) // re-serialized with consistent formatting
fmt.Print(buf.String())
}# Install taplo — the standard TOML toolkit cargo install taplo-cli # or: npm install -g @taplo/cli # Format a single file in place taplo fmt config.toml # Format all .toml files in a project taplo fmt # Check formatting without modifying (CI-friendly) taplo fmt --check # Validate TOML syntax without formatting taplo lint config.toml