程式設計免不了要寫配置檔案，怎麼寫配置也是一門學問。
YAML 是專門用來寫配置檔案的語言，非常簡潔和強大，遠比 JSON 格式方便。
本文介紹 YAML 的語法，以 JS-YAML 的實現為例。你可以去線上 Demo 驗證下面的例子。
一、簡介
YAML 語言（發音 /ˈjæməl/ ）的設計目標，就是方便人類讀寫。它實質上是一種通用的資料序列化格式。
它的基本語法規則如下。
- 大小寫敏感
- 使用縮排表示層級關係
- 縮排時不允許使用Tab鍵，只允許使用空格。
- 縮排的空格數目不重要，只要相同層級的元素左側對齊即可
# 表示註釋，從這個字元一直到行尾，都會被解析器忽略。
YAML 支援的資料結構有三種。
- 物件：鍵值對的集合，又稱為對映（mapping）/ 雜湊（hashes） / 字典（dictionary）
- 陣列：一組按次序排列的值，又稱為序列（sequence） / 列表（list）
- 純量（scalars）：單個的、不可再分的值
以下分別介紹這三種資料結構。
二、物件
物件的一組鍵值對，使用冒號結構表示。
animal: pets
轉為 JavaScript 如下。
{ animal: 'pets' }
Yaml 也允許另一種寫法，將所有鍵值對寫成一個行內物件。
hash: { name: Steve, foo: bar }
轉為 JavaScript 如下。
{ hash: { name: 'Steve', foo: 'bar' } }
三、陣列
一組連詞線開頭的行，構成一個陣列。
- Cat - Dog - Goldfish
轉為 JavaScript 如下。
[ 'Cat', 'Dog', 'Goldfish' ]
資料結構的子成員是一個陣列，則可以在該項下面縮排一個空格。
- - Cat - Dog - Goldfish
轉為 JavaScript 如下。
[ [ 'Cat', 'Dog', 'Goldfish' ] ]
陣列也可以採用行內表示法。
animal: [Cat, Dog]
轉為 JavaScript 如下。
{ animal: [ 'Cat', 'Dog' ] }
四、複合結構
物件和陣列可以結合使用，形成複合結構。
languages: - Ruby - Perl - Python websites: YAML: yaml.org Ruby: ruby-lang.org Python: python.org Perl: use.perl.org
轉為 JavaScript 如下。
{ languages: [ 'Ruby', 'Perl', 'Python' ], websites: { YAML: 'yaml.org', Ruby: 'ruby-lang.org', Python: 'python.org', Perl: 'use.perl.org' } }
五、純量
純量是最基本的、不可再分的值。以下資料型別都屬於 JavaScript 的純量。
- 字串
- 布林值
- 整數
- 浮點數
- Null
- 時間
- 日期
數值直接以字面量的形式表示。
number: 12.30
轉為 JavaScript 如下。
{ number: 12.30 }
布林值用true和false表示。
isSet: true
轉為 JavaScript 如下。
{ isSet: true }
null用~表示。
parent: ~
轉為 JavaScript 如下。
{ parent: null }
時間採用 ISO8601 格式。
iso8601: 2001-12-14t21:59:43.10-05:00
轉為 JavaScript 如下。
{ iso8601: new Date('2001-12-14t21:59:43.10-05:00') }
日期採用複合 iso8601 格式的年、月、日表示。
date: 1976-07-31
轉為 JavaScript 如下。
{ date: new Date('1976-07-31') }
YAML 允許使用兩個感嘆號，強制轉換資料型別。
e: !!str 123 f: !!str true
轉為 JavaScript 如下。
{ e: '123', f: 'true' }
六、字串
字串是最常見，也是最複雜的一種資料型別。
字串預設不使用引號表示。
str: 這是一行字串
轉為 JavaScript 如下。
{ str: '這是一行字串' }
如果字串之中包含空格或特殊字元，需要放在引號之中。
str: '內容： 字串'
轉為 JavaScript 如下。
{ str: '內容: 字串' }
單引號和雙引號都可以使用，雙引號不會對特殊字元轉義。
s1: '內容\n字串' s2: "內容\n字串"
轉為 JavaScript 如下。
{ s1: '內容\\n字串', s2: '內容\n字串' }
單引號之中如果還有單引號，必須連續使用兩個單引號轉義。
str: 'labor''s day'
轉為 JavaScript 如下。
{ str: 'labor\'s day' }
字串可以寫成多行，從第二行開始，必須有一個單空格縮排。換行符會被轉為空格。
str: 這是一段 多行 字串
轉為 JavaScript 如下。
{ str: '這是一段 多行 字串' }
多行字串可以使用|保留換行符，也可以使用>摺疊換行。
this: | Foo Bar that: > Foo Bar
轉為 JavaScript 程式碼如下。
{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }
+表示保留文字塊末尾的換行，-表示刪除字串末尾的換行。
s1: | Foo s2: |+ Foo s3: |- Foo
轉為 JavaScript 程式碼如下。
{ s1: 'Foo\n', s2: 'Foo\n\n\n', s3: 'Foo' }
字串之中可以插入 HTML 標記。
message: | <p style="color: red"> 段落 </p>
轉為 JavaScript 如下。
{ message: '\n<p style="color: red">\n 段落\n</p>\n' }
七、引用
錨點&和別名*，可以用來引用。
defaults: &defaults adapter: postgres host: localhost development: database: myapp_development <<: test:="" database:="" myapp_test="">
等同於下面的程式碼。
defaults: adapter: postgres host: localhost development: database: myapp_development adapter: postgres host: localhost test: database: myapp_test adapter: postgres host: localhost
&用來建立錨點（defaults），<<表示合併到當前資料，*用來引用錨點。
下面是另一個例子。
- &showell Steve - Clark - Brian - Oren - *showell
轉為 JavaScript 程式碼如下。
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]
八、函式和正規表示式的轉換
這是 JS-YAML 庫特有的功能，可以把函式和正規表示式轉為字串。
# example.yml fn: function () { return 1 } reg: /test/
解析上面的 yml 檔案的程式碼如下。
var yaml = require('js-yaml'); var fs = require('fs'); try { var doc = yaml.load( fs.readFileSync('./example.yml', 'utf8') ); console.log(doc); } catch (e) { console.log(e); }
從 JavaScript 物件還原到 yaml 檔案的程式碼如下。
var yaml = require('js-yaml'); var fs = require('fs'); var obj = { fn: function () { return 1 }, reg: /test/ }; try { fs.writeFileSync( './example.yml', yaml.dump(obj), 'utf8' ); } catch (e) { console.log(e); }
九、參考連結
（完）