如何将 YAML 中的字符串拆分为多行？

Question

我有一个很长的字符串：

Key: 'this is my very very very very very very long string'

我想通过多个较短的行来表达它，例如，

Key: 'this is my very very very ' +
     'long string'

我想使用上面的引号，这样我就不需要转义字符串中的任何内容。

Answer 1

在 Jekyll 项目中的 YAML 文件中，上述解决方案都不适合我。在尝试了多种选项之后，我意识到使用
进行 HTML 注入也可以，因为最终所有内容都会呈现为 HTML：

name: |
在拉曼查的一个村庄
，我
不想记住它的名字。

至少它对我有用。不知道与此方法相关的问题。

Answer 2

有 5 6 九（或 63*，具体取决于您的计数方式）在 YAML 中编写多行字符串的不同方法。

TL;DR

• 大多数情况下使用 >：内部换行符会被删除，尽管最后会得到一个换行符：

  <前><代码>键：>
  你的长
  字符串在这里。

• 如果您希望保留这些换行符，请使用 |作为 \n （例如，带有段落的嵌入式降价）。

  <前><代码>键：|
  ### 标题

  * 项目符号
  * 积分

• 如果您不想在末尾附加换行符，请使用 >- 或 |-。

• 如果您需要在单词中间分割行或想要按字面意思将换行符键入为 \n，请使用 "..."：

   键：“Antidisestab\
     lishmentarianism。\n\n继续吧。”
  

• YAML 太疯狂了。

块标量样式（>、|）

这些允许诸如 \ 和 " 之类的字符无需转义，并添加在字符串末尾添加一个新行 (\n)

折叠样式删除字符串中的单个换行符（但在末尾添加一个换行符，并将双换行符转换为单行符）：

Key: >
  this is my very very very
  long string

→ this是我非常非常长的字符串\n

保留额外的前导空格并导致额外的换行符。请参阅下面的

注释：通常这就是您想要的

。 文字样式
将字符串中的每个换行符转换为文字换行符，并在末尾添加一个换行符：

Key: |
  this is my very very very 
  long string

→ 这是我非常非常\n长字符串\n

这是来自 YAML 规范 1.2

标量内容可以使用文字样式（用“|”表示）以块表示法编写，其中所有换行符都很重要。或者，可以使用折叠样式（用“>”表示）编写它们，其中每个换行符都会折叠到一个空格，除非它以空行或多缩进行结束。

建议：使用它来插入格式化文本（尤其是 Markdown）作为值。

带有块剪切指示符的块样式（>-、|-、>+、|+

）可以通过添加 块 chomping 指示符 字符：

• >, |: "clip"：保留换行，删除尾随空白行。
• >-、|-: "strip"：去除换行符，去除尾随空白行。
• >+、|+: "keep"：保留换行，保留尾随空白行。

“Flow”标量样式（、"、'）

这些样式具有有限的转义，并构造一个不带换行符的单行字符串。它们可以与键在同一行开始，或者首先添加额外的换行符，双倍换行符将成为一个换行符

。 /flow/plain" rel="noreferrer">普通样式（无转义，无 # 或 : 组合，第一个字符不能是 "、' 或许多其他标点符号）：

Key: this is my very very very 
  long string

建议：避免。可能看起来很方便，但您可能会因为不小心使用禁止的标点符号并触发语法错误而搬起石头砸自己的脚。

