Konwerter JSON na TOML

Czym jest TOML i dlaczego warto konwertować z JSON?

// Convert JSON to TOML in Node.js using the smol-toml library
import { stringify } from 'smol-toml';

const data = JSON.parse(`{
  "package": { "name": "my-app", "version": "1.0.0" },
  "dependencies": { "serde": { "version": "1.0" } }
}`);

// The top-level value must be an object; null values on objects are dropped.
const toml = stringify(data);

console.log(toml);
// [package]
// name = "my-app"
// version = "1.0.0"
//
// [dependencies.serde]
// version = "1.0"

Kluczowe funkcje

Przykłady

{
  "package": {
    "name": "my-app",
    "version": "1.0.0",
    "edition": "2021"
  },
  "dependencies": {
    "serde": { "version": "1.0", "features": ["derive"] },
    "tokio": { "version": "1", "features": ["full"] }
  }
}

{
  "build-system": {
    "requires": ["hatchling"],
    "build-backend": "hatchling.build"
  },
  "project": {
    "name": "my-package",
    "version": "0.3.1",
    "requires-python": ">=3.10",
    "dependencies": ["requests>=2.31", "pydantic>=2.0"]
  }
}

{
  "title": "My Service",
  "debug": false,
  "port": 8080,
  "database": {
    "host": "localhost",
    "port": 5432,
    "pool_size": 10
  },
  "features": ["auth", "metrics", "tracing"]
}

{
  "servers": [
    { "name": "alpha", "ip": "10.0.0.1", "ports": [8001, 8002] },
    { "name": "beta", "ip": "10.0.0.2", "ports": [9001] }
  ]
}

{
  "build": {
    "command": "npm run build",
    "publish": "dist",
    "environment": { "NODE_VERSION": "20" }
  },
  "redirects": [
    { "from": "/old", "to": "/new", "status": 301, "force": true }
  ]
}

{
  "tool": {
    "ruff": { "line-length": 100, "target-version": "py310" },
    "black": { "line-length": 100 }
  }
}

Jak używać

1. 1

   Wklej swój JSON

   Wpisz lub wklej swój JSON do pola wejściowego powyżej. Możesz też kliknąć „Wczytaj przykład”, aby wypróbować źródło Cargo.toml, źródło pyproject.toml lub obiekt ustawień aplikacji.

2. 2

   Zobacz wynik TOML na żywo

   TOML pojawia się natychmiast w panelu wyjściowym. Jeśli Twój JSON ma tablicę na najwyższym poziomie lub wartości null, narzędzie wyjaśnia dokładnie, co zrobić, zamiast tworzyć uszkodzony wynik.

3. 3

   Kopiuj lub pobierz

   Kliknij Kopiuj, aby przenieść TOML do schowka, lub Pobierz, aby zapisać go jako plik .toml gotowy dla Cargo, Poetry, Hugo, Netlify lub dowolnego narzędzia odczytującego TOML.

Typowe pułapki konwersji JSON na TOML

[1, 2, 3]

{ "items": [1, 2, 3] }

{ "name": "a", "nickname": null }

{ "name": "a", "nickname": "" }

{ "ports": [8001, null, 8003] }

{ "ports": [8001, 8003] }

{ 'name': 'a', 'active': true, }

{ "name": "a", "active": true }

{ "ratio": 1.0 }  →  ratio = 1

{ "ratio": 1.5 }  →  ratio = 1.5

{ "server": { "a": 1 }, "server": [1] }

{ "server": { "a": 1 }, "servers": [1] }

Typowe zastosowania

Generowanie Cargo.toml

Zamień ustrukturyzowany JSON — z narzędzia szkieletowego, API lub skryptu — na prawidłowy plik Cargo.toml języka Rust, z automatycznie tworzonymi zagnieżdżonymi tabelami [dependencies] i tabelami wbudowanymi.

Generowanie pyproject.toml

Konwertuj metadane projektu w JSON na plik pyproject.toml zgodny z PEP 621, w tym tabele z kropkami [tool.*], aby narzędzia wytwarzające JSON mogły produkować konfigurację pakowania Pythona.

