Herramienta de asistencia para desarrollo que utiliza SKAI para analizar código, generar documentación, pruebas unitarias y realizar revisiones de calidad basadas en mejores prácticas como reglas de SonarQube, principios SOLID y Clean Code.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Sofka SDK es una extensión para Visual Studio Code que permite analizar y mejorar tu código mediante SKAI con prompts especializados, generando sugerencias, documentación y pruebas unitarias. La extensión te permite seleccionar código en el editor y procesarlo a través de diferentes comandos, mostrando los resultados en una ventana fácil de leer.
Características principales
Análisis de código con Sonar Rules: Detecta problemas de calidad y buenas prácticas de programación basadas en reglas de SonarQube.
Revisión Par: Obtén comentarios como si un compañero experto revisara tu código, siguiendo principios SOLID y Clean Code.
Generación de OpenAPI: Añade anotaciones OpenAPI/Swagger a tu código para documentar APIs.
Generación de JavaDoc: Documenta automáticamente tus clases y métodos Java con anotaciones JavaDoc completas.
Creación de Pruebas Unitarias Java: Genera tests unitarios con JUnit y Mockito, incluyendo pruebas de mutación.
Creación de Pruebas Unitarias React: Genera tests unitarios con React Testing Library y Jest.
Explicación de Código: Obtén explicaciones técnicas y funcionales de tu código con sugerencias de mejora.
Visualización avanzada: Muestra los resultados en una ventana interactiva con resaltado de sintaxis.
Copiar e insertar resultados: Aplica las sugerencias directamente a tu código.
Instalación
Descarga el archivo .vsix de la extensión
Abre Visual Studio Code
Ve a la pestaña de Extensiones (Ctrl+Shift+X)
Haz clic en el ícono ... en la parte superior del panel
Selecciona “Instalar desde VSIX...”
Busca el archivo .vsix descargado y selecciónalo
Reinicia VS Code si es necesario
Autenticación
La extensión utiliza un flujo de autenticación integrado que permite a cada usuario acceder de forma segura y personalizada a las funcionalidades del SDK.
¿Cómo funciona?
Al ejecutar por primera vez cualquier comando de Sofka SDK, se abrirá automáticamente una página en tu navegador.
Inicia sesión con tu cuenta de Sofka Technologies.
Una vez autenticado, el sistema devolverá un los datos necesarios a la extensión, habilitando el acceso completo a todas las funciones.
🔐 Los datos es gestionado automáticamente por la extensión. No necesitas configurarlo manualmente ni introducir datos adicionales.
Uso
Comandos disponibles
Comando
Descripción
¿Requiere selección?
Sonar Rules
Analiza el código en busca de problemas que no cumplen con las reglas de SonarQube.
No
Revisión Par
Revisión experta del código con principios de Clean Code, SOLID y buenas prácticas del lenguaje.
No
OpenAPI
Genera y añade anotaciones OpenAPI/Swagger al código seleccionado.
Sí
JavaDoc
Genera documentación JavaDoc para clases y métodos.
Sí
Unit Test Java
Crea pruebas unitarias con JUnit y Mockito, incluyendo pruebas de mutación.
Sí
Unit Test React
Crea pruebas unitarias para componentes React con React Testing Library, Jest y mutaciones con Stryker.
Sí
Code Explanation
Proporciona explicaciones técnicas y funcionales del código, con sugerencias de mejora basadas en buenas prácticas.
Sí
Pasos para usar la extensión
Abre un archivo de código en el editor
Selecciona el código que deseas analizar (si aplica)
Haz clic derecho y selecciona el menú “Sofka SDK”
Elige uno de los comandos disponibles
Espera mientras se procesa tu solicitud
Revisa los resultados en la ventana lateral
Usa los botones disponibles para:
Copiar: Copiar el resultado al portapapeles
Insertar en editor: Reemplazar el código original con el resultado
Panel de resultados
Resaltado de sintaxis para código generado
Formato Markdown para una lectura clara
Botones de acción rápida (copiar, insertar)
Indicadores visuales de carga y seguridad
Solución de problemas
Problemas comunes
El menú Sofka SDK no aparece: Asegúrate de estar en un archivo compatible (Java, JavaScript, TypeScript, etc.).
Error de autenticación: Intenta cerrar sesión y volver a iniciar sesión desde el navegador.
Resultados vacíos: Verifica que el código seleccionado sea apropiado para el comando utilizado.
Ver logs
Abre la Paleta de Comandos (Ctrl+Shift+P)
Escribe y selecciona Developer: Open Developer Tools
Revisa la pestaña “Console” para ver mensajes y errores
Desarrollo
Si deseas contribuir al desarrollo de la extensión:
Clona este repositorio
Instala las dependencias con pnpm install
Haz tus cambios
Compila con pnpm run compile
Presiona F5 para ejecutar y probar la extensión en un entorno aislado
