vite-fusion 0.0.9

Easily integrate Python, Flask and Vite

Vite Fusion: Integrating Vite with Flask

Author: Claudio González © 2024 Banshee
Website: https://www.banshee.pro/
License: MIT License

---

This module provides functions to register and serve Vite generated assets in Flask applications. It supports both the Vite development server and production environments using the manifest.json file.

---

Table of Contents

• Installation
• Usage
• Parameters
• Examples
• License

---

Installation

On your Python interpreter pip install vite-fusion then:

1. Install the required dependencies for Flask and Vite.
2. Copy the register_vite_assets function into your project.

---

Usage

After initializing your Flask application, call the register_vite_assets function to integrate Vite assets.

Example Usage:

from vite_fusion import register_vite_assets

app = Flask(__name__)

register_vite_assets(
    app,
    dev_mode=True,
    dev_server_url="http://localhost:5173",
    manifest_path="src/dist/.vite/manifest.json",
    nonce_provider=my_nonce_provider,  # Optional
    logger=my_logger                   # Optional
)

---

Parameters

Parameter	Type	Description	Default Value
app	Flask	The Flask application instance.	Required
dev_mode	bool	Indicates if the Vite development server is running.	True
dev_server_url	str	URL of the Vite development server (e.g., http://localhost:5173).	"http://localhost:5173"
dist_path	str	Production Dist Path (e.g., /src/dist or /homedock-vue3/dist).	"/src/dist"
manifest_path	str	Path to the production manifest.json generated by Vite.	"src/dist/.vite/manifest.json"
nonce_provider	callable or None	Function returning a nonce (string) for CSP headers. If None, no nonce attribute is added.	None
logger	logging.Logger or None	Logger instance for errors and warnings. If None, logging is disabled.	None

---

manifest.json in dev mode?

Although accessing the manifest.json file in development mode is not a common practice, we concluded that searching for and loading files directly from it in development mode, without needing to set up an array of files, is the most appropriate approach. As a result, the manifest.json file must be available in both development and production environments. This is why we recommend running npm run build before starting to use this integration.

---

Examples

Registering Vite Assets in Development Mode

register_vite_assets(
    app,
    dev_mode=True,
    dev_server_url="http://localhost:5173",
    manifest_path="src/dist/.vite/manifest.json"
)

Registering Vite Assets in Production Mode

register_vite_assets(
    app,
    dev_mode=False,
    dev_server_url="http://localhost:5173",
    dist_path="/src/dist"
    manifest_path="src/dist/.vite/manifest.json",
    nonce_provider=my_nonce_provider
)

or

register_vite_assets(
    homedock_www,
    dev_mode=False,
    dev_server_url="http://localhost:5173",
    dist_path="/src/dist"
    manifest_path="src/dist/.vite/manifest.json",
    nonce_provider=nonce_value,
    logger=None
)

---

How can I make it work?

Ensure that Flask is set up to serve the directories and files Vite needs to load. This includes the static folder during development and the dist folder for production. You can do this by adding the following code to your Flask app:

from flask import send_from_directory

def send_src_static(path):
    return send_from_directory(os.path.join(app.root_path, "src", "static"), path)

def send_src_dist(path):
    return send_from_directory(os.path.join(app.root_path, "src", "dist"), path)

This makes Flask capable of serving files from your ./src folder. (Make sure it fits your dist_path)

Update your vite.config.js to look something like this:

// vite.config.js
import { defineConfig } from "vite";
import { resolve } from "path";

export default defineConfig({
  build: {
    outDir: "src/dist",
    manifest: true,
    rollupOptions: {
      input: {
        global: resolve(__dirname, "src/static/css/global.css"),
        anyOtherCSSFile: resolve(__dirname, "src/static/css/otherCSS.css"),
        mainfileExample: resolve(__dirname, "src/static/js/mainfile_example.js"),
        externalImportsExample: resolve(__dirname, "src/static/js/externalImports_example.js"),
      },
    },
  },
});

The manifest: true setting is critical. After configuring it, run an initial build to generate the manifest.json. This manifest maps your assets to the correct files, ensuring Flask knows how to locate them.

For development mode, make sure manifest.json is also accessible, as it’s required for Vite Hot Reloading (HR) and file resolution through vite-fusion. Without the manifest, Flask won't be able to locate the correct files, even in development.

The same logic used for JavaScript file injection applies to CSS files. Ensure they are also ingested through the manifest.

After that you will be able to load Vite generated assets on your Jinja2 templates such as this:

{{ vitecss("global") | safe }}
{{ vitecss("anyOtherCSSFile") | safe }}
{{ vitejs("mainfileExample") | safe }}
{{ vitejs("externalImportsExample") | safe }}

Works properly with Vue, React, Tailwind etc...

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

About This Integration

This integration was heavily inspired by Laravel-Vite-Plugin. While it may not be as feature-rich, it was designed to deliver a similar functionality and workflow tailored for HomeDock OS, one of our Python projects. HomeDock OS is a robust and versatile platform for home automation and cloud management. Learn more at homedock.cloud.

It's time to stop relegating the backend to being just an API. With integrations like this, we can truly unlock a seamless and efficient full-stack experience, with proper collaboration between frontend and backend development.

---

Contributing and Support

Feel free to fork this repository and contribute! For any bug fixes, security concerns, or other issues, please email us at [e-mail].