Detecta problemas con tus proyectos Arduino Deja un comentario

Este artículo fue escrito por Per Tillisch, ingeniero de software del equipo de herramientas en Arduino.

El equipo de Arduino creó una herramienta para verificar los proyectos de Arduino en busca de problemas comunes. Arduino Lint ejecuta más de 175 comprobaciones en sus bocetos, bibliotecas y plataformas de placas que cubren el cumplimiento de las especificaciones, los requisitos de envío de Library Manager y las mejores prácticas.

Arduino Lint es una herramienta de línea de comandos potente y fácil de usar. Se centra en la estructura, los metadatos y la configuración de los proyectos de Arduino, más que en el código.

Siga las instrucciones de instalación para prepararse para usar Arduino Lint : https://arduino.github.io/arduino-lint/latest/installation/

Ahora solo necesita abrir una terminal en la carpeta de su proyecto y ejecutar el comando: arduino-lint

Esto detectará automáticamente el tipo de proyecto y lo comparará con las reglas relevantes.

La configuración predeterminada de Arduino Lint proporciona los casos de uso más comunes, mientras que ofrece la opción de cambiar la configuración a través de indicadores de línea de comando .

Configuración de cumplimiento

El indicador --compliance le permite configurar el rigor de las reglas aplicadas. Los tres valores de nivel de cumplimiento aceptados por esta bandera son:

• permisivo – la falla ocurrirá solo cuando se encuentren violaciones severas de las reglas. Aunque un proyecto que pasa en la configuración permisiva funcionará con las versiones actuales del software de desarrollo de Arduino, es posible que no sea totalmente compatible con las especificaciones, con riesgo de incompatibilidad o una mala experiencia para los usuarios.
• especificación – la configuración predeterminada, hace cumplir las especificaciones oficiales del proyecto Arduino ( sketch , biblioteca , plataforma ).
• estricto – aplica las mejores prácticas, más allá de los requisitos mínimos para el cumplimiento de las especificaciones. Utilice esta configuración para garantizar la mejor experiencia para los usuarios del proyecto.

Configuración del administrador de biblioteca

Arduino Library Manager es la mejor manera de proporcionar instalación y actualizaciones de bibliotecas Arduino. Para ser aceptada para su inclusión en el Administrador de bibliotecas, se requiere que una biblioteca cumpla con algunos requisitos .

Arduino Lint también proporciona comprobaciones para estos requisitos, controladas por el indicador --library-manager .

Las reglas específicas de envío de Library Manager se habilitan a través de --library-manager submit.

Incluso si su biblioteca aún no está lista para agregarse al Administrador de bibliotecas, es una buena idea usar esta configuración para asegurarse de que no se introduzcan incompatibilidades.

Una vez que tu biblioteca está en el índice del Administrador de bibliotecas, cada versión se selecciona automáticamente y se pone a disposición de la comunidad Arduino. Los lanzamientos también están sujetos a reglas especiales. El comando arduino-lint --library-manager update le dirá si su biblioteca cumple con estas reglas.

Integración

El indicador --format configura el formato de salida de arduino-lint . La configuración predeterminada --format text proporciona una salida legible por humanos. Para la automatización o la integración con otras herramientas, la salida legible por máquina proporcionada por --format json puede ser más conveniente. Esta configuración expone todos los detalles de las reglas que se aplicaron.

El indicador --report-file hace que arduino-lint escriba la salida JSON en el archivo especificado.

Arduino Lint sería una gran adición a su sistema de integración continua . La ejecución de la herramienta después de cada cambio en el proyecto puede permitirle identificar cualquier problema que se haya introducido.

Esto se hace fácilmente usando la acción arduino / arduino-lint-action Acciones de GitHub : https://github.com/arduino/arduino-lint-action [19459009 ]

Agregue un archivo de flujo de trabajo simple al repositorio de su proyecto Arduino y GitHub ejecutará automáticamente Arduino Lint en cada solicitud de extracción y envío.

¿Su proyecto obtendrá una calificación aprobatoria de Arduino Lint ? Solo hay una forma de averiguarlo …

Asistencia y comentarios

Puede discutir u obtener ayuda sobre el uso de Arduino Lint en el Foro Arduino .

¡Sus comentarios son bienvenidos! Envíe solicitudes de funciones o informes de errores a los rastreadores de problemas: