Guía de desarrollo
AgentSync es un monorepo que combina un núcleo de alto rendimiento en Rust con una capa de distribución en TypeScript. Esta guía resume el flujo de desarrollo de ambos componentes.
Estructura del monorepo
Sección titulada «Estructura del monorepo»src/: lógica central y CLI en Rust.npm/agentsync/: wrapper TypeScript para distribuir el paquete npm.website/docs/: sitio de documentación construido con Starlight.tests/: pruebas de integración para la CLI.
Desarrollo en Rust
Sección titulada «Desarrollo en Rust»El núcleo está escrito en Rust para ofrecer rendimiento, seguridad y una distribución sencilla como binario.
Herramientas y versiones
Sección titulada «Herramientas y versiones»- Versión: Rust 1.89 o posterior (Edition 2024).
- Herramienta principal:
cargo.
Comandos habituales
Sección titulada «Comandos habituales»cargo build # Compila el binario de depuracióncargo test # Ejecuta las pruebas unitarias y de integracióncargo run -- apply # Ejecuta la CLI local con argumentoscargo clippy # Analiza el códigocargo fmt # Formatea el códigoManejo de errores
Sección titulada «Manejo de errores»Usamos thiserror para definir errores recuperables propios en el núcleo y anyhow para el manejo de errores de nivel superior en los puntos de entrada de la CLI.
Desarrollo en JavaScript y TypeScript
Sección titulada «Desarrollo en JavaScript y TypeScript»El workspace de JS actúa como wrapper y facilita la instalación mediante pnpm o npm. Administra la descarga de binarios por plataforma y ofrece una API programática.
Herramientas y versiones
Sección titulada «Herramientas y versiones»- Node.js: >=18 (requisito de
npm/agentsync). - Node.js para desarrollo: v24.14.0 o posterior (recomendado; consulta
.nvmrc). - Administrador de paquetes:
pnpm10 o posterior. - Ubicación:
npm/agentsync/.
Comandos habituales
Sección titulada «Comandos habituales»pnpm install # Instala dependenciaspnpm run # Muestra los scripts disponiblespnpm --filter agentsync run buildpnpm --filter agentsync run typecheckPruebas y calidad
Sección titulada «Pruebas y calidad»Desde la raíz del repositorio, ejecuta las comprobaciones relevantes para tu cambio:
cargo fmt --all -- --checkcargo clippy --all-targets --all-features -- -D warningscargo test --all-featurespnpm --filter agentsync run testpnpm --filter agentsync-docs run buildPara la lista de comandos y las expectativas de cada área, consulta .agents/AGENTS.md y el Makefile. Evita ejecutar una validación amplia si un comando enfocado da evidencia suficiente para un cambio pequeño.
Compilar el sitio de documentación
Sección titulada «Compilar el sitio de documentación»El sitio está en website/docs/ y usa Astro con Starlight. Para compilarlo desde la raíz del repositorio, ejecuta:
pnpm --filter agentsync-docs run buildSi modificas contenido o navegación, comprueba que las rutas generadas mantengan el idioma correcto. Consulta la referencia de configuración y la referencia de CLI para revisar los detalles técnicos.