codeclimate haml lint

Código Climate Haml-Lint Engine

¿Alguna vez has querido saber exactamente lo bueno que eres para escribir Haml consistente? Bueno, ¡no mires más! Al usar este código climático de código, puede aprovechar el poder de Haml-Lint para calificar su código.

¿Quieres ayudar?

¡Impresionante! Nos esforzamos por dar la bienvenida a todos. Consulte la guía contribuyente y asegúrese de leer nuestro código de conducta.

¿Necesitas ayuda?

Para obtener ayuda con Haml-Lint, consulte su documentación.

Si se encuentra con un problema climático de código, primero consulte nuestra [Documentación del motor] [#Uso] y revise los problemas existentes, ya que su pregunta ya puede haber sido cubierta. Si no es así, abra un problema y veremos qué podemos hacer para ayudar.

Instalación

Dado que este no es un motor publicado públicamente, tendrá que construir el motor a partir de este repositorio. Necesitará la CLI de clima de código instalada, así como los comandos git y make .

1. Si aún no lo ha hecho, instale la CLI del clima de código.
2. Si no tiene GIT, instálelo.
3. Si no tiene make , instálelo. En una Mac, puede obtenerlo con Xcode. En Linux, puede obtenerlo en su Administrador de paquetes (el paquete build-essential en Ubuntu o el paquete base-devel en Arch Linux). En Windows, probablemente necesite Cygwin o el subsistema de Linux para Windows.
4. Haga el contenedor Docker del motor con make .

Si el contenedor no puede construir, presente un problema.

Ahora debería poder usar el motor a través de la CLI del clima de código como motor de nivel de desarrollo. Para usarlo en su proyecto, primero navegue al directorio de su proyecto. Luego use el siguiente comando:

 $ codeclimate analyze -e haml-lint --dev

Uso

Al igual que otros motores climáticos de código, configura este mediante el uso de un archivo .codeclimate.yml en el directorio raíz de su proyecto. Si aún no tiene uno, puede usar los codeclimate engines:enable haml_lint para generar un archivo .codeclimate.yml básico con el motor habilitado.

Si no le importa ajustar su configuración, ahora debería poder ejecutar el motor con el comando Analizar:

 $ codeclimate analyze

Para modificar las revestimientos que ejecutará Haml-Lint, siga este patrón en el archivo de configuración:

 engines :
  haml-lint :
    enabled : true
    config :
      file : my_custom_haml_lint.yml
    checks :
      HamlLint/AltText :
        enabled : false
      HamlLint/RuboCop :
        include :
          - lib/project_name/**/*.rb
        exclude :
          - spec/**/*.rb
exclude_paths :
  - ignored_directory/

La mayor parte de la configuración vive bajo los engines.haml-lint Key. Las opciones son las siguientes:

• config.file : el archivo de configuración Haml -Lint que desea usar como base.
• checks.<LINTER_NAME> - Configuración para el linter dado por <LINTER_NAME> . Puede pasar cualquiera de las opciones de configuración para el enlace en el formato base Haml-Lint. Consulte la documentación de Haml-Lint para obtener más información.
• La configuración global como exclude_paths también se incluye en la configuración del motor. Consulte la documentación climática del código para obtener más información.

Versiones

Este motor está versión en función del esquema de versiones de Haml-Lint. Utiliza la versión de la gema Haml-Lint que está instalada como la versión base y luego agrega un número de compilación. Por ejemplo, la primera vez que el motor se construye y se lanza para la versión 0.23.1 de Hamllint, la versión del motor es 0.23.1-1 . Si hay algún error que se solucione en el motor sin actualizar la versión Haml-Lint, el número de compilación se incrementará (por ejemplo, a 0.23.1-2 ).

Licencia

La gema está disponible como código abierto bajo los términos de la licencia MIT.