Publicado em 9/24/2013 – Versão de texto

TOML v0.2.0

Tom's Obvious, Minimal Language.

Por Tom Preston-Werner.

Fique ciente de que esta especificação ainda está mudando muito. Até que seja marcado como 1.0, você deve presumir que é instável e agir de acordo.

Objetivos

TOML visa ser um formato de arquivo de configuração mínimo que seja fácil de ler devido à semântica óbvia. O TOML foi projetado para mapear inequivocamente para uma tabela de hash. O TOML deve ser fácil de analisar em estruturas de dados em uma ampla variedade de idiomas.

Especificação

TOML é case-sensitive, ou seja, diferencia maiúsculo de minúsculo.
Espaço em branco significa tabulação (0x09) ou espaço (0x20).

Comentário

Fale o que pensa com o símbolo de cerquilha. Eles vão do símbolo até o final da linha.

# Sou um comentário. Ouça-me rugir. Grrrrr.
chave = "valor" # É, você pode fazer isso.

String

Dica Pro™: Você pode notar que esta especificação é a mesma que a definição de string do JSON, exceto que TOML requer codificação UTF-8. Isso é de propósito.

Strings são valores uma única linha colocadas entre aspas. Strings devem conter apenas caracteres UTF-8 válidos. Qualquer caractere Unicode pode ser usado exceto aqueles que devem ter escape: aspas, barra invertida e os caracteres de controle (U+0000 a U+001F).

"Sou uma string. \"Você me colocar entre aspas\". Nome\tJos\u00E9\nLocal\tSF."

Por conveniência, alguns caracteres populares têm uma sequência de escape compacta.

\b     - backspace         (U+0008)
\t     - tabulação         (U+0009)
\n     - linefeed          (U+000A)
\f     - form feed         (U+000C)
\r     - carriage return   (U+000D)
\"     - aspas             (U+0022)
\/     - barra             (U+002F)
\\     - barra invertida   (U+005C)
\uXXXX - unicode           (U+XXXX)

Qualquer caractere Unicode pode ser escapado com a forma \uXXXX.

Outros caracteres especiais são reservados e, se usados, TOML deve produzir um erro. Isso significa que os caminhos no Windows sempre terão que usar barras invertidas duplas.

errado = "C:\Users\nodejs\templates" # note: não produz um caminho válido
correto = "C:\\Users\\nodejs\\templates"

Para dados binários, é recomendável usar Base64 ou outra codificação ASCII ou UTF-8 adequada. A manipulação dessa codificação será específica do aplicativo.

Inteiro

Números inteiros são números simples, sozinhos. Sentindo-se negativo? Faça o que é natural. Tamanho mínimo de 64 bits esperado.

42
-17

Ponto flutuante

Pontos flutuantes são números com um único ponto dentro. Deve haver pelo menos um número em cada lado da vírgula. Precisão (dupla) de 64 bits esperada.

3.1415
-0.01

Booleano

Booleanos são apenas os tokens com os quais você está acostumado. Sempre minúsculos.

true
false

Data e hora

Datas/horas são datas ISO 8601, mas apenas a forma zulu completa é permitida.

1979-05-27T07:32:00Z

Array

Arrays são colchetes com outros primitivos dentro. O espaço em branco é ignorado. Os elementos são separados por vírgulas. Os tipos de dados podem ser misturados.

[ 1, 2, 3 ]
[ "vermelho", "amarelo", "verde" ]
[ [ 1, 2 ], [3, 4, 5] ]
[ [ 1, 2 ], ["a", "b", "c"] ] # tudo bem
[ 1, 2.0 ] # nota: isso NÃO está correto

Arrays também podem ser multilinhas. Portanto, além de ignorar os espaços em branco, os arrays também ignoram as novas linhas entre os colchetes. As vírgulas de terminação são aceitas antes do colchete de fechamento.

chave = [
  1, 2, 3
]

chave = [
  1,
  2, # tudo bem
]

Tabela

Tabelas (também conhecidas como tabelas hash ou dicionários) são coleções de pares chave/valor. Elas aparecem entre colchetes em uma linha própria. Você pode diferenciá-las de arrays porque os arrays são apenas valores.

