YAML Multi-Line Arrays

Question

In YAML, you can easily create multi-line strings. However, I would like the ability to create a multi-line array (mainly for readibility within config files) using the | character.

A YAML array can be represented as: ['key1', 'key2', 'key3'].

A YAML sequence uses a dash followed by a space and then a string:

- String1
- String2
- String3

This would evaluate to: ['string1', 'string2', 'string3'].

A YAML mapping is an array of key and value pairs that we see all the time in YAML:

Key1: string1
Key2: string2
Key3: string3

This is all well and good, but I can't for the life of me see how to do a multi-line array. Something like this:

|
['string1', 'string2', 'string3']
['string4', 'string5', 'string6']

Short of creating multiple array mappings in YAML and merging them in my programming language of choice, is there any way to achieve multi-line arrays, maybe with { } like Python has but in YAML?

honestly, whats a multi-line array & when should it be meaningful at all? Rather than just the looks of your code — OK999
– OK999, Commented Oct 22, 2017 at 15:32
Having to scroll across the screen horizontally to see all the options rather than see them all one one screen at once. — Jimbo
– Jimbo, Commented Oct 22, 2017 at 16:53
Multi-line may make diffs much more readable, since every item added or removed corresponds to 1 line added or removed. — XedinUnknown
– XedinUnknown, Commented Jun 15, 2021 at 7:34
@XedinUnknown Good technical argument and reasoning - version control usage is impacted less with future changes. Thanks for sharing. — Jimbo
– Jimbo, Commented Jun 16, 2021 at 11:16

Steve Bennett · Accepted Answer · 2015-10-14 21:51:57Z

504

A YAML sequence is an array. So this is the right way to express it:

key:
  - string1
  - string2      
  - string3
  - string4
  - string5
  - string6

That's identical in meaning to:

key: ['string1', 'string2', 'string3', 'string4', 'string5', 'string6']

It's also legal to split a single-line array over several lines:

key: ['string1', 'string2', 'string3', 
  'string4', 'string5', 
  'string6']

and even have multi-line strings in single-line arrays:

key: ['string1', 'long
  string', 'string3', 'string4', 'string5', 'string6']

answered Oct 14, 2015 at 21:51

Steve Bennett

130k45 gold badges189 silver badges249 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

ekkis Over a year ago

is it an issue if the strings start with a - (e.g. options passed in the command line)? do I then have to quote? ` - "-myarg"`?

Steve Bennett Over a year ago

That depends totally on whatever program you're using to parse the YAML. This question is just about the YAML specification.

Iwan B. · Accepted Answer · 2018-09-20 10:25:41Z

96

have you tried this?

-
  name: Jack
  age: 32
-
  name: Claudia
  age: 25

I get this: [{"name"=>"Jack", "age"=>32}, {"name"=>"Claudia", "age"=>25}] (I use the YAML Ruby class).

answered Sep 20, 2018 at 10:25

Iwan B.

4,2062 gold badges31 silver badges19 bronze badges

Comments

Vinicius · Accepted Answer · 2020-06-01 21:54:00Z

26

If what you are needing is an array of arrays, you can do this way:

key:
  - [ 'value11', 'value12', 'value13' ]
  - [ 'value21', 'value22', 'value23' ]

answered Jun 1, 2020 at 21:54

Vinicius

6086 silver badges10 bronze badges

2 Comments

Jimbo Over a year ago

Thanks Vinicius, but the question explicitly stated: ".I would like the ability to create a multi-line array", not multiple lines of multiple arrays.

nisseknudsen Over a year ago

didn't realize the question wasn't exactly mine, but came for this - thanks @Vinicius

Yee · Accepted Answer · 2014-08-27 17:51:03Z

13

The following would work:

myarray: [
  String1, String2, String3,
  String4, String5, String5, String7
]

I tested it using the snakeyaml implementation, I am not sure about other implementations though.

answered Aug 27, 2014 at 17:51

Yee

9511 gold badge9 silver badges14 bronze badges

1 Comment

Walid Over a year ago

it worked with Puppet Enterprise 3.7 hiera yaml (Ruby yaml) one thing I find ruby yaml is quite sensitive too is the identation, and avoid using tabs. so example above should be like in two lines idented same number of spaces where first line is myarray: [String1, String2, String3, and second line is ` String4, String5, String5, String7 ] `

Asclepius · Accepted Answer · 2021-05-15 15:23:06Z

7

The following works for me and its good from readability point of view when the number of array element values is small:

key: [string1, string2, string3, string4, string5, string6]

This has been tested to work with snakeyaml and ruamel.yaml.

edited May 15, 2021 at 15:23

Asclepius

65k20 gold badges188 silver badges166 bronze badges

answered May 17, 2019 at 15:04

Harsimranjit Singh Kler

2,3922 gold badges20 silver badges22 bronze badges

Collectives™ on Stack Overflow

YAML Multi-Line Arrays

5 Answers 5

2 Comments

Comments

2 Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

2 Comments

Comments

2 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related