Як перервати рядок на кілька рядків?

У YAML у мене дуже довга струна. Я хочу зберегти це в перегляді 80-стовпчиків мого редактора, тому я хотів би перервати рядок. Який для цього синтаксис?

Іншими словами, у мене це:

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

і я хотів би мати це (або щось в цьому плані):

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

Я хотів би використовувати лапки, як описано вище, тому мені не потрібно нічого уникати в рядку.

Використовуючи складний стиль 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/

Існує 5 6 дев'яти (або 63 *, залежно від того, як ви рахуєте) різних способів запису багаторядкових рядків у YAML.

TL; DR

• Зазвичай вам потрібно >:

  key: >
    Your long
    string here.
  

• Якщо ви хочете, щоб \nрядкові рядки зберігалися як у рядку (наприклад, вбудована розмітка з абзацами), використовуйте |.

  key: |
    ### Heading
  
    * Bullet
    * Points
  

• Використовуйте >-або |-замість цього, якщо ви не хочете, щоб рядковий рядок додався в кінці.

• Якщо вам потрібно розділити рядки в середині слів або буквально ввести рядкові рядки як \n, використовуйте замість цього подвійні лапки:

  key: "Antidisestab\
   lishmentarianism.\n\nGet on it."
  

• ЯМЛ божевільний.

Блокувати скалярні стилі ( >, |)

Вони дозволяють таким символам, як \і "без втечі, і додають новий рядок ( \n) до кінця рядка.

> Складений стиль видаляє поодинокі рядки в рядку (але додає в кінці і перетворює подвійні нові рядки в сингли):

Key: >
  this is my very very very
  long string

→ this is my very very very long string\n

| Літеральний стиль перетворює кожну нову рядок у рядку в буквальний новий рядок, а в кінці додає:

Key: |
  this is my very very very 
  long string

→ this is my very very very\nlong string\n

Ось офіційне визначення з YAML Spec 1.2

Скалярний вміст може бути записаний у блокові позначення, використовуючи буквальний стиль (позначений «|»), де всі розриви рядків значні. Крім того, вони можуть бути записані у складеному стилі (позначається ">"), коли кожен розрив рядка складений на пробіл, якщо він не закінчується порожнім чи більш відрізним рядком.

Блок стилів з індикатором блоку плямкання ( >-, |-, >+, |+)

Ви можете керувати обробкою остаточного нового рядка в рядку та будь-якими проміжними порожніми рядками ( \n\n), додавши символ індикатора блоку, що чіпує :

• >, |: "clip": зберігайте подачу рядків, видаляйте пробіли.
• >-, |-: "strip": видаліть подачу рядків, видаліть проміжні порожні рядки.
• >+, |+: "утримувати": зберігати канал рядків, тримати пробіли в рядках.

