Skip to content

Mayo 9, 2024

Conferencia Vite SF

Integración de Backend

Nota

Si quieres servir el HTML utilizando herramientas backend tradicionales (como Rails, Laravel) pero usando Vite para servir los recursos, revisa la lista de integraciones existentes en Awesome Vite.

Si necesitas una integración personalizada, puedes seguir los pasos de esta guía para configuración manual.

  1. En tu configuración de Vite, configura el archivo de entrada y habilita el manifest de compilación:

    js
    // vite.config.js
    export default 
    defineConfig
    ({
    build
    : {
    // genera el archivo .vite/manifest.json en outDir
    manifest
    : true,
    rollupOptions
    : {
    // sobreescribe la entrada por defecto .html
    input
    : '/path/to/main.js',
    }, }, })

    Si no has desactivado el polyfill de precarga de modulos, tambien necesitarás importarlo en tu entrada.

    js
    // agrega esto en el archivo de entrada de tu app
    import 'vite/modulepreload-polyfill'
  2. Para desarrollo: coloca lo siguiente en la plantilla de servidor HTML (reemplaza http://localhost:5173 con la URL local donde Vite se está ejecutando):

    html
    <!-- si es desarrollo -->
    <script type="module" src="http://localhost:5173/@vite/client"></script>
    <script type="module" src="http://localhost:5173/main.js"></script>

    Para servir correctamente los recursos, tienes dos opciones:

    • Asegúrarse de que el servidor esté configurado para enviar solicitudes de recursos estáticos al servidor de Vite.
    • Configurar server.origin para que las URL de recursos generados resuelvan en la URL del servidor backend en lugar de una ruta relativa.

    Esto es necesario para que los recursos, como imágenes, se carguen correctamente.

    Ten en cuenta que si estas usando React con @vitejs/plugin-react, tambien necesitarás agregar esto antes del script de arriba, esto porque el plugin no podrá modificar el HTML que estás sirviendo (reemplaza http://localhost:5173 con la URL local donde Vite se está ejecutando):

    html
    <script type="module">
      import RefreshRuntime from 'http://localhost:5173/@react-refresh'
      RefreshRuntime.injectIntoGlobalHook(window)
      window.$RefreshReg$ = () => {}
      window.$RefreshSig$ = () => (type) => type
      window.__vite_plugin_react_preamble_installed__ = true
    </script>
  3. Para producción: despues de ejecutar vite build, se generará un archivo .vite/manifest.json junto a otros archivos de recursos. Un ejemplo de un archivo manifest sería algo como esto:

    json
    {
      "main.js": {
        "file": "assets/main.4889e940.js",
        "src": "main.js",
        "isEntry": true,
        "dynamicImports": ["views/foo.js"],
        "css": ["assets/main.b82dbe22.css"],
        "assets": ["assets/asset.0ab0f9cd.png"],
        "imports": ["_shared.83069a53.js"]
      },
      "views/foo.js": {
        "file": "assets/foo.869aea0d.js",
        "src": "views/foo.js",
        "isDynamicEntry": true,
        "imports": ["_shared.83069a53.js"]
      },
      "_shared.83069a53.js": {
        "file": "assets/shared.83069a53.js",
        "css": ["assets/shared.a834bfc3.css"]
      }
    }
    • El manifest tiene una estructura Record<name, chunk>.
    • Para fragmentos de entrada fija o dinámica, la key es la ruta src relativa de la raíz del proyecto.
    • Los fragmentos contendrán información en sus importaciones estaticas y dinamicas (ambos son keys que mapean al correspondiente fragmento en el manifest), y tambien su correspondiente css y archivo de recurso estatico (si los hay).
  4. Tambien puedes usar este archivo para renderizar links o precargar directivas con archivos con hash.

Aquí tienes un ejemplo de plantilla HTML para renderizar los enlaces adecuados. La sintaxis aquí es solo para explicación, sustitúyela con tu lenguaje de plantillas de servidor. La función importedChunks es solo para fines ilustrativos y no es proporcionada por Vite.

html
<!-- si es producción -->

```html
<!-- para cssFile de manifest[name].css -->
<link rel="stylesheet" href="/{{ cssFile }}" />

<!-- para fragmentos de importedChunks(manifest, name) -->
<!-- para cssFile de chunk.css -->
<link rel="stylesheet" href="/{{ cssFile }}" />

<script type="module" src="/{{ manifest[name].file }}"></script>

<!-- para fragmentos de importedChunks(manifest, name) -->
<link rel="modulepreload" href="/{{ chunk.file }}" />

Específicamente, un backend que genera HTML debería incluir las siguientes etiquetas dado un archivo de manifiesto y un punto de entrada:

  • Una etiqueta <link rel="stylesheet"> para cada archivo en la lista css del fragmento del punto de entrada.
  • Seguir recursivamente todos los fragmentos en la lista imports del punto de entrada e incluir una etiqueta <link rel="stylesheet"> para cada archivo CSS de cada fragmento importado.
  • Una etiqueta para la clave file del fragmento del punto de entrada (<script type="module"> para JavaScript, o <link rel="stylesheet"> para CSS)
  • Opcionalmente, una etiqueta <link rel="modulepreload"> para el file de cada fragmento de JavaScript importado, nuevamente siguiendo recursivamente las importaciones a partir del fragmento del punto de entrada.

Siguiendo el ejemplo de manifiesto anterior, para el punto de entrada main.js deberían incluirse las siguientes etiquetas en producción:

html
<link rel="stylesheet" href="assets/main.b82dbe22.css" />
<link rel="stylesheet" href="assets/shared.a834bfc3.css" />
<script type="module" src="assets/main.4889e940.js"></script>
<!-- opcional -->
<link rel="modulepreload" href="assets/shared.83069a53.js" />

Mientras que para el punto de entrada views/foo.js deberían incluirse las siguientes:

html
<link rel="stylesheet" href="assets/shared.a834bfc3.css" />
<script type="module" src="assets/foo.869aea0d.js"></script>
<!-- opcional -->
<link rel="modulepreload" href="assets/shared.83069a53.js" />

Publicado bajo licencia MIT. (e7e3ba79)