Senast uppdaterad: april 2026
Vad är TOML-formatering?
TOML (Tom's Obvious Minimal Language) är ett konfigurationsfilformat skapat av Tom Preston-Werner år 2013. Det mappas direkt till en hashtabell och använder explicit typning för alla värden. En TOML-formaterare tar rå eller inkonsekvent formaterad TOML och serialiserar om den med enhetlig avståndssättning, korrekt indragning och kanonisk nyckelordning. Resultatet är en fil som följer samma konventioner i hela projektet, vilket gör konfigurationsändringar enklare att granska i diff:ar.
TOML v1.0.0-specifikationen, färdigställd i januari 2021, definierar grammatiken tillräckligt strikt för att varje kompatibel parser producerar en identisk datastruktur från samma indata. Formatering ändrar inte det semantiska innehållet i en TOML-fil. Den justerar bara blanksteg, nyckelgruppering och citatteckenstil. Det innebär att du fritt kan formatera TOML-filer utan att behöva oroa dig för att applikationens beteende påverkas.
Till skillnad från JSON stöder TOML kommentarer, inbyggda datum- och tidtyper samt flera strängformer (grundläggande, bokstavlig och flerradig). En bra formaterare bevarar kommentarer och respekterar skillnaden mellan inline-tabeller och vanliga tabellrubriker. Den hanterar också tabellmatriser korrekt och håller sektionsgruppering intakt så att filen förblir läsbar för både människor och de parsers som konsumerar den.
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"
Varför använda en TOML-formaterare?
Konfigurationsfiler ackumulerar stilavvikelser när olika teammedlemmar redigerar dem över tid. Tabbar blandas med mellanslag, vissa nycklar citeras i onödan och tabellsektioner förlorar sin visuella gruppering. En TOML-formaterare normaliserar allt detta i ett enda genomlopp.
Användningsfall för TOML Formatter
Referens för TOML-syntax
TOML har en liten uppsättning konstruktioner. Tabellen nedan listar varje strukturellt element som definieras i TOML v1.0.0-specifikationen. En formaterare tillämpar konsekvent avståndssättning och gruppering på samtliga dessa.
| Syntax | Namn | Anmärkningar |
|---|---|---|
| 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 och YAML löser överlappande problem men gör olika avvägningar.
| Funktion | TOML | JSON | YAML |
|---|---|---|---|
| Kommentarer | # radkommentarer | Stöds ej | # radkommentarer |
| Typade värden | Sträng, heltal, flyttal, bool, datetime | Sträng, nummer, bool, null | Härledd (felbenägen) |
| Nästning | [tabell]-rubriker | Klammerparenteser | Indragningsbaserad |
| Specifikationsstrikthet | Strikt (ett parsningsresultat) | Strikt (RFC 8259) | Löst (flera giltiga parsningar) |
| Datum/tid-stöd | 4 inbyggda typer | Inget (använd strängar) | Implicit (ömtåligt) |
| Avslutande kommatecken | Inte tillåtet | Inte tillåtet | Ej tillämpligt (inga kommatecken) |
Kodexempel
Exemplen nedan formaterar TOML programmatiskt i olika språk och verktyg. Varje exempel läser en fil, tolkar den och skriver en formaterad version.
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