Saltar al contenido

Control de commits con 22 analizadores

Desarrollé un control obligatorio de commits con 22 analizadores de una línea y cinco que requieren una explicación, sin nivel de advertencias ni supresiones en línea permitidas, que cubre HTML, CSS, JavaScript, Python, YAML, Markdown, Shell, enlaces, ortografía, secretos y tipografía.

22 analizadores de una línea y cinco que requieren explicación

Situación. Una guía de contribución es un conjunto de sugerencias. Todo el mundo está de acuerdo con ella, y entonces llega el viernes, el cambio es pequeño y la guía pierde. En un proyecto de una sola persona eso es peor en lugar de mejor, porque no hay nadie que revise — lo único que media entre un cambio malo y producción es la persona que lo escribió, en el momento en que menos ganas tiene de discutir consigo misma.

Tarea. Las normas debían ser ejecutables, de modo que incumplir una hiciera fallar un commit en lugar de esperar a que alguien lo advirtiera.

Acción. Lo que creció fue un control de calidad obligatorio de 22 analizadores sin nivel de advertencia: cada diagnóstico es un error, y el propio generador del sitio se ejecuta con las advertencias elevadas a fallos para que incluso un aviso de obsolescencia detenga la compilación. Están los evidentes — validación de HTML, CSS, JavaScript, Python, YAML, Markdown, shell, ortografía, secretos, enlaces rotos. Los interesantes son las comprobaciones específicas del proyecto sobre las que ninguna herramienta estándar tiene opinión: que ambos temas de color pinten cada superficie compuesta con el mismo número de capas, que ninguna fotografía se muestre con una anchura superior a la mitad de sus píxeles de origen, que el árbol desplegado no contenga ninguna ruta ni nombre de host privados, que la prosa respete las reglas de tono en los tres idiomas, que una página tenga una versión gemela en Markdown y una representación válida en un protocolo alternativo. Las supresiones en línea están totalmente prohibidas — ningún comentario para ignorar, ninguna directiva para desactivar, ninguna omisión del hook y ningún cambio de nombre de archivo para eludir un patrón de coincidencia. La regla que mantiene eso honesto es que un fallo preexistente no es una excusa: una comprobación que detecta un defecto que nadie ha introducido se corrige en la misma pasada.

Resultado. Una máquina formula las objeciones mecánicas antes de que exista un commit, y el control de calidad obligatorio es el único revisor que tiene este proyecto. El coste se declara en lugar de ocultarse: hacer commits es lento, y lidiar con una protección mal escrita es realmente exasperante, motivo por el que más adelante las propias protecciones pasaron a estar sujetas a un formateador y un analizador propios.

  • Bolígrafo, escribir, escritura
    Foto: RoumanetD / Pixabay
  • Lista de comprobación, verificación, confirmación
    Foto: HeungSoon / Pixabay

Aplique esta experiencia a su proyecto

Utilice «Control de commits con 22 analizadores» como punto de partida para un reto similar en su organización. Los servicios que respaldan este trabajo están disponibles para su proyecto. Convertir las necesidades del negocio en algo que se pueda desarrollar y decir con claridad qué no merece la pena construir.

Explore nuestros servicios Póngase en contacto

Mire más allá del resultado

Lea la situación, las decisiones y el resultado de este ejemplo. Podemos hablar de qué partes se adaptan a sus restricciones y cuáles necesitan otro enfoque. Control de commits con 22 analizadores — 22 analizadores de una línea y cinco que requieren explicación

Explore nuestros servicios Póngase en contacto

Una parte de una trayectoria más amplia — y toda ella está en este sitio.

Cada entrada sigue la misma estructura: la situación, la tarea, lo que hicimos y lo que cambió.

Vea la trayectoria completa

Defina la mejora que necesita

Describa la decisión, las personas afectadas y las opciones ya consideradas. Podemos hacer explícitos los compromisos entre objetivos y dejar una recomendación documentada.

Vea cuánto cuesta Póngase en contacto

¿Quiere aplicar sus criterios de calidad antes de cada commit?

Pregunte por las decisiones detrás de «Control de commits con 22 analizadores». Hablará con las personas que pueden explicar el trabajo y valorar su propio proyecto.

Explore nuestros servicios
welcome@engineer.company +45 50 10 61 84 Copenhague, Dinamarca
Código QR de Desarrollé un control obligatorio de commits con 22 analizadores de una línea y cinco que requieren una explicación, sin nivel de advertencias ni supresiones en línea permitidas, que cubre HTML, CSS, JavaScript, Python, YAML, Markdown, Shell, enlaces, ortografía, secretos y tipografía.
Llévese esta páginahttps://advisory.engineer.company/es/portfolio/built-a-22-linter-commit-gate/