Останнє оновлення: квітень 2026 р.
Що таке форматування TOML?
TOML (Tom's Obvious Minimal Language) — це формат конфігураційних файлів, створений Томом Престоном-Вернером у 2013 році. Він безпосередньо відображається у хеш-таблицю та використовує явну типізацію для всіх значень. TOML formatter бере сирий або непослідовно оформлений TOML і повторно серіалізує його з однорідними пробілами, правильними відступами та канонічним упорядкуванням ключів. Результатом є файл, що дотримується єдиних правил у всьому проекті, що спрощує перегляд змін конфігурації у diff-ах.
Специфікація TOML v1.0.0, завершена у січні 2021 року, визначає граматику достатньо суворо, щоб будь-який сумісний парсер давав ідентичну структуру даних з одного вхідного файлу. Форматування не змінює семантичний вміст TOML-файлу. Воно коригує лише пробіли, групування ключів і стиль лапок. Це означає, що ви можете форматувати TOML-файли без ризику порушити поведінку вашого застосунку.
На відміну від JSON, TOML підтримує коментарі, нативні типи дати й часу та кілька форм рядків (базовий, літеральний і багаторядковий). Хороший formatter зберігає коментарі та розрізняє вбудовані таблиці й стандартні заголовки таблиць. Він також правильно обробляє масиви таблиць, зберігаючи групування секцій, щоб файл залишався зручним для читання людиною і для парсерів.
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"
Навіщо використовувати TOML Formatter?
Конфігураційні файли накопичують розбіжності в оформленні, коли різні члени команди редагують їх із часом. Табуляції змішуються з пробілами, деякі ключі беруться в лапки без потреби, а табличні секції втрачають свою візуальну структуру. TOML formatter нормалізує все це за один прохід.
Випадки використання TOML Formatter
Довідник синтаксису TOML
TOML має невеликий набір конструкцій. У таблиці нижче перелічено всі структурні елементи, визначені у специфікації TOML v1.0.0. Formatter застосовує послідовне розміщення пробілів і групування до всіх із них.
| Синтаксис | Назва | Примітки |
|---|---|---|
| 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 проти JSON проти YAML
TOML, JSON і YAML вирішують схожі задачі, але з різними компромісами.
| Особливість | TOML | JSON | YAML |
|---|---|---|---|
| Коментарі | # рядкові коментарі | Не підтримується | # рядкові коментарі |
| Типізовані значення | String, int, float, bool, datetime | String, number, bool, null | Автовизначення (ненадійно) |
| Вкладеність | Заголовки [table] | Фігурні дужки | На основі відступів |
| Суворість специфікації | Суворо (один результат парсингу) | Суворо (RFC 8259) | Нестрого (кілька валідних парсингів) |
| Підтримка дати/часу | 4 нативних типи | Відсутня (використовуйте рядки) | Неявна (ненадійна) |
| Завершальні коми | Не допускаються | Не допускаються | Н/Д (ком немає) |
Приклади коду
Наведені нижче приклади форматують TOML програмно у різних мовах та інструментах. Кожен зчитує файл, парсить його і записує відформатовану версію.
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