yamllint - Online en la nube

PROGRAMA:

NOMBRE

yamllint-

Un linter para archivos YAML.

yamllint no solo verifica la validez de la sintaxis, sino también las rarezas como la repetición de teclas
y problemas cosméticos como la longitud de las líneas, los espacios finales, la sangría, etc.

CAPTURA DE PANTALLA

[imagen: captura de pantalla de yamllint] [imagen]

NOTA:
El formato de salida predeterminado está inspirado en eslint, una gran herramienta de linting para Javascript.

MESA DE NOCHE OF CONTENIDO

Inicio rápido
La instalación de yamlint
En Fedora / CentOS:

sudo dnf instalar yamllint

En Debian 9+ / Ubuntu 16.04+:

sudo apt-get install yamllint

En versiones anteriores de Debian / Ubuntu:

sudo add-apt-repository -y ppa: adrienverge / ppa && sudo apt-get update
sudo apt-get install yamllint

Alternativamente, usando pip, el administrador de paquetes de Python:

sudo pip instalar yamllint

Si prefiere instalar desde la fuente, puede ejecutar, desde el directorio de la fuente:

python setup.py sdist
sudo pip install dist / yamllint - *. tar.gz

Correr yamlint
Uso básico:

yamllint file.yml otro-file.yaml

También puede filtrar todos los archivos YAML en un directorio completo:

yamllint.

La salida se verá así (los colores no se muestran aquí):

archivo.yml
1: 4 espacios finales de error (espacios finales)
Error 4: 4 sangría incorrecta: se esperaba 4 pero se encontró 3 (sangría)
5: 4 error de duplicación de la clave "id-00042" en el mapeo (claves duplicadas)
6: 6 comentario de advertencia sin sangría como contenido (comentarios-sangría)
12: 6 error demasiados espacios después del guión (guiones)
15:12 error demasiados espacios antes de la coma (comas)

otro-archivo.yaml
Advertencia 1: 1 que falta el inicio del documento "---" (inicio del documento)
6:81 línea de error demasiado larga (87> 80 caracteres) (longitud de línea)
Error 10: 1 demasiadas líneas en blanco (4> 2) (líneas vacías)
11: 4 error demasiados espacios dentro de llaves (llaves)

Agregar el formulario -f analizable argumentos si necesita un formato de salida analizable por una máquina (para
instancia para sintaxis destacando in texto editores). La salida se verá así:

file.yml: 6: 2: [advertencia] falta el espacio de inicio en el comentario (comentarios)
file.yml: 57: 1: [error] espacios finales (espacios finales)
file.yml: 60: 3: [error] sangría incorrecta: se esperaba 4 pero se encontró 2 (sangría)

Si tiene un archivo de configuración de linting personalizado (consulte cómo a configurar yamlint), puede ser
pasado a yamllint usando el -c opción:

yamlint -c ~ / myconfig archivo.yaml

NOTA:
Si usted tiene una .yamllint archivo en su directorio de trabajo, se cargará automáticamente
como configuración por yamllint.

Configuration
yamllint usa un conjunto de reglas para comprobar los archivos de origen en busca de problemas. Cada regla es independiente
de los demás, y se puede habilitar, deshabilitar o modificar. Todas estas configuraciones pueden ser
reunidos en un archivo de configuración.

Para usar un archivo de configuración personalizado, asígnele el nombre .yamllint en su directorio de trabajo, o
utilice el -c opción:

yamlint -c ~ / myconfig archivo.yaml

"Predeterminado" configuración
A menos que se indique lo contrario, yamllint utiliza su tu préstamo estudiantil de configuración:

. . .

reglas:
tirantes:
min-espacios-interior: 0
max-espacios-interior: 0
soportes:
min-espacios-interior: 0
max-espacios-interior: 0
dos puntos:
max-espacios-antes: 0
max-espacios-después: 1
comas:
max-espacios-antes: 0
min-espacios-después: 1
max-espacios-después: 1
comentarios:
nivel: advertencia
require-start-space: sí
espacios-mínimos-del-contenido: 2
comentarios-sangría:
nivel: advertencia
final del documento: deshabilitar
inicio de documento:
nivel: advertencia
presente: si
líneas vacías:
máx: 2
arranque máximo: 0
final máximo: 0
guiones:
max-espacios-después: 1
sangría:
espacios: consistente
secuencias de sangría: sí
comprobar cadenas de varias líneas: no
duplicados de clave: habilitar
Longitud de la línea:
máx: 80
permitir-palabras-no-rompibles: sí
nueva línea al final del archivo: habilitar
nuevas líneas:
tipo: unix
espacios finales: habilitar

