Jak przerwać ciąg w wielu wierszach?

W YAML mam ciąg, który jest bardzo długi. Chcę to zachować w 80-kolumnowym widoku mojego edytora, więc chciałbym przerwać ciąg. Jaka jest składnia tego?

Innymi słowy, mam to:

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

i chciałbym mieć to (lub coś w tym celu):

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

Chciałbym użyć cytatów jak powyżej, więc nie muszę uciekać przed niczym w ciągu.

Używając stylu yaml złożonego, każdy podział linii jest zastępowany spacją. Wcięcie w każdej linii zostanie zignorowane. Podział linii zostanie wstawiony na końcu.

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

Możesz użyć „wskaźnika chompowania bloków”, aby wyeliminować przerwanie linii końcowej w następujący sposób:

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.

Dostępne są również inne narzędzia kontrolne (na przykład do kontrolowania wcięć).

Zobacz https://yaml-multiline.info/

Istnieje 5 6 Dziewięć (lub 63 *, w zależności od tego, jak się liczy) różnych sposobów pisania ciągów wieloliniowych w YAML.

TL; DR

• Zwykle chcesz >:

  key: >
    Your long
    string here.
  

• Jeśli chcesz, aby podziały wierszy były zachowywane jak \nw ciągu (na przykład osadzone znakowanie akapitu), użyj |.

  key: |
    ### Heading
  
    * Bullet
    * Points
  

• Użyj >-lub |-zamiast tego, jeśli nie chcesz dołączać podziału linii na końcu.

• Jeśli chcesz podzielić wiersze na środku słów lub dosłownie wpisać podziały wiersza jako \n, użyj podwójnych cudzysłowów:

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

• YAML jest szalony.

Blokuj style skalarne ( >, |)

Pozwalają one na znaki takie jak \ i "bez ucieczki oraz dodają nową linię ( \n) na końcu łańcucha.

> Styl zagięty usuwa pojedyncze znaki nowego ciągu (ale dodaje jeden na końcu i konwertuje podwójne znaki nowego na pojedyncze):

Key: >
  this is my very very very
  long string

→ this is my very very very long string\n

| Dosłowny styl zamienia każdą nową linię w ciągu w dosłowną nową linię i dodaje jedną na końcu:

Key: |
  this is my very very very 
  long string

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

Oto oficjalna definicja z YAML Spec 1.2

Treść skalarną można zapisać w notacji blokowej, używając literalnego stylu (oznaczonego „|”), w którym wszystkie podziały linii są znaczące. Alternatywnie, można je pisać stylem złożonym (oznaczonym jako „>”), w którym każdy podział linii jest składany na spację, chyba że kończy się pusta lub bardziej wcięta linia.

Style bloku z bloku chomping wskaźnik ( >-, |-,>+ , |+)

Możesz kontrolować obsługę ostatniego nowego wiersza w łańcuchu i dowolnych końcowych pustych linii ( \n\n), dodając znak wskaźnika chompingowania bloku :

• >, | : „clip”: utrzymuj linię, usuń końcowe puste linie.
• >-, |- : „strip”: usuń linię, usuń końcowe puste linie.
• >+, |+: „keep”: utrzymuj linię, kontynuuj puste linie.

