Typesync (Rollup plugin)

rollup-plugin-typesync is a Rollup plugin to automatically generate TypeScript types and client-side request helpers directly from a Flask application. It requires the typesync Python package to be installed and configured in your Flask backend.

Installation

You can install this plugin using npm install rollup-plugin-typesync.

Usage

To enable this plugin, add the following to your vite.config.ts:

import { defineConfig } from "vite";
import typesyncPlugin from "rollup-plugin-typesync";


export default defineConfig({
    plugins: [
        typesyncPlugin({
            outDir: "src/flask_urls",  // The directory to place the generated TypesScript code in
            backendRoot: "../backend"  // The directory where your Flask entry point lives
        })
    ]
});

Configuration

You can use the plugin's configuration object to specify the values of available flags in the command line utility, such as:

export default defineConfig({
    plugins: [
        typesyncPlugin({
            outDir: "src/flask_urls",
            backendRoot: "../backend",
            inference: true,
            translators: ["custom_translator1.py"]
        })
    ]
});