string - tutorial - yaml usos

En YAML, ¿cómo rompo una cadena en varias líneas?

Question

En YAML, tengo una cadena que es muy larga. Quiero mantener esto dentro de la vista de 80 columnas (o así) de mi editor, así que me gustaría romper la cadena ¿Cuál es la sintaxis de esto?

En otras palabras, tengo esto:

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

y me gustaría tener esto (o algo a este efecto):

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

Me gustaría usar citas como arriba, así que no necesito escapar de nada dentro de la cadena.

Answer 1

En caso de que estés utilizando yml y Twig para las traducciones en Symfony, y desees usar traducciones de varias líneas en Javascript, se agregará un retorno de carro justo después de la traducción. Así que incluso el siguiente código:

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

Que tiene la siguiente traducción yml:

key: >
    This is a
    multi line 
    translation.

Todavía resultará en el siguiente código en html:

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

Por lo tanto, el signo menos en Twig no resuelve esto. La solución es agregar este signo menos después del mayor que el inicio de sesión en yml:

key: >-
    This is a
    multi line 
    translation.

Tendrá el resultado adecuado, la traducción de varias líneas en una línea en Twig:

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

Answer 2

Hay 5 6 NUEVE (o 63 *, según cómo cuentes) diferentes formas de escribir cadenas de varias líneas en YAML.

Bloquear estilos escalares ( > , | )

Estos permiten caracteres como / y " sin escapar, y agregan una nueva línea ( /n ) al final de la cadena.

> estilo plegado elimina las nuevas líneas individuales dentro de la cadena (pero agrega una al final y convierte las nuevas líneas dobles en individuales):

Key: >
  this is my very very very
  long string

→ this is my very very very long string/n

| El estilo literal convierte cada nueva línea dentro de la cadena en una nueva línea literal, y agrega una al final:

Key: |
  this is my very very very 
  long string

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

Aquí está la definición oficial de la especificación YAML 1.2

El contenido escalar se puede escribir en notación de bloque, usando un estilo literal (indicado por "|") donde todos los saltos de línea son significativos. Alternativamente, se pueden escribir con el estilo plegado (denotado por ">") donde cada salto de línea se pliega a un espacio a menos que termine una línea vacía o con más sangría.

Estilos de bloque con indicador de chomping de bloque ( >- , |- , >+ , |+ )

Puede controlar el manejo de la nueva línea final en la cadena y cualquier línea en blanco al final ( /n/n ) agregando un carácter de indicador de bloque de bloques :

• > , | : "clip": mantenga el avance de línea, elimine las líneas en blanco finales.
• >- , |- : "strip": elimina el avance de línea, elimina las líneas en blanco finales.
• >+ , |+ : "mantener": mantener el avance de línea, mantener las líneas en blanco al final.

Estilos escalares de "flujo" ( , " , '' )

Estos tienen un escape limitado, y construyen una cadena de una sola línea sin nuevos caracteres de línea. Pueden comenzar en la misma línea que la tecla, o con nuevas líneas adicionales primero.

estilo simple (sin escape, sin # o : combinaciones, límites en el primer carácter):

Key: this is my very very very 
  long string

estilo de doble comillas ( / y " debe ser escapado por / , las nuevas líneas se pueden insertar con una secuencia literal /n , las líneas se pueden concatenar sin espacios con el final / ):

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

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

estilo de comillas simples (el literal '' debe duplicar, sin caracteres especiales, posiblemente útil para expresar cadenas que comienzan con comillas dobles):

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

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

Resumen

En esta tabla, _ significa space character . /n significa "carácter de nueva línea" ( /n en JavaScript), excepto por la fila de "nuevas líneas en línea", donde significa literalmente una barra invertida y una 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       |

Ejemplos

Tenga en cuenta los espacios finales en la línea antes de "espacios".

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

Estilos de bloques con indicadores de sangría.

En caso de que lo anterior no sea suficiente para usted, puede agregar un " indicador de sangría de bloque " (después de su indicador de masticación de bloques, si tiene uno):

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

Apéndice

Si inserta espacios adicionales al comienzo de las no-primeras líneas en estilo Plegado, se mantendrán con una nueva línea adicional. Esto no sucede con los estilos de flujo:

- >
    my long
      string
- my long
    string

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

Ni siquiera puedo

* 2 estilos de bloque, cada uno con 2 posibles indicadores de masticación de bloques (o ninguno), y con 9 posibles indicadores de sangría (o ninguno), 1 estilo simple y 2 estilos citados: 2 x (2 + 1) x (9 + 1) + 1 + 2 = 63

Parte de esta información también se ha resumido here .

Answer 3

Para concatenar líneas largas sin espacios en blanco , use comillas dobles y evite las nuevas líneas con barras invertidas:

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

(Gracias @Tobia)

Answer 4

Para preservar el uso de nuevas líneas | , por ejemplo:

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

se traduce a "Esta es una oración muy larga‌ / n que abarca varias líneas en el YAML‌ / n pero que se representará como una cadena‌ / n con nuevas líneas conservadas. / n "

Answer 5

Para situaciones en las que la cadena puede contener espacios o no, prefiero las comillas dobles y la continuación de la línea con barras invertidas:

key: "String /
  with long c/
  ontent"

Pero tenga en cuenta la trampa en el caso de que una línea de continuación comience con un espacio, debe ser evitada (porque se eliminará en otro lugar):

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

Si la cadena contiene saltos de línea, esto debe escribirse en estilo C /n .

Véase también esta pregunta .

Answer 6

Puede que no lo creas, pero YAML también puede hacer claves de varias líneas:

?
 >
 multi
 line
 key
:
  value

Answer 7

Usando el estilo plegado yaml, cada salto de línea se reemplaza por un espacio. La sangría en cada línea será ignorada.

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

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

Answer 8

1. Notación de bloque: las líneas nuevas se convierten en espacios y líneas adicionales después de que se elimina el bloque

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

...

JSON equivalente

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

2. Escalar del bloque literal: Un escalar del bloque literal | Incluirá las nuevas líneas y los espacios finales. pero elimina extra

Nuevas líneas tras el bloqueo.

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


...

JSON equivalente

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

3. Indicador + con Literal Block Scalar: mantener nuevas líneas adicionales después del bloque

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


...

JSON equivalente

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

4. - indicador con Lcalar de Bloque Literal: - significa que se quita la nueva línea al final de la cadena.

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


...

JSON equivalente

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

5. Escalar de bloque plegado (>):

doblará las nuevas líneas a los espacios y eliminará las nuevas líneas adicionales después del bloque.

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


...

JSON equivalente

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

Para más puedes visitar mi blog