ruby - style - rubocop-rspec

Rubocop Linelength: ¿Cómo ignorar líneas con comentarios?

Question

Al usar una aplicación Rails 4, me gustaría que Rubocop ignore las líneas con comentarios (solo un comentario o un código con un comentario de final de línea) al verificar si una línea es demasiado larga. ¿Hay alguna forma de hacer esto?

Answer 1

Creo que la idea básica aquí es que desea imponer la longitud de la línea, sin importar qué sea después de n caracteres. el valor predeterminado de 80 caracteres es algún tipo de culto de carga para ventanas de terminal antiguas que solo podrían contener esa cantidad de caracteres. La única opción que vi en el código es una opción para permitir direcciones URL que pueden exceder el límite de caracteres.

puedes ignorar archivos completos , supongo que no es lo que estás buscando.

Answer 2

Es posible definir patrones de rubocop.yml regulares para ignorar automáticamente ciertas líneas en rubocop.yml , por lo que puede elegir ignorar todas las líneas que comiencen con un carácter # :

Metrics/LineLength:
Max: 80
IgnoredPatterns: [''/A#'']

Esto podría mejorarse para que las líneas de comentarios "con sangría" (es decir, espacios en blanco seguidos de un carácter # ) también se ignoren, si eso es lo que desea.

Tenga en cuenta que esto no tiene en cuenta las líneas de código que terminan con un comentario, sin embargo:

some_code(that_does_something) # This line would NOT be ignored by Rubocop.

Answer 3

Hay una forma de ignorar a los policías por línea.

También hay una forma de hacerlo a través del archivo de configuración.

Ejecute rubocop --auto-gen-config y generará un archivo que puede usar para deshabilitar las ofensas.

El comando también da una pista sobre qué hacer para cargar esas opciones.

En una línea por línea, también puede habilitar y deshabilitar a los policías.

# rubocop:disable RuleByName
This is a long line
# rubocop:enable RuleByName

También puede hacer más de una regla a la vez en su código.

# rubocop:disable BlockComments, AsciiComments

Al usar una directiva en línea, la directiva se vuelve válida solo para esa línea, y se vería así:

# Thanks to @jnt30 for the comment!
method(argument) # rubocop:disable SomeRule, SomeOtherRule

Puedes leer un montón más sobre RuboCop en su manual oficial .

Para encontrar todos los nombres de reglas vale la pena buscar en los archivos de configuración de rubocop

cyberwiz dice: "ejecute rubocop -D cuando necesite los nombres de las reglas en lugar de buscar en la documentación".