Ir al contenido

Generación de código

Desde la sección Código, Restorm genera el código de su aplicación a partir de su diseño. La generación se apoya en plantillas compatibles con Cookiecutter/Copier: las suyas, o las propuestas por Restorm.

La sección Código: una plantilla añadida, una carpeta de salida y la previsualización del árbol generado antes de escribir

  1. Añada una o varias plantillas — mediante la biblioteca de plantillas.
  2. Elija una carpeta de salida (absoluta, o relativa al proyecto).
  3. Haga clic en Generar el proyecto.

La generación se renderiza en una sandbox y luego se produce en forma de previsualización: Restorm le muestra el árbol de los archivos generados y no escribe nada mientras no lo haya confirmado. Puede entonces Escribir en la carpeta de salida o Abandonar. (La generación está bloqueada mientras queden problemas de validación.)

Una plantilla puede declarar preguntas (en el sentido de Copier — por ejemplo un project_slug), a las que usted responde en el momento de generar. Sus respuestas se guardan en un archivo .copier-answers.yml en la raíz de la salida, y se recargan en la generación siguiente.

La generación no es unidireccional. Regenerar cumple el papel de un copier update: Restorm memoriza una base y realiza una fusión a tres vías entre la nueva salida de la plantilla y sus modificaciones locales — sus cambios, por lo tanto, no se sobrescriben. Usted hace evolucionar su diseño (o la plantilla), regenera, y el código se actualiza preservando su trabajo.

La biblioteca de plantillas propone cuatro fuentes:

  • Oficial — las plantillas mantenidas por Restorm, visibles por todos.
  • Organización — las plantillas compartidas dentro de su organización, privadas para sus miembros. Es una funcionalidad Enterprise: un admin — o un miembro con el derecho gestionar las plantillas — las añade o las retira (URL del repositorio + descripción), desde la pestaña Plantillas <organización> de la biblioteca o desde el tablero de administración. Véase Plantillas oficiales y de organización.
  • Repositorio — un repositorio GitHub propietario/nombre (típicamente un fork de una plantilla oficial que ha adaptado).
  • Carpeta local — una plantilla en desarrollo, sin red.

La estructura de una plantilla y el catálogo oficial se describen en la página Plantillas oficiales. Lo que una plantilla recibe de su diseño (modelos, rutas y sus flags) se detalla en El contexto de la plantilla, y los ajustes propios de la plantilla en Variables de generación.