Los detalles sobre las reglas se pueden encontrar en el reglas página.

Hay otra configuración predefinida llamada relajado. Como sugiere su nombre, es más
tolerante.

Se puede elegir mediante:

yamllint -d relajado file.yml

Extensión el tu préstamo estudiantil configuración
Al escribir un archivo de configuración personalizado, no es necesario redefinir todas las reglas. Solo
extender el tu préstamo estudiantil configuración (o cualquier archivo de configuración ya existente).

Por ejemplo, si solo desea deshabilitar el comentarios-sangría regla, su archivo podría
se parece a esto:

# ¡Este es mi primer archivo de configuración para yamllint!
# Extiende la configuración predeterminada ajustando algunas opciones.

extiende: predeterminado

reglas:
comentarios-sangría: deshabilitar # no me molestes con esta regla

Del mismo modo, si desea configurar el Longitud de la línea gobernar como una advertencia y ser menos estricto en
sangría de secuencias de bloques:

extiende: predeterminado

reglas:
# 80 caracteres deberían ser suficientes, pero no falle si una línea es más larga
Longitud de la línea:
máx: 80
nivel: advertencia

# aceptar ambas claves:
# - artículo
#
# y clave:
# - artículo
sangría:
secuencias de sangría: lo que sea

Personalizado configuración sin a config presentar
Es posible, aunque no se recomienda, pasar opciones de configuración personalizadas a
yamllint con el -d (corto para --config-datos) opción.

Su contenido puede ser el nombre de una configuración predefinida (ejemplo: tu préstamo estudiantil or relajado) o
un objeto YAML serializado que describe la configuración.

Por ejemplo:

yamllint -d "{extiende: relajado, reglas: {longitud de línea: {máximo: 120}}}" archivo.yaml

Errores y advertencias
Los problemas detectados por yamllint pueden presentarse como errores o como advertencias.

En ambos casos, el script los generará (con diferentes colores cuando se usa el estándar
formato de salida), pero el código de salida puede ser diferente. Más precisamente, el guión saldrá
habrá un código de falla only when hay uno o más errores.

Reglas
Al enlazar un documento con yamllint, una serie de reglas (como Longitud de la línea,
espacios finales, etc.) se comprueban.

A configuración presentar se puede utilizar para habilitar o deshabilitar estas reglas, para establecer su nivel
(error or de advertencia de ugencia), sino también para modificar sus opciones.

Esta página describe las reglas y sus opciones.

Lista of reglas
· frenillos

· soportes

· colonias

· comas

· comentarios

· comentarios-sangría

· final del documento

· inicio de documento

· lineas vacias

· guiones

· sangría

· duplicados de claves

· Longitud de la línea

· nueva línea al final del archivo

· nuevas líneas

· espacios finales

frenillos
Utilice esta regla para controlar el número de espacios entre llaves ({ y }). Opciones.INDENT 0.0

· min-espacios-dentro define el número mínimo de espacios requeridos dentro de las llaves.

· max-espacios-interior define el número máximo de espacios permitidos entre llaves.
1. Con tirantes: {min-espacios-dentro: 0, max-espacios-interior: 0}

el siguiente fragmento de código PASS:

objeto: {clave1: 4, clave2: 8}

el siguiente fragmento de código FALLO:

objeto: {clave1: 4, clave2: 8}

2. Con tirantes: {min-espacios-dentro: 1, max-espacios-interior: 3}

el siguiente fragmento de código PASS:

objeto: {clave1: 4, clave2: 8}

el siguiente fragmento de código PASS:

objeto: {clave1: 4, clave2: 8}

el siguiente fragmento de código FALLO:

objeto: {clave1: 4, clave2: 8}

el siguiente fragmento de código FALLO:

objeto: {clave1: 4, clave2: 8}