双引号样式 (\ 和 " 必须通过 \ 转义，可以使用文字 \n 序列插入换行符，可以连接行没有空格，尾随 \)：

Key: "this is my very very \"very\" loooo\
  ng string.\n\nLove, YAML."

→ “这是我非常非常“非常”的字符串。\n\n爱，YAML。

建议：在非常具体的情况下使用 唯一方法，并且可能在中间添加换行符是有用的。

这是在不添加空格的情况下跨行打破很长的标记（如 URL）的 org/spec/1.2/#style/flow/single-quoted" rel="noreferrer">单引号样式（文字 ' 必须双倍，无特殊字符，对于表达以双引号开头的字符串可能有用）：

Key: 'this is my very very "very"
  long string, isn''t it.'

→ “这是我非常非常“非常”长的字符串，不是吗。”

建议：很少有好处，主要是不便。 如果

带有缩进指示符的块样式

以上内容对您来说还不够，您可以添加“块缩进指示器”（在块压缩指示器之后，如果有的话）：

- >8
        My long string
        starts over here
- |+1
 This one
 starts here

注意：折叠样式中的前导空格 (>)

如果您在非开头插入额外的空格- 折叠样式的第一行将被保留，并带有额外的换行符。 （流样式不会发生这种情况。）第 6.5 节：

此外，折叠不适用于包含前导空格的文本行周围的换行符。请注意，这样的缩进较多的行可能仅包含这样的前导空格。

- >
    my long
      string
                    
    many spaces above
- my long
      string
                    
    many spaces above
    

→ ["my long\n string\n \n上面有很多空格\n","my long string\n上面有很多空格"]

摘要

在此表中： _ 表示 < code>空格字符，\n表示“换行符”，除非另有说明。 “前导空格”是指第二行上的附加空格字符，而第一行仅为空格（用于建立缩进）。

	>	|	>-	|-	>+	| +		"	'
空格/换行符转换为：
尾随空格 →	_	_	_	_	_	_
前导空格 →	\n_	\n_	\n_	\n_	\n_	\n_
单换行符 →	_	\n	\	_	n _	\n	_	_	_
双换行符 →	\n	\n\n	\n	\n\	n	\n \n	\n	\n \n	\n
最后换行 →	\n	\n			\n	\n
最后的双换行符 →	\n	\n			\n\n	\n\n
如何创建文字：
单引号	'	'	'	'	'	'	'	'	其他
双引号	"	"	"	"	"	"	"	\"	"
反斜杠	\	\	\	\	\	\\	\ \	\
功能
内嵌换行符 \n

Answer 3

使用yaml折叠样式。每行中的缩进将被忽略。将在末尾插入换行符。

Key: >
  This is a very long sentence
  that spans several lines in the YAML
  but which will be rendered as a string
  with only a single carriage return appended to the end.

http://symfony.com/doc/current/components/yaml/yaml_format.html

您可以使用“块剪切指示器”来消除尾随换行符，如下所示：

Key: >-
  This is a very long sentence
  that spans several lines in the YAML
  but which will be rendered as a string
  with NO carriage returns.

在任何一种情况下，每个换行符都会替换为空格。

还有其他可用的控制工具（例如用于控制缩进）。

请参阅 https://yaml-multiline.info/

Answer 4

要保留换行符，请使用|，例如：

Key: |
  This is a very long sentence
  that spans several lines in the YAML
  but which will be rendered as a string
  with newlines preserved.

翻译为“这是一个非常长的句子‌**\n**，跨越多行在 YAML‌**\n** 中，但它将呈现为字符串‌**\n** 并保留换行符。\n”

Answer 5

1.块表示法（普通、流式、标量）： 删除块后换行符变为空格和多余的换行符

---
# Note: It has 1 new line after the string
content:
    Arbitrary free text
    over multiple lines stopping
    after indentation changes...

...

等效 JSON

{
 "content": "Arbitrary free text over multiple lines stopping after indentation changes..."
}

2.文字块标量： 文字块标量 | 将包含换行符和任何尾随空格。但删除

块后多余的换行符。

---
# After string we have 2 spaces and 2 new lines
content1: |
 Arbitrary free text
 over "multiple lines" stopping
 after indentation changes...  


...

等效 JSON

{
 "content1": "Arbitrary free text\nover \"multiple lines\" stopping\nafter indentation changes...  \n"
}

3. + 带有文字块标量的指示器： 在块后保留额外的换行符

---
# After string we have 2 new lines
plain: |+
 This unquoted scalar
 spans many lines.


...

等效 JSON

{
 "plain": "This unquoted scalar\nspans many lines.\n\n\n"
}

4. – 带文字块标量的指示器： – 表示删除字符串末尾的换行符。

---
# After string we have 2 new lines
plain: |-
 This unquoted scalar
 spans many lines.


...

等效 JSON

{
 "plain": "This unquoted scalar\nspans many lines."
}

5.折叠块标量(>)：

将换行符折叠为空格，但会删除块后多余的换行符。

---
folded_newlines: >
 this is really a
 single line of text
 despite appearances


...

等效 JSON

{
 "fold_newlines": "this is really a single line of text despite appearances\n"
}

有关更多信息，您可以访问我的博客

Answer 6

要连接长行不带空格，请使用双引号并使用反斜杠转义换行符：

key: "Loremipsumdolorsitamet,consecteturadipiscingelit,seddoeiusmodtemp\
  orincididuntutlaboreetdoloremagnaaliqua."

Answer 7

你可能不相信，YAML 也可以做多行键：

?
 >
 multi
 line
 key
:
  value

Answer 8

如果您在 Symfony 中使用 YAML 和 Twig 进行翻译，并且想要在 Javascript 中使用多行翻译，则会在翻译后立即添加回车符。因此，即使是以下代码：

var javascriptVariable = "{{- 'key'|trans -}}";

其中有以下 yml 翻译：

key: >
    This is a
    multi line 
    translation.

仍然会在 html 中生成以下代码：

var javascriptVariable = "This is a multi line translation.
";

因此， Twig 中的减号并不能解决这个问题。解决方案是在 yml 中的大于号后面添加这个减号：

key: >-
    This is a
    multi line 
    translation.

将得到正确的结果，在 Twig 中的一行上进行多行翻译：

var javascriptVariable = "This is a multi line translation.";

Answer 9

对于字符串可能包含空格或不包含空格的情况，我更喜欢双引号和带反斜杠的续行：

key: "String \
  with long c\
  ontent"

但请注意续行以空格开头的情况的陷阱，需要对其进行转义（因为它将被剥离）其他地方）：

key: "String\
  \ with lon\
  g content"

如果字符串包含换行符，则需要以 C 风格 \n 编写。

另请参阅此问题。

Answer 10

如果上述解决方案都不适合您，请尝试在 HTML 元素上添加 white-space: pre-line ，并按如下所示设置翻译值：

key: "Line1\nLine2"