Konfiguracja edytowalna przez człowieka z JSON

Przekształć ustawienia aplikacji w JSON na czytelny plik konfiguracyjny TOML, który ludzie mogą wygodnie edytować, z komentarzami dodanymi później ręcznie.

Generowanie konfiguracji wdrożenia

Twórz pliki netlify.toml, foundry.toml lub podobne konfiguracje platform z JSON, zamieniając zagnieżdżone obiekty i tablice obiektów na tabele i tablice tabel, których oczekują te narzędzia.

Migracja formatu konfiguracji

Przenieś konfigurację z systemu opartego na JSON do systemu opartego na TOML, używając tego konwertera jako pomostu oraz ostrzeżeń o null i najwyższym poziomie, aby wychwycić wszystko, co się nie odwzoruje.

Prototypowanie struktury TOML

Naszkicuj konfigurację jako JSON — format, który większość programistów pisze płynnie — a następnie przekonwertuj na TOML, aby zobaczyć idiomatyczny układ tabel i tablic tabel przed zatwierdzeniem go w repozytorium.

Szczegóły techniczne

Parsowanie JSON według RFC 8259

Dane wejściowe JSON są parsowane natywnym JSON.parse() przeglądarki, w pełni zgodnym z RFC 8259. Przed serializacją narzędzie sprawdza, czy wartość najwyższego poziomu jest obiektem, i skanuje wartości null, aby móc ostrzec o usuniętych kluczach obiektów lub odrzucić null wewnątrz tablicy z dokładną ścieżką.

Wynik TOML 1.0.0 przez smol-toml

TOML jest generowany za pomocą biblioteki smol-toml — serializatora bez zależności, w pełni zgodnego z TOML 1.0.0. Zagnieżdżone obiekty stają się tabelami, głęboko zagnieżdżone obiekty stają się tabelami z kropkami, a tablice obiektów stają się tablicami tabel. Liczby zmiennoprzecinkowe z zerową częścią ułamkową są zapisywane jako liczby całkowite zgodnie z regułami TOML, z ostrzeżeniem.

100% w przeglądarce — bez wysyłania, bez serwera

Całe przetwarzanie odbywa się w silniku JavaScript Twojej przeglądarki. Żadne dane nie są nigdzie przesyłane. Dane większe niż 200 KB przełączają się z trybu na żywo na tryb ręczny (jawne kliknięcie Konwertuj), aby interfejs pozostał responsywny.

Najlepsze praktyki

Opakowuj tablice najwyższego poziomu pod kluczem

Jeśli Twoje dane są naturalnie tablicą JSON, przed konwersją opakuj je w obiekt z opisowym kluczem ({ "items": [...] }). Dokumenty TOML muszą być tabelą w korzeniu, a klucz nadaje Twojej tablicy jasną nazwę w wyniku.

Zdecyduj, co mają oznaczać wartości null

Przed konwersją zdecyduj, czy pole null ma zniknąć (usunięcie klucza), czy nieść wartość. TOML usunie wartości null w obiektach i odrzuci wartości null w tablicach, więc rozwiązanie ich najpierw w JSON daje przewidywalny, kompletny wynik.

Używaj zagnieżdżonych obiektów do grupowania

Grupuj powiązane ustawienia w zagnieżdżone obiekty w swoim JSON — stają się one czystymi [tabelami] i tabelami z kropkami w TOML, co jest znacznie czytelniejsze niż płaska lista kluczy i odpowiada temu, jak zorganizowane są konfiguracje Cargo i pyproject.

Najpierw sprawdź poprawność swojego JSON

Jeśli Twój JSON jest pisany ręcznie lub pochodzi z niepewnego źródła, sprawdź go naszym formaterem JSON, aby wychwycić końcowe przecinki i błędy w cudzysłowach przed konwersją na TOML.

Dodaj komentarze po konwersji

JSON nie ma komentarzy, więc żaden się nie przeniesie. Ponieważ TOML obsługuje komentarze #, dodaj dokumentację do wygenerowanego TOML ręcznie — to jeden z głównych powodów, dla których w ogóle przenosi się konfigurację edytowaną przez ludzi do TOML.

Często zadawane pytania