soportes
Utilice esta regla para controlar el número de espacios entre corchetes ([ y ]). Opciones.INDENT
0.0

· min-espacios-dentro define el número mínimo de espacios requeridos entre corchetes.

· max-espacios-interior define el número máximo de espacios permitidos entre corchetes.
1. Con soportes: {min-espacios-dentro: 0, max-espacios-interior: 0}

el siguiente fragmento de código PASS:

objeto: [1, 2, abc]

el siguiente fragmento de código FALLO:

objeto: [1, 2, abc]

2. Con soportes: {min-espacios-dentro: 1, max-espacios-interior: 3}

el siguiente fragmento de código PASS:

objeto: [1, 2, abc]

el siguiente fragmento de código PASS:

objeto: [1, 2, abc]

el siguiente fragmento de código FALLO:

objeto: [1, 2, abc]

el siguiente fragmento de código FALLO:

objeto: [1, 2, abc]

colonias
Utilice esta regla para controlar el número de espacios antes y después de los dos puntos (:). Opciones.INDENT
0.0

· max-espacios-antes define el número máximo de espacios permitidos antes de los dos puntos (use -1 a
desactivar).

· max-espacios-después define el número máximo de espacios permitidos después de dos puntos (use -1 a
desactivar).
1. Con dos puntos: {max-espacios-antes: 0, max-espacios-después: 1}

el siguiente fragmento de código PASS:

:
- a
- B
valor clave

2. Con dos puntos: {max-espacios-antes: 1}

el siguiente fragmento de código PASS:

objeto:
- a
- B

el siguiente fragmento de código FALLO:

objeto:
- a
- B

3. Con dos puntos: {max-espacios-after: 2}

el siguiente fragmento de código PASS:

primero: 1
segundo: 2
tercero: 3

el siguiente fragmento de código FALLO:

primero: 1
2do: 2
tercero: 3

comas
Utilice esta regla para controlar el número de espacios antes y después de las comas (,). Opciones.INDENT
0.0

· max-espacios-antes define el número máximo de espacios permitidos antes de las comas (use -1 a
desactivar).

· min-espacios-después define el número mínimo de espacios necesarios después de las comas.

· max-espacios-después define el número máximo de espacios permitidos después de las comas (use -1 a
desactivar).
1. Con comas: {max-espacios-antes: 0}

el siguiente fragmento de código PASS:

extraña var:
[10, 20, 30, {x: 1, y: 2}]

el siguiente fragmento de código FALLO:

extraña var:
[10, 20, 30, {x: 1, y: 2}]

2. Con comas: {max-espacios-antes: 2}

el siguiente fragmento de código PASS:

extraña var:
[10, 20, 30, {x: 1, y: 2}]

3. Con comas: {max-espacios-antes: -1}

el siguiente fragmento de código PASS:

extraña var:
[10,
20, 30
, {x: 1, y: 2}]

4. Con comas: {min-espacios-después: 1, max-espacios-después: 1}

el siguiente fragmento de código PASS:

extraña var:
[10, 20,30, {x: 1, y: 2}]

el siguiente fragmento de código FALLO:

extraña var:
[10, 20,30, {x: 1, y: 2}]

5. Con comas: {min-espacios-después: 1, max-espacios-después: 3}

el siguiente fragmento de código PASS:

extraña var:
[10, 20, 30, {x: 1, y: 2}]

6. Con comas: {min-espacios-después: 0, max-espacios-después: 1}

el siguiente fragmento de código PASS:

extraña var:
[10, 20,30, {x: 1, y: 2}]

comentarios
Utilice esta regla para controlar la posición y el formato de los comentarios. Opciones.INDENT 0.0

· Usar requiere-espacio-de-inicio para requerir un carácter de espacio justo después del #. Ajustado a si a
habilitar, no deshabilitar.

· min-espacios-de-contenido se utiliza para separar visualmente los comentarios en línea del contenido. Eso
define el número mínimo requerido de espacios entre un comentario y su precedente
contenido.
1. Con comentarios: {require-start-space: sí}

el siguiente fragmento de código PASS:

# Esta oración
# es un comentario de bloque

el siguiente fragmento de código FALLO:

