Configuración del Proyecto
Un proyecto tyrus generado tiene un manifiesto pequeño, un punto de entrada, archivos de entorno tipados opcionales y un directorio target/ para artefactos generados.
Estructura del Proyecto
my-project/
├── __tests__/
│ └── greeting.test.tyr
├── src/
│ ├── greeting.tyr
│ └── main.tyr
├── target/
├── .env
├── .env.example
├── .gitignore
├── tyrus-fmt.json
├── tyrus-lint.json
└── tyrus.jsonEste es el proyecto script predeterminado. La plantilla cli agrega src/prompts/setup.tyr y usa __tests__/example.test.tyr en lugar de la prueba predeterminada. La plantilla api agrega src/controllers/user.tyr, src/models/user.tyr, src/repositories/user.tyr, src/routes/user.tyr, src/schemas/user.tyr y src/services/user.tyr, y también usa __tests__/example.test.tyr. La plantilla api crea el directorio data/ cuando se selecciona SQLite.
src/main.tyr es el archivo de entrada obligatorio y debe declarar const main = (): void => { ... };. La ruta y la firma de la función son fijas. Los artefactos de compilación se escriben en target/debug/ de forma predeterminada y en target/release/ con tyrus build --release. tyrus dev usa target/debug/.
tyrus.json
{
"project": {
"name": "my-project",
"version": "0.1.0",
"authors": [],
"description": ""
},
"scripts": {
"fmt": "tyrus fmt",
"lint": "tyrus lint",
"test": "tyrus test"
},
"security": {
"envFile": ".env",
"envSealed": false
},
"imports": {
"#": "./src"
}
}project describe metadata del paquete. build.optimize selecciona el modo de optimización predeterminado. development.https hace que un servidor arrancado sin tls sirva HTTPS en localhost mientras el programa se ejecuta con TYRUS_ENV=development, y no hace nada en cualquier otro entorno; consulta createRouter. runtime.workerThreads limita cuántos hilos de trabajo puede usar el runtime asíncrono y, si se omite, adopta el número de CPUs lógicas. security.envFile habilita análisis tipado de entorno. security.envSealed cambia la carga de entorno en runtime por un artefacto sealed cifrado.
scripts asigna nombres de scripts del proyecto a comandos de shell. Los manifiestos generados incluyen las entradas fmt, lint y test. Añade un script personalizado como valor string y ejecútalo por su nombre con tyrus run <name>. Por ejemplo, esta entrada hace que tyrus run example ejecute tyrus run example.tyr desde el directorio del proyecto:
{
"scripts": {
"example": "tyrus run example.tyr"
}
}Los argumentos para el comando configurado van después de --, como en tyrus run example -- --verbose. tyrus --init conserva los scripts personalizados al agregar los valores predeterminados que faltan; tyrus --default restablece el manifiesto con los valores predeterminados generados para el proyecto y elimina los scripts personalizados.
Sitio de Documentación
La documentación del repositorio vive en docs/ y se buildea con VitePress:
npm run docs:dev
npm run docs:build
npm run docs:build:versions
npm run docs:previewLa documentación actual se publica en /. Releases archivados se generan desde Git tags en rutas como /v0.1.0/. La metadata de versión vive en docs/.vitepress/versions.ts.