[tabela]

Abaixo disso, e até o próximo cabeçalho ou EOF, estão as chaves/valores dessa tabela. As chaves estão à esquerda do sinal de igual e os valores à direita. Chaves começam com o primeiro caractere diferente de espaço em branco e terminam com o último caractere diferente de espaço em branco antes do sinal de igual. Pares chave/valor dentro de tabelas não são ordenadas.

[tabela]
chave = "valor"

Você pode recuar as chaves e seus valores o quanto quiser. Tabulações ou espaços. Fique à vontade. Por que, você pergunta? Porque você pode ter tabelas aninhadas. Massa demais.

As tabelas aninhadas são indicadas por nomes de tabela com pontos. Nomeie suas tabelas como quiser, apenas não use um ponto. Ponto é reservado. OBEDEÇA.

[cachorro.batatinha]
tipo = "pug"

Na terra do JSON, isso resultaria na seguinte estrutura:

{ "cachorro": { "batatinha": { "tipo": "pug" } } }

Você não precisa especificar todas as supertabelas se não quiser. TOML sabe como fazer isso para você.

# [x] você
# [x.y] não
# [x.y.z] precisa disso
[x.y.z.w] # para que isso funcione

Tabelas vazias são permitidas e simplesmente não possuem pares chave/valor dentro delas.

Desde que uma supertabela não tenha sido definida diretamente e não tenha definido uma chave específica, você ainda pode escrever nela.

[a.b]
c = 1

[a]
d = 2

Você não pode definir nenhuma chave ou tabela mais de uma vez. Fazer isso é inválido.

# NÃO FAÇA ISSO

[a]
b = 1

[a]
c = 2

# TAMBÉM NÃO FAÇA ISSO

[a]
b = 1

[a.b]
c = 2

Array de tabelas

A última sintaxe que ainda não foi expressa é um array de tabelas. Este pode ser expresso usando um nome de tabela entre colchetes duplos. Cada tabela com o mesmo nome entre colchetes duplos será um elemento no array. As tabelas são inseridas no array na ordem encontrada. Uma tabela com colchetes duplos sem nenhum par chave/valor será considerada uma tabela vazia.

[[produtos]]
nome = "Martelo"
sku = 738594937

[[produtos]]

[[produtos]]
nome = "Prego"
sku = 284758393
cor = "cinza"

Na terra do JSON, isso resultaria na seguinte estrutura.

{
  "produtos": [
    { "nome": "Martelo", "sku": 738594937 },
    { },
    { "nome": "Prego", "sku": 284758393, "color": "cinza" }
  ]
}

Você também pode criar arrays aninhados de tabelas. Basta usar a mesma sintaxe de colchetes duplos nas subtabelas. Cada subtabela entre colchetes pertencerá ao elemento de tabela definido mais recentemente acima dela.

[[fruta]]
  nome = "uva"

  [fruta.fisico]
    cor = "roxa"
    forma = "redonda"

  [[fruta.variedade]]
    nome = "roxa deliciosa"

  [[fruta.variedade]]
    nome = "cabernet sauvignon"


[[fruta]]
  nome = "banana"

  [[fruta.variedade]]
    nome = "banana-da-terra"

O TOML acima é mapeado para o seguinte JSON.

{
  "fruta": [
    {
      "nome": "uva",
      "fisico": {
        "cor": "roxa",
        "forma": "redonda"
      },
      "variedade": [
        { "nome": "roxa deliciosa" },
        { "nome": "cabernet sauvignon" }
      ]
    },
    {
      "nome": "banana",
      "variedade": [
        { "nome": "banana-da-terra" }
      ]
    }
  ]
}

A tentativa de definir uma tabela normal com o mesmo nome de um array já estabelecido deve produzir um erro no momento da análise.

# DOCUMENTO TOML INVÁLIDO
[[fruta]]
  nome = "uva"

  [[fruta.variedade]]
    nome = "roxa deliciosa"

  # Esta tabela conflita com a tabela anterior
  [fruta.variedade]
    nome = "cabernet sauvignon"