#Esta oración
#es un comentario de bloque

2. Con comentarios: {min-espacios-de-contenido: 2}

el siguiente fragmento de código PASS:

x = 2 ^ 127-1 # Número primo de Mersenne

el siguiente fragmento de código FALLO:

x = 2 ^ 127-1 # Número primo de Mersenne

comentarios-sangría
Utilice esta regla para forzar la sangría de los comentarios como el contenido. Ejemplos INDENT 0.0

1. Con comentarios-sangría: {}

el siguiente fragmento de código PASS:

#Fibonacci
[0, 1, 1, 2, 3, 5]XNUMX

el siguiente fragmento de código FALLO:

#Fibonacci
[0, 1, 1, 2, 3, 5]XNUMX

el siguiente fragmento de código PASS:

lista:
- 2
- 3
# - 4
- 5

el siguiente fragmento de código FALLO:

lista:
- 2
- 3
# - 4
- 5

el siguiente fragmento de código PASS:

# Este es el primer objeto
obj1:
- artículo A
# - artículo B
# Este es el segundo objeto
obj2: []

el siguiente fragmento de código PASS:

# Esta oración
# es un comentario de bloque

el siguiente fragmento de código FALLO:

# Esta oración
# es un comentario de bloque

final del documento
Utilice esta regla para exigir o prohibir el uso del marcador de fin de documento (...). Opciones.INDENT
0.0

· Colocar presente a si cuando se requiere el marcador de fin de documento, o para no cuando es
prohibido.
1. Con final del documento: {regalo: sí}

el siguiente fragmento de código PASS:

. . .
modo:
es: [a, documento]
...
. . .
- esta
- es: otro
...

el siguiente fragmento de código FALLO:

. . .
modo:
es: [a, documento]
. . .
- esta
- es: otro
...

2. Con final del documento: {regalo: No}

el siguiente fragmento de código PASS:

. . .
modo:
es: [a, documento]
. . .
- esta
- es: otro

el siguiente fragmento de código FALLO:

. . .
modo:
es: [a, documento]
...
. . .
- esta
- es: otro

inicio de documento
Utilice esta regla para exigir o prohibir el uso del marcador de inicio de documento (. . . ). Opciones.INDENT
0.0

· Colocar presente a si cuando se requiere el marcador de inicio del documento, o para no cuando es
prohibido.
1. Con inicio de documento: {regalo: sí}

el siguiente fragmento de código PASS:

. . .
modo:
es: [a, documento]
. . .
- esta
- es: otro

el siguiente fragmento de código FALLO:

modo:
es: [a, documento]
. . .
- esta
- es: otro

2. Con inicio de documento: {regalo: No}

el siguiente fragmento de código PASS:

modo:
es: [a, documento]
...

el siguiente fragmento de código FALLO:

. . .
modo:
es: [a, documento]
...

lineas vacias
Utilice esta regla para establecer un número máximo de líneas en blanco consecutivas permitidas. Opciones.INDENT
0.0

· max define el número máximo de líneas vacías permitidas en el documento.

· arranque máximo define el número máximo de líneas vacías permitidas al comienzo de la
expediente. Esta opción tiene prioridad sobre max.

· fin máximo define el número máximo de líneas vacías permitidas al final del archivo. Esta
la opción tiene prioridad sobre max.
1. Con líneas vacías: {máx: 1}

el siguiente fragmento de código PASS:

- foo:
- 1
- 2

- barra: [3, 4]

el siguiente fragmento de código FALLO:

- foo:
- 1
- 2

- barra: [3, 4]

guiones
Utilice esta regla para controlar el número de espacios después de los guiones (-). Opciones.INDENT 0.0

· max-espacios-después define el número máximo de espacios permitidos después de los guiones.
1. Con guiones: {max-espacios-after: 1}

el siguiente fragmento de código PASS:

- primera lista:
- a
- B
- - 1
- 2
- 3

el siguiente fragmento de código FALLO:

- primera lista:
- a
- B

el siguiente fragmento de código FALLO:

- - 1
- 2
- 3

2. Con guiones: {max-espacios-after: 3}

el siguiente fragmento de código PASS:

- clave
- clave2
- clave42

el siguiente fragmento de código FALLO:

