发布于 2014 年 11 月 11 日 – 文本版本

TOML v0.3.1

Tom's Obvious, Minimal Language（Tom 的显而易见、极简语言）。

作者：Tom Preston-Werner。

请注意，此规范仍在发生大量变化。在标记为 1.0 之前，您应该假设它是不稳定的，并相应地采取行动。

目标

TOML 旨在成为一种极简的配置文件格式，由于其明显的语义，易于阅读。TOML 旨在明确地映射到哈希表。TOML 应该易于解析为各种语言中的数据结构。

规范

TOML 区分大小写。
空白字符指制表符 (0x09) 或空格 (0x20)。

注释

使用井号表达你的想法。它们从井号到行尾。

# I am a comment. Hear me roar. Roar.
key = "value" # Yeah, you can do this.

字符串

有四种方法可以表达字符串：基本字符串、多行基本字符串、字面字符串和多行字面字符串。所有字符串都必须仅包含有效的 UTF-8 字符。

**基本字符串**用双引号括起来。可以使用任何 Unicode 字符，但必须转义的字符除外：双引号、反斜杠和控制字符 (U+0000 到 U+001F)。

"I'm a string. \"You can quote me\". Name\tJos\u00E9\nLocation\tSF."

为方便起见，一些常用字符具有紧凑的转义序列。

\b         - backspace       (U+0008)
\t         - tab             (U+0009)
\n         - linefeed        (U+000A)
\f         - form feed       (U+000C)
\r         - carriage return (U+000D)
\"         - quote           (U+0022)
\/         - slash           (U+002F)
\\         - backslash       (U+005C)
\uXXXX     - unicode         (U+XXXX)
\UXXXXXXXX - unicode         (U+XXXXXXXX)

可以使用\uXXXX 或\UXXXXXXXX 形式转义任何 Unicode 字符。请注意，转义代码必须是有效的 Unicode 代码点。

其他特殊字符是保留字符，如果使用，TOML 应产生错误。

专业提示™：您可能会注意到，以上字符串规范与 JSON 的字符串定义相同，除了 TOML 要求 UTF-8 编码。这是故意的。

有时您需要表达文本段落（例如翻译文件）或希望将非常长的字符串分解成多行。TOML 使这变得很容易。**多行基本字符串**两侧都用三个双引号括起来，并允许换行符。如果起始分隔符后的第一个字符是换行符 (0x0A)，则将其修剪。所有其他空白字符保持不变。

# The following strings are byte-for-byte equivalent:
key1 = "One\nTwo"
key2 = """One\nTwo"""
key3 = """
One
Two"""

为了编写长字符串而不引入多余的空白字符，请在行尾使用\。\ 将与所有空白字符（包括换行符）一起被修剪，直到下一个非空白字符或结束分隔符。如果起始分隔符后的前两个字符是反斜杠和换行符 (0x5C0A)，则它们将与所有空白字符（包括换行符）一起被修剪，直到下一个非空白字符或结束分隔符。所有对基本字符串有效的转义序列也对多行基本字符串有效。

# The following strings are byte-for-byte equivalent:
key1 = "The quick brown fox jumps over the lazy dog."

key2 = """
The quick brown \


  fox jumps over \
    the lazy dog."""

key3 = """\
       The quick brown \
       fox jumps over \
       the lazy dog.\
       """

可以使用任何 Unicode 字符，但必须转义的字符除外：反斜杠和控制字符 (U+0000 到 U+001F)。双引号无需转义，除非其存在会导致过早的结束分隔符。

如果您经常指定 Windows 路径或正则表达式，那么不得不转义反斜杠很快就会变得乏味且容易出错。为了提供帮助，TOML 支持字面字符串，其中根本不允许转义。**字面字符串**用单引号括起来。与基本字符串一样，它们必须出现在一行上。

# What you see is what you get.
winpath  = 'C:\Users\nodejs\templates'
winpath2 = '\\ServerX\admin$\system32\'
quoted   = 'Tom "Dubs" Preston-Werner'
regex    = '<\i\c*\s*>'

由于没有转义，因此无法在用单引号括起来的字面字符串中写入单引号。幸运的是，TOML 支持字面字符串的多行版本，它解决了此问题。**多行字面字符串**两侧都用三个单引号括起来，并允许换行符。与字面字符串一样，没有任何转义。如果起始分隔符后的第一个字符是换行符 (0x0A)，则将其修剪。分隔符之间所有其他内容都按原样解释，无需修改。

regex2 = '''I [dw]on't need \d{2} apples'''
lines  = '''
The first newline is
trimmed in raw strings.
   All other whitespace
   is preserved.
'''

对于二进制数据，建议您使用 Base64 或其他合适的 ASCII 或 UTF-8 编码。该编码的处理方式将是特定于应用程序的。

整数

整数是整数。正数可以以加号为前缀。负数以减号为前缀。

不允许前导零。不允许使用十六进制、八进制和二进制形式。不允许使用“infinity”和“not a number”等无法表示为一系列数字的值。

