¿Qué hace skill-creator?
Una skill de Codex para estandarizar estructuras de directorios de proyectos C++ / CMake / Qt, con reglas claras para código fuente, cabeceras, QML, recursos, dependencias, scripts, documentación, pruebas y migración de proyectos heredados.
Descripción General
Esta skill define una estructura de proyecto canónica para proyectos C++ que utilizan CMake y Qt. Al activar esta skill, Codex seguirá las reglas especificadas al crear nuevos proyectos, añadir archivos o migrar proyectos heredados a la estructura estándar.
Estructura de Directorios Estándar
project_root/
├── CMakeLists.txt
├── src/ # Código fuente (.cpp)
├── include/ # Archivos de cabecera (.h, .hpp)
├── qml/ # Archivos QML
├── resources/ # Recursos (.qrc, imágenes, sonidos, etc.)
├── tests/ # Pruebas unitarias y de integración
├── docs/ # Documentación
├── scripts/ # Scripts de construcción y utilidades
├── third_party/ # Dependencias de terceros (opcional)
├── cmake/ # Módulos CMake personalizados y archivos de configuración
└── legacy/ # Proyectos heredados antes de la migración
Reglas Específicas
Código Fuente (src/)
- Colocar todos los archivos
.cppaquí. - Organizar en subdirectorios correspondientes a módulos del proyecto.
- Los nombres de archivo deben usar
snake_case. Ejemplo:main_window.cpp.
Archivos de Cabecera (include/)
- Colocar todos los archivos
.hy.hppaquí. - Mantener la misma estructura de subdirectorios que en
src/. - Archivos de cabecera públicos deben incluir el namespace del proyecto en la ruta. Ejemplo:
include/myproject/core/module.h.
Archivos QML (qml/)
- Colocar archivos
.qmlaquí. - Organizar por módulos o funcionalidad.
- Archivos de componentes reutilizables deben ir en un subdirectorio
components/.
Recursos (resources/)
- Colocar todos los recursos Qt aquí (archivos
.qrc, imágenes, fuentes, etc.). - Los archivos
.qrcdeben referenciar rutas relativas dentro deresources/.
Dependencias (third_party/)
- Colocar dependencias de terceros que no se gestionan mediante gestores de paquetes aquí.
- Cada dependencia debe tener su propio subdirectorio con su licencia.
Scripts (scripts/)
- Colocar scripts de construcción, despliegue o automatización aquí.
- Los scripts pueden ser en Python, Bash, PowerShell, etc.
Documentación (docs/)
- Colocar documentación del proyecto aquí.
- Utilizar Markdown para documentación general.
- Se puede incluir
Doxyfilepara documentación generada con Doxygen.
Pruebas (tests/)
- Colocar pruebas unitarias y de integración aquí.
- Los nombres de archivo deben coincidir con los archivos fuente que prueban. Ejemplo:
test_main_window.cpp. - Utilizar el framework de pruebas de Qt (QTest) o Google Test.
Migración de Proyectos Heredados
- Mover el código fuente existente a
src/yinclude/según las reglas anteriores. - Mover archivos QML y recursos a
qml/yresources/respectivamente. - Crear o actualizar
CMakeLists.txten la raíz del proyecto. - Si existía documentación u otros archivos, moverlos a las ubicaciones correspondientes.
- Colocar el contenido original y no migrado en
legacy/para referencia.
Ejemplo de CMakeLists.txt
cmake_minimum_required(VERSION 3.16)
project(MyProject VERSION 1.0.0 LANGUAGES CXX)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
find_package(Qt6 REQUIRED COMPONENTS Core Gui Quick)
add_subdirectory(src)
add_subdirectory(tests)
Notas
- Esta skill asume que se utiliza CMake como sistema de construcción.
- Las reglas pueden adaptarse a las necesidades específicas del proyecto.
- Para proyectos que no utilicen Qt, la carpeta
qml/puede omitirse.