- clave
- clave2
- clave42

sangría
Utilice esta regla para controlar la sangría. Opciones.INDENT 0.0

· Espacios define el ancho de la sangría, en espacios. Establezca ya sea en un número entero (p. Ej. 2 or 4,
que representa el número de espacios en un nivel de sangría) o para consistente para permitir cualquier
número, siempre que siga siendo el mismo dentro del archivo.

· secuencias de sangría define si las secuencias de bloques deben tener sangría o no (cuando en un
mapeo, esta sangría no es obligatoria - algunas personas perciben el - como parte de
sangría). Valores posibles: si, no, lo que y consistente. consistente requiere
ya sea todas las secuencias de bloques para ser sangradas, o ninguna. lo que significa ya sea
sangrar o no sangrar secuencias de bloques individuales está bien.

· comprobar-cadenas-de-varias-líneas define si se debe aplicar pelusa a la sangría en cadenas de varias líneas. Colocar
a si para permitir, no deshabilitar.
1. Con sangría: {espacios: 1}

el siguiente fragmento de código PASS:

historia:
- nombre: Unix
fecha: 1969
- nombre: Linux
fecha: 1991
nido:
recurrente:
- alpaca:
aguja

2. Con sangría: {espacios: 4}

el siguiente fragmento de código PASS:

historia:
- nombre: Unix
fecha: 1969
- nombre: Linux
fecha: 1991
nido:
recurrente:
- alpaca:
aguja

el siguiente fragmento de código FALLO:

historia:
- nombre: Unix
fecha: 1969
- nombre: Linux
fecha: 1991
nido:
recurrente:
- alpaca:
aguja

3. Con sangría: {espacios: consistente}

el siguiente fragmento de código PASS:

historia:
- nombre: Unix
fecha: 1969
- nombre: Linux
fecha: 1991
nido:
recurrente:
- alpaca:
aguja

el siguiente fragmento de código FALLO:

algunos:
Ruso:
muñecas

4. Con sangría: {espacios: 2, secuencias de sangría: No}

el siguiente fragmento de código PASS:

lista:
- volador
- espaguetis
- monstruo

el siguiente fragmento de código FALLO:

lista:
- volador
- espaguetis
- monstruo

5. Con sangría: {espacios: 2, secuencias de sangría: lo que}

el siguiente fragmento de código PASS:

lista:
- volador:
- espaguetis
- monstruo
- no volando:
- espaguetis
- salsa

6. Con sangría: {espacios: 2, secuencias de sangría: consistente}

el siguiente fragmento de código PASS:

- volador:
- espaguetis
- monstruo
- no volando:
- espaguetis
- salsa

el siguiente fragmento de código FALLO:

- volador:
- espaguetis
- monstruo
- no volando:
- espaguetis
- salsa

7. Con sangría: {espacios: 4, comprobar-cadenas-de-múltiples-líneas: sí}

el siguiente fragmento de código PASS:

Blaise Pascual:
Je vous écris una larga letra parce que
je n'ai pas le temps d'en écrire une courte.

el siguiente fragmento de código PASS:

Blaise Pascal: Je vous écris una larga letra parce que
je n'ai pas le temps d'en écrire une courte.

el siguiente fragmento de código FALLO:

Blaise Pascal: Je vous écris una larga letra parce que
je n'ai pas le temps d'en écrire une courte.

el siguiente fragmento de código FALLO:

Código C:
vacío principal () {
printf ("foo");
}

el siguiente fragmento de código PASS:

Código C:
vacío principal () {
printf ("barra");
}

duplicados de claves
Utilice esta regla para evitar múltiples entradas con la misma clave en las asignaciones. Ejemplos INDENT
0.0

1. Con duplicados de claves: {}

el siguiente fragmento de código PASS:

- clave 1: v
clave 2: val
clave 3: valor
- {a: 1, b: 2, c: 3}

el siguiente fragmento de código FALLO:

- clave 1: v
clave 2: val
clave 1: valor

el siguiente fragmento de código FALLO:

- {a: 1, b: 2, b: 3}

el siguiente fragmento de código FALLO:

llave duplicada: 1
"clave duplicada": 2

otra duplicación: 1
? > -
Otros
duplicación
: 2