预期为 64 位（带符号长整型）范围（−9,223,372,036,854,775,808 到 9,223,372,036,854,775,807）。

浮点数

浮点数由整数部分（可以以加号或减号为前缀）后跟小数部分和/或指数部分组成。如果同时存在小数部分和指数部分，则小数部分必须位于指数部分之前。

# fractional
+1.0
3.1415
-0.01

# exponent
5e+22
1e6
-2E-2

# both
6.626e-34

小数部分是小数点后跟一个或多个数字。

指数部分是 E（大写或小写）后跟整数部分（可以以加号或减号为前缀）。

预期为 64 位（双精度）精度。

布尔值

布尔值只是您习惯使用的标记。始终使用小写。

true
false

日期时间

日期时间是RFC 3339 日期。

1979-05-27T07:32:00Z
1979-05-27T00:32:00-07:00
1979-05-27T00:32:00.999999-07:00

数组

数组是用方括号括起来的，其中包含其他基本类型。忽略空白字符。元素用逗号分隔。数据类型不能混合。

[ 1, 2, 3 ]
[ "red", "yellow", "green" ]
[ [ 1, 2 ], [3, 4, 5] ]
[ [ 1, 2 ], ["a", "b", "c"] ] # this is ok
[ 1, 2.0 ] # note: this is NOT ok

数组也可以是多行的。因此，除了忽略空白字符外，数组还忽略方括号之间的换行符。在结束括号之前允许使用结尾逗号。

key = [
  1, 2, 3
]

key = [
  1,
  2, # this is ok
]

表

表（也称为哈希表或字典）是键值对的集合。它们单独出现在一行上的方括号中。您可以将它们与数组区分开来，因为数组永远只是值。

[table]

在该表下，直到下一个表或文件结尾 (EOF) 都是该表的键值对。键位于等号的左侧，值位于等号的右侧。键以第一个不是空白字符或[ 的字符开头，并以等号之前最后一个非空白字符结尾。键不能包含# 字符。表中的键值对不保证按任何特定顺序排列。

[table]
key = "value"

您可以根据需要缩进键及其值。制表符或空格。随意使用。你问为什么？因为你可以拥有嵌套表。太棒了。

嵌套表由带有点的表名称表示。随意命名您的表，但不要使用#、.、[ 或]。

[dog.tater]
type = "pug"

在 JSON 中，这将为您提供以下结构

{ "dog": { "tater": { "type": "pug" } } }

如果您不想指定所有超级表，则无需指定。TOML 知道如何为您做到这一点。

# [x] you
# [x.y] don't
# [x.y.z] need these
[x.y.z.w] # for this to work

允许使用空表，并且它们根本不包含任何键值对。

只要超级表尚未直接定义并且尚未定义特定键，您仍然可以写入它。

[a.b]
c = 1

[a]
d = 2

您不能多次定义任何键或表。这样做是无效的。

# DO NOT DO THIS

[a]
b = 1

[a]
c = 2

# DO NOT DO THIS EITHER

[a]
b = 1

[a.b]
c = 2

所有表名和键都必须是非空的。

# NOT VALID TOML
[]
[a.]
[a..b]
[.b]
[.]
 = "no key name" # not allowed

表数组

尚未表达的最后一种类型是表数组。这些可以通过在双括号中使用表名来表达。每个具有相同双括号名称的表都将是数组中的一个元素。表按遇到的顺序插入。没有键值对的双括号表将被视为空表。

[[products]]
name = "Hammer"
sku = 738594937

[[products]]

[[products]]
name = "Nail"
sku = 284758393
color = "gray"

在 JSON 中，这将为您提供以下结构。

{
  "products": [
    { "name": "Hammer", "sku": 738594937 },
    { },
    { "name": "Nail", "sku": 284758393, "color": "gray" }
  ]
}

您也可以创建嵌套的表数组。只需在子表上使用相同的双括号语法即可。每个双括号子表都将属于其上最近定义的表元素。

[[fruit]]
  name = "apple"

  [fruit.physical]
    color = "red"
    shape = "round"

  [[fruit.variety]]
    name = "red delicious"

  [[fruit.variety]]
    name = "granny smith"

[[fruit]]
  name = "banana"

  [[fruit.variety]]
    name = "plantain"

上面的 TOML 映射到以下 JSON。

{
  "fruit": [
    {
      "name": "apple",
      "physical": {
        "color": "red",
        "shape": "round"
      },
      "variety": [
        { "name": "red delicious" },
        { "name": "granny smith" }
      ]
    },
    {
      "name": "banana",
      "variety": [
        { "name": "plantain" }
      ]
    }
  ]
}

尝试定义与已建立数组同名的普通表必须在解析时产生错误。

# INVALID TOML DOC
[[fruit]]
  name = "apple"

  [[fruit.variety]]
    name = "red delicious"

  # This table conflicts with the previous table
  [fruit.variety]
    name = "granny smith"