"Потік" стилі скалярні ( , ", ')

Вони мають обмежене пробіг та створюють однорядковий рядок без нових символів рядка. Вони можуть починатися з того самого рядка, що і ключ, або спочатку з додатковими новими рядками.

не звичайний стиль (не дінеться, що не#або:комбінація, обмеження на першому символі):

Key: this is my very very very 
  long string

стиль з подвійним цитуванням (\і його"потрібно уникати\, нові рядки можна вставляти з буквальною\nпослідовністю; рядки можна з'єднувати без пробілів із заднім числом\):

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

→ "this is my very very \"very\" loooong string.\n\nLove, YAML."

Стиль з одним цитуванням (буквальне'повинно бути подвоєне, жодних спеціальних символів, можливо, корисних для вираження рядків, починаючи з подвійних лапок):

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

→ "this is my very very \"very\" long string, isn't it."

Підсумок

У цій таблиці _засоби space character. \nозначає "символ нового рядка" ( \nу JavaScript), за винятком рядка "рядкові нові рядки", де він означає буквально зворотну косу рису та n).

                      >     |            "     '     >-     >+     |-     |+
-------------------------|------|-----|-----|-----|------|------|------|------  
Trailing spaces   | Kept | Kept |     |     |     | Kept | Kept | Kept | Kept
Single newline => | _    | \n   | _   | _   | _   | _    |  _   | \n   | \n
Double newline => | \n   | \n\n | \n  | \n  | \n  | \n   |  \n  | \n\n | \n\n
Final newline  => | \n   | \n   |     |     |     |      |  \n  |      | \n
Final dbl nl's => |      |      |     |     |     |      | Kept |      | Kept  
In-line newlines  | No   | No   | No  | \n  | No  | No   | No   | No   | No
Spaceless newlines| No   | No   | No  | \   | No  | No   | No   | No   | No 
Single quote      | '    | '    | '   | '   | ''  | '    | '    | '    | '
Double quote      | "    | "    | "   | \"  | "   | "    | "    | "    | "
Backslash         | \    | \    | \   | \\  | \   | \    | \    | \    | \
" #", ": "        | Ok   | Ok   | No  | Ok  | Ok  | Ok   | Ok   | Ok   | Ok
Can start on same | No   | No   | Yes | Yes | Yes | No   | No   | No   | No
line as key       |

Приклади

Зверніть увагу на пробіли в рядку перед "пробілами".

- >
  very "long"
  'string' with

  paragraph gap, \n and        
  spaces.
- | 
  very "long"
  'string' with

  paragraph gap, \n and        
  spaces.
- very "long"
  'string' with

  paragraph gap, \n and        
  spaces.
- "very \"long\"
  'string' with

  paragraph gap, \n and        
  s\
  p\
  a\
  c\
  e\
  s."
- 'very "long"
  ''string'' with

  paragraph gap, \n and        
  spaces.'
- >- 
  very "long"
  'string' with

  paragraph gap, \n and        
  spaces.

[
  "very \"long\" 'string' with\nparagraph gap, \\n and         spaces.\n", 
  "very \"long\"\n'string' with\n\nparagraph gap, \\n and        \nspaces.\n", 
  "very \"long\" 'string' with\nparagraph gap, \\n and spaces.", 
  "very \"long\" 'string' with\nparagraph gap, \n and spaces.", 
  "very \"long\" 'string' with\nparagraph gap, \\n and spaces.", 
  "very \"long\" 'string' with\nparagraph gap, \\n and         spaces."
]

Стилі блоків з індикаторами відступу

На випадок, якщо вищезазначене вам недостатньо, ви можете додати " індикатор відступу блоку " (після того, як ваш індикатор блокується, якщо у вас є):

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

Додаток

Якщо ви вставите додаткові пробіли на початку не перших рядків у складеному стилі, вони зберігатимуться з бонусним новим рядком. Це не відбувається зі стилями потоку:

- >
    my long
      string
- my long
    string

→ ["my long\n string\n", "my long string"]

Я навіть не можу.

*2 стилі блоків, кожен з 2 можливими індикаторами відбивання блоку (або жодним), та з 9 можливими індикаторами відступу (або жодним), 1 простим стилем та 2 цитованими стилями: 2 x (2 + 1) x (9 + 1) + 1 + 2 = 63

Частина цієї інформації також була узагальнена тут .

Для збереження нових рядків використовуйте |, наприклад:

|
  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 "

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"
}

докладніше ви можете відвідати мій блог

Ви можете не повірити, але YAML також може робити багаторядкові клавіші:

?
 >
 multi
 line
 key
:
  value

Щоб об'єднати довгі рядки без пробілів , використовуйте подвійні лапки та вийдіть з нових рядків із зворотним нахилом:

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

(Дякую @Tobia)

Якщо ви використовуєте YAML та Twig для перекладів в Symfony та хочете використовувати багаторядковий переклад у 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.";

Для ситуацій, якщо рядок може містити пробіли чи ні, я віддаю перевагу подвійним лапочкам та продовження рядків з косою рисою:

key: "String \
  with long c\
  ontent"

Але зауважте про підводний камінь для випадку, коли лінія продовження починається з пробілу, його потрібно уникнути (оскільки його буде знято в іншому місці):

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

Якщо рядок містить розриви рядків, це повинно бути написано в стилі C \n.

Дивіться також це питання .

Жодне з перерахованих вище рішень не працювало для мене у файлі YAML в рамках проекту Jekyll. Спробувавши багато варіантів, я зрозумів, що введення HTML з "" <br>може бути також добре, оскільки врешті-решт все надається в HTML:

ім'я: | У селі Ла-Манча <br>, ім'я якого я не <br>хочу згадувати.

Принаймні, це працює для мене. Немає уявлення про проблеми, пов'язані з цим підходом.