"Flow" style skalarne ( , ",' )

Mają one ograniczone znaki ucieczki i konstruują łańcuch jednowierszowy bez żadnych nowych znaków linii. Mogą zaczynać się w tym samym wierszu co klawisz lub najpierw z dodatkowymi znakami nowej linii.

zwykły styl (ma ucieczki, nie ma#lub:kombinacje ograniczeń pierwszego znaku):

Key: this is my very very very 
  long string

styl podwójnego cudzysłowu (\i"musi być\poprzedzony znakiemucieczki, znaki nowej linii można wstawiać w dosłownej\nkolejności, linie można łączyć bez spacji z końcowymi znakami\):

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

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

styl pojedynczego cudzysłowu (literał'musi być podwojony, bez znaków specjalnych, być może przydatne do wyrażania ciągów zaczynających się od podwójnych cudzysłowów):

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

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

Podsumowanie

W tej tabeli _oznacza space character. \noznacza „znak nowej linii” ( \nw JavaScript), z wyjątkiem wiersza „wbudowane znaki nowej linii”, gdzie dosłownie oznacza to odwrotny ukośnik i 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       |

Przykłady

Zwróć uwagę na końcowe spacje w wierszu przed „spacjami”.

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

Blokuj style za pomocą wskaźników wcięcia

Na wypadek gdyby powyższe nie było dla Ciebie wystarczające, możesz dodać „ wskaźnik wcięcia bloku ” (po wskaźniku chompingowania bloku, jeśli taki masz):

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

Uzupełnienie

Jeśli wstawisz dodatkowe spacje na początku nie-pierwszych wierszy w stylu zagiętym, zostaną one zachowane z nową linią bonusową. Nie dzieje się tak w przypadku stylów przepływu:

- >
    my long
      string
- my long
    string

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

Nawet nie umiem.

*2 style bloków, każdy z 2 możliwymi wskaźnikami chompowania bloków (lub brak) i 9 możliwymi wskaźnikami wcięcia (lub brak), 1 styl zwykły i 2 stylami cytowanymi: 2 x (2 + 1) x (9 + 1) + 1 + 2 = 63

Niektóre z tych informacji zostały również tutaj streszczone .

Aby zachować nowe wiersze, użyj |na przykład:

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

jest tłumaczone na „To jest bardzo długie zdanie‌ \ n, które obejmuje kilka wierszy w YAML‌ \ n, ale które będzie renderowane jako ciąg‌ \ n z zachowanymi znakami nowej linii. \ n ”

1. Notacja bloku (zwykła, płynna, skalarna): nowe linie stają się spacjami i dodatkowe nowe linie po usunięciu bloku

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

...

Odpowiednik JSON

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

2. Dosłowna skalarna blokowa: dosłowna skalarna blokowa |będą zawierać znaki nowej linii i wszelkie spacje końcowe. ale usuwa dodatkowe

nowe linie po bloku.

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


...

Odpowiednik JSON

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

3. + wskaźnik z dosłowną skalą bloku: zachowaj dodatkowe znaki nowej linii po bloku

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


...

Odpowiednik JSON

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

4. - wskaźnik z dosłowną skalą blokową: - oznacza, że ​​nowa linia na końcu łańcucha jest usuwana.

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


...

Odpowiednik JSON

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

5. Skalarny składany blok (>):

będzie składać nowe wiersze do spacji, ale usuwa dodatkowe nowe wiersze po bloku.

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


...

Odpowiednik JSON

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

więcej możesz odwiedzić mój blog

Możesz w to nie wierzyć, ale YAML może także wykonywać klucze wieloliniowe:

?
 >
 multi
 line
 key
:
  value

Aby połączyć długie linie bez spacji , użyj podwójnych cudzysłowów i unikaj znaków nowej linii za pomocą odwrotnych ukośników:

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

(Dzięki @Tobia)

Jeśli używasz YAML i Twig do tłumaczeń w Symfony i chcesz używać tłumaczeń wieloliniowych w JavaScript, zwrot karetki jest dodawany zaraz po tłumaczeniu. Więc nawet następujący kod:

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

Który ma następujące tłumaczenie yml:

key: >
    This is a
    multi line 
    translation.

Nadal spowoduje powstanie następującego kodu w html:

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

Tak więc znak minus w Twig nie rozwiązuje tego. Rozwiązaniem jest dodanie tego znaku minus po znaku większy niż znak w yml:

key: >-
    This is a
    multi line 
    translation.

Będzie mieć poprawny wynik, tłumaczenie wielu wierszy w jednym wierszu w Twig:

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

W sytuacjach, w których łańcuch może zawierać spacje lub nie, wolę podwójne cudzysłowy i kontynuację wiersza z odwrotnymi ukośnikami:

key: "String \
  with long c\
  ontent"

Ale zwróć uwagę na pułapkę w przypadku, gdy linia kontynuacji zaczyna się od spacji, należy ją uciec (ponieważ zostanie usunięta w innym miejscu):

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

Jeśli ciąg zawiera podziały wiersza, należy to zapisać w stylu C. \n .

Zobacz także to pytanie .

Żadne z powyższych rozwiązań nie działało dla mnie w pliku YAML w ramach projektu Jekyll. Po wypróbowaniu wielu opcji, zdałem sobie sprawę, że wstrzyknięcie HTML<br> może również zrobić, ponieważ ostatecznie wszystko jest renderowane do HTML:

imię: | W wiosce La Mancha, <br>której imienia nie znam<br> chcę pamiętać.

Przynajmniej to działa dla mnie. Nie ma pojęcia o problemach związanych z tym podejściem.