DocCoverage es un analizador automatizado que escanea su código base para identificar documentación faltante, docstrings incompletos y brechas de calidad en múltiples lenguajes de programación.
Instalar y Descargar
1. ClawHub CLI
La forma más rápida de instalar una habilidad directamente desde el registro.
npx clawhub@latest install doccoverage
2. Instalación manual
Copia la carpeta de la habilidad a una de estas ubicaciones
~/.openclaw/skills/ <project>/skills/ Prioridad: Espacio de trabajo > Local > Integrado
3. Instalación del prompt
Copia este prompt en OpenClaw para instalarlo automáticamente.
Ayúdame a instalar doccoverage usando Clawhub. Si Clawhub no está instalado, instálalo primero (npm i -g clawhub).
¿Prefieres descargar?
Obtén los archivos originales de la habilidad en un archivo ZIP.
¿Qué es DocCoverage?
DocCoverage es una herramienta integral de auditoría de documentación diseñada para mantener código bases de alta calidad. Como una de las Openclaw Skills más prácticas, evalúa su código fuente en busca de JSDoc, docstrings y secciones README faltantes. Admite los principales lenguajes, incluidos JavaScript, TypeScript, Python, Go, Java y Ruby, asegurando que las funciones públicas y los tipos exportados estén explicados adecuadamente.
Al aprovechar la coincidencia de patrones basada en regex contra más de 85 estándares de documentación, esta habilidad capacita a los desarrolladores para cerrar la brecha entre el código y la documentación. Ya sea que esté gestionando un proyecto individual o un repositorio empresarial grande, DocCoverage proporciona puntuaciones accionables y pasos de remediación para mejorar la salud general de la documentación de su proyecto.
Casos de uso de DocCoverage
- Identificar funciones públicas o clases exportadas no documentadas en repositorios grandes.
- Auditar archivos README y CHANGELOG en busca de secciones faltantes o versiones inconsistentes.
- Aplicar estándares de documentación antes de que el código se confirme en el control de versiones utilizando pre-commit hooks.
- Generar informes detallados de cobertura de documentación para auditorías de estándares del equipo.
- Detectar comentarios redundantes, TODOs sin referencias a tickets o bloques de código comentados.
Cómo funciona DocCoverage
- La habilidad identifica los archivos o directorios de destino y autodetecta el lenguaje de programación basado en las extensiones de archivo.
- Ejecuta más de 85 patrones de calidad de documentación para escanear docstrings faltantes, parámetros ausentes o descripciones de retorno incompletas.
- Se calcula una puntuación de cobertura de documentación de 0 a 100 deduciendo puntos según la gravedad de los problemas identificados.
- Se informan los hallazgos detallados al usuario, incluyendo números de línea, IDs de verificación, niveles de gravedad y recomendaciones específicas para mejorar.
- Para niveles avanzados, los resultados pueden integrarse en git hooks o exportarse como archivos SARIF para una integración perfecta en pipelines de CI/CD.
Configuración de DocCoverage
Para comenzar a usar esta adición a sus Openclaw Skills, siga estos pasos de instalación:
# Instale el gestor de git hooks necesario (opcional para el nivel gratuito)
brew install lefthook
# Configure su clave de licencia en su archivo de configuración local
# Ruta: ~\/.openclaw\/openclaw.json
# Ejecute un escaneo manual en su directorio actual
bash "<SKILL_DIR>\/scripts\/doccoverage.sh" scan .
Esquema de datos y taxonomía de DocCoverage
DocCoverage organiza sus hallazgos basándose en un sistema de puntuación estructurado y taxonomía de metadatos:
| Categoría | Detalles |
|---|---|
| Sistema de puntuación | Escala 0-100; deducciones: Crítico (25), Alto (15), Medio (8), Bajo (3). |
| Soporte de archivos | Analiza archivos .js, .ts, .py, .go, .java, .rb y Markdown. |
| Formatos de salida | Salida de consola, informes Markdown y JSON SARIF 2.1.0. |
| Metadatos | Incluye ID de verificación, ruta del archivo, número de línea y consejos de remediación. |
Funciones avanzadas de DocCoverage
- Integración de Git pre-commit hook vía Lefthook para bloquear confirmaciones con código no documentado.
- Cumplimiento de políticas personalizadas específicas de la organización para estándares de documentación únicos.
- Verificación automatizada de CHANGELOG contra etiquetas git para garantizar la consistencia del historial de versiones.
- Validación de licencia offline que garantiza que nunca se envíe código fuente a servidores externos.
- Capacidad de escaneo multilingüe que procesa repositorios polyglot en una sola pasada.
SKILL.md
Cargando
Habilidades relacionadas de Openclaw
Rastreador FuelWatch SA
Una plataforma de seguimiento de combustible basada en crowdsourcing centrada en dispositivos móviles, diseñada para monitorear precios y disponibilidad en toda Sudáfrica durante la escasez de suministros.
Flujo de Trabajo de Aprobación de Correo Electrónico
Un protocolo sólido de human-in-the-loop para que los agentes de IA redacten, revisen y envíen comunicaciones profesionales externas.
Recuperación de Límite de Tasa de Modelo
Un marco técnico para diagnosticar y recuperarse de los límites de tasa de los proveedores de modelos y errores 429 para mantener el tiempo de actividad del agente.
Affiliate Marketing Optimizer
Una herramienta automatizada diseñada para maximizar las ganancias de afiliados a través de la selección de productos basada en datos, la optimización de enlaces y la auditoría de cumplimiento.
Configuración Gmail + Gog
Conecte sus AI Agents a Gmail usando la Gog CLI para habilitar la lectura automatizada de correos electrónicos y la autenticación de buzones.
Interfaz Web de Correo Electrónico
Un panel web optimizado para administrar cuentas de correo electrónico de AI agent a través de integraciones de Gmail y Gog CLI.
Presentado*