Longitud de la línea
Utilice esta regla para establecer un límite a la longitud de las líneas. Opciones.INDENT 0.0

· max define la longitud máxima (inclusiva) de las líneas.

· permitir-palabras-no-rompibles se usa para permitir palabras que no se puedan romper (sin espacios en el interior)
para desbordar el límite. Esto es útil para URL largas, por ejemplo. Usar si permitir, no
prohibir.
1. Con Longitud de la línea: {máx: 70/XNUMX/XNUMX}

el siguiente fragmento de código PASS:

larga oración:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua.

el siguiente fragmento de código FALLO:

larga oración:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed de eiusmod
tempor incidentidunt ut labore et dolore magna aliqua.

2. Con Longitud de la línea: {máx: 60, permitir-palabras-no-rompibles: sí}

el siguiente fragmento de código PASS:

modo:
:
- un:
http://localhost/very/very/very/very/very/very/very/very/long/url

# este comentario es demasiado largo,
# pero difícil de dividir:
# http://localhost/another/very/very/very/very/very/very/very/very/long/url

el siguiente fragmento de código FALLO:

- esta línea es waaaaaaaaaaaaaay demasiado larga pero podría dividirse fácilmente ...

3. Con Longitud de la línea: {máx: 60, permitir-palabras-no-rompibles: No}

el siguiente fragmento de código FALLO:

modo:
:
- un:
http://localhost/very/very/very/very/very/very/very/very/long/url

nueva línea al final del archivo
Utilice esta regla para requerir un carácter de nueva línea (\n) al final de los archivos.

El estándar POSIX requiere el pasado línea a final con a new línea personaje. Todo UNIX
las herramientas esperan una nueva línea al final de los archivos. La mayoría de los editores de texto también utilizan esta convención.

nuevas líneas
Utilice esta regla para forzar el tipo de caracteres de nueva línea. Opciones.INDENT 0.0

· Colocar tipo a UNIX para utilizar caracteres de nueva línea escritos en UNIX (\n), o dos para usar el nuevo tipo DOS
caracteres de línea\ R \ n).

espacios finales
Utilice esta regla para prohibir los espacios finales al final de las líneas. Ejemplos INDENT 0.0

1. Con espacios finales: {}

el siguiente fragmento de código PASS:

este documento no contiene
cualquier rastro
Espacios

el siguiente fragmento de código FALLO:

este documento contiene
espacios finales
en las líneas 1 y 3

desarrollo
yamllint proporciona tanto un script como un módulo de Python. Este último se puede utilizar para escribir su
propias herramientas para despellejar:

clase yamllint.linter.LintProblem (línea, columna, desc = ' descripción> ', rule = None)
Representa un problema de pelusa encontrado por yamllint.

visión de conjunto = Ninguno
Columna en la que se encontró el problema (comenzando en 1)

desc = Ninguno
Descripción del problema legible por humanos

línea = Ninguno
Línea en la que se encontró el problema (comenzando en 1)

gobernar = Ninguno
Identificador de la regla que detectó el problema

yamllint.linter.run (entrada, conferencia)
Lints una fuente YAML.

Devuelve un generador de objetos LintProblem.

Parámetros

· Las opciones de entrada - búfer, cadena o flujo para leer

· conf - objeto de configuración yamllint

Integración: con texto editores
La mayoría de los editores de texto admiten la verificación y el resaltado de sintaxis para informar visualmente la sintaxis
errores y advertencias al usuario. yamllint se puede usar para verificar la sintaxis de la fuente YAML, pero
Se requiere un poco de configuración dependiendo de su editor de texto favorito.

Empuje
Suponiendo que el fantástico el complemento está instalado, agréguelo a su .vimrc:

deje g: syntastic_yaml_checkers = ['yamllint']

Neovim
Suponiendo que el neohacer plugin está instalado, yamllint es compatible de forma predeterminada. Está
habilitado automáticamente al editar archivos YAML.

Otros texto editores
¡Se busca ayudante!

¿Tu editor de texto favorito no aparece aquí? Ayúdanos a mejorar agregando una sección (por
abrir una solicitud de extracción o un problema en GitHub).

Use yamllint en línea usando los servicios de onworks.net