creedengo rules specifications
Release 1.4.4
Creedengo es un proyecto colectivo con el objetivo de reducir la huella ambiental de software a nivel de código. El objetivo del proyecto es proporcionar una lista de analizadores de código estático para resaltar las estructuras de código que pueden tener un impacto ecológico negativo: la energía y el consumo excesivo de recursos, "grasa", acortando la vida útil de los terminales, etc.
Creedengo se basa en catálogos en evolución de buenas prácticas, para varias tecnologías. Un complemento Sonarqube implementa estos catálogos como reglas para escanear sus proyectos.
ADVERTENCIA : Este sigue siendo un proyecto de etapa muy temprana. Cualquier comentario o contribución será muy apreciado. Consulte la sección de contribución.
7 Las tecnologías están respaldadas por Creedengo en este momento:
Hay dos tipos de complementos:
El código se analiza para transformarse como AST. AST le permitirá acceder a uno o más nodos de su código. Por ejemplo, podrá acceder a todo su bucle for , para explorar contenido, etc.
Para comprender mejor la estructura AST, puede usar el AST Explorer.
Este proyecto contiene las especificaciones de todas las reglas de Creedengo, para todos los idiomas.
Las reglas están organizadas por carpeta basada en su identificación en la carpeta de reglas raíz. Cada una de estas carpetas contiene un archivo con los metadatos de la regla y la descripción por lenguaje.
El archivo de metadatos utiliza el formato respaldado por la Biblioteca de los Analizadores de Sonarsource. Para averiguar qué valores se pueden poner allí, le recomendamos que use la documentación oficial de Sonarqube y que confíe en los archivos ya existentes.
Aquí hay un ejemplo:
src/main/rules
├── EC104
│ ├── java
│ │ ├── EC104.asciidoc
│ │ ├── EC104.json
│ ├── php
│ │ ├── EC104.asciidoc
│ ├── python
│ │ ├── EC104.asciidoc
│ └── EC104.json
├── ...
Para especificar metadatos para un idioma determinado (por ejemplo, desaprobar una regla solo para un solo idioma), es posible crear un archivo JSON en la carpeta de idiomas, y esto se fusionará con el archivo común durante la compilación. Las claves en el archivo específico tienen prioridad y es posible agregar otras nuevas, pero no eliminarlas del global.
La descripción de las reglas utiliza el formato ASCIIDOC (con compatibilidad de Markdown) para permitir la inclusión de otras páginas (esta característica no está disponible en estándar con Markdown).
Ver:
Puede echar un vistazo rápidamente a los complementos de Creedengo con Docker. PLase eche un vistazo a la sección "Iniciado" de cada complemento:
La forma principal de obtener complementos de Creedengo es descargarlos desde su mercado de Sonarqube (disponible en la sección de administración). Pero si lo desea, también puede descargarlos de los lanzamientos de GitHub.
Habíamos dividido nuestro repositorio de complementos creedengo en un repositorio para cada complemento en diciembre de 2023. Por lo tanto, las versiones de complementos están disponibles en 2 repositorios dependiendo de la versión que desee:
| Versión de complementos | Versión sonarqube |
|---|---|
| 1.4.+ | Sonarqube 9.4.+ LTS a 10.1 |
| 1.3.+ | Sonarqube 9.4.+ LTS a 10.0 |
| 1.2.+ | Sonarqube 9.4.+ LTS a 10.0 |
| 1.1.+ | Sonarqube 9.4.+ LTS a 9.9 |
| 1.0.+ | Sonarqube 9.4.+ LTS a 9.9 |
| 0.2.+ | Sonarqube 9.4.+ LTS a 9.9 |
| 0.1.+ | Sonarqube 8.9.+ LTS a 9.3 |
| Versión de complementos | Versión java |
|---|---|
| 1.4.+ | 11/17 |
| 1.3.+ | 11/17 |
| 1.2.+ | 11/17 |
| 1.1.+ | 11/17 |
| 1.0.+ | 11/17 |
| 0.2.+ | 11/17 |
| 0.1.+ | 11/17 |
Usted es un experto técnico, un diseñador, un gerente de proyectos, un experto en RSE, un experto en ecodiseño ...
¿Desea ofrecer la ayuda de su empresa, ayudarnos a organizarnos, comunicarse en el proyecto?
¿Tienes ideas para enviarnos?
¡Te estamos escuchando para que el proyecto progrese colectivamente, y tal vez contigo!
¡Te necesitamos!
Aquí el paquete de inicio
¿Alguna pregunta? ¡Estamos aquí para ti! Primero, cree un problema, por favor. Entonces, si no hay respuesta, contacte ...
Aquí honramos a algunos miembros del equipo central no activos que no han hecho contribuciones valiosas en el pasado.
Han contribuido al éxito de Creedengo:
Apoyaron el proyecto:
