TOML

TOML

TOML

Configuration file format

Tom's Obvious, Minimal Language (TOML) is a file format for configuration files.[3] It is intended to be easy to read and write due to obvious semantics which aim to be "minimal", and it is designed to map unambiguously to a dictionary. Originally created by Tom Preston-Werner, its specification is open source. TOML is used in a number of software projects[4][5][6] and is implemented in many programming languages.[7]

Quick Facts Filename extension, Internet media type ...

Syntax

TOML's syntax primarily consists of key = value pairs, [section names], and # (for comments). TOML's syntax somewhat resembles that of .INI files, but it includes a formal specification, whereas the INI file format suffers from many competing variants.

Its specification includes a list of supported data types: String, Integer, Float, Boolean, Datetime, Array, and Table.

Example

# This is a TOML document.

title = "ImpalaPay Co."

[database]
server = "192.168.1.1"
ports = [ 8000, 8001, 8002 ]
connection_max = 5000
enabled = true

# Line breaks are OK when inside arrays
hosts = [
  "alpha",
  "omega"
]

[servers]

  # Indentation (tabs and/or spaces) is allowed but not required
  [servers.alpha]
  ip = "10.0.0.1"
  dc = "eqdc10"

  [servers.beta]
  ip = "10.0.0.2"
  dc = "eqdc10"

Use cases

TOML is used in a variety of settings (some related to its creator), such as:

Criticism

TOML has been criticized on a number of points:[11][12]

  • TOML is verbose; it is not DRY and syntactically noisy.
  • TOML's hierarchies can be difficult to infer from syntax alone.
  • Overcomplication: Like YAML, TOML has too many features.
  • In TOML the syntax determines the data types ("syntax typing").

See also

References

  1. [1]
    There is a mime type proposal for TOML consisting in application/toml, but this has never been officially registered among IANA's Media Types.
  2. [2]
    "Release 1.0.0". 12 January 2021. Retrieved 17 January 2021.
  3. [3]
    Preston-Werner, Tom; Gedam, Pradyun (January 11, 2021). "TOML: English v1.0.0". Retrieved January 27, 2024.
  4. [4]
    "The Manifest Format - The Cargo Book". doc.rust-lang.org.
  5. [5]
    Drew DeVault (2021-07-28). "My wish-list for the next YAML". YAML is both universally used, and universally reviled. It has a lot of problems, but it also is so useful in solving specific tasks that it's hard to replace. Some new kids on the block (such as TOML) have successfully taken over a portion of its market share, but it remains in force in places where those alternatives show their weaknesses.
  6. [6]
    "TOML: Tom's Obvious Minimal Language". toml.io. Retrieved 2022-08-08.
  7. [7]
    "toml-lang/toml". GitHub. 23 May 2022.
  8. [8]
    "tomllib — Parse TOML files". Python documentation. Retrieved 2023-07-08.
  9. [9]
    "The Manifest Format - The Cargo Book". doc.rust-lang.org. Retrieved 2023-07-08.
  10. [10]
    "10. Project.toml and Manifest.toml · Pkg.jl". pkgdocs.julialang.org. Retrieved 2023-07-08.
  11. [11]
    What is wrong with TOML?
  12. [12]
    An INI critique of TOML
Share this article:

This article uses material from the Wikipedia article TOML, and is written by contributors. Text is available under a CC BY-SA 4.0 International License; additional terms may apply. Images, videos and audio are available under their respective licenses.