vite-plugin-mix

Motivation

Writing front-end and back-end API in a single project allows faster development (imo), this plugin essentially brings Next.js' API routes to your Vite app. I, rhildred, forked this to make the peer dependency less specific. I also added a handler in the example folder to serve a cloudflare function in the functions folder. I wanted this as I use stackblitz with my students and I wanted them to be able to write and test in a single project. For production the students can use cloudflare pages functions.

Install

npm i @rhildred/vite-plugin-mix -D

Usage

vite.config.ts:

import { defineConfig } from 'vite'
import mix from 'vite-plugin-mix'

export default defineConfig({
  plugins: [
    mix({
      handler: './src/cloudflare.js',
    }),
  ],
})

cloudflare.js:

import {functionsHandler} from 'cloudflare2express';
import dotenv from 'dotenv';

dotenv.config();
const modules = import.meta.glob('../functions/**/*.js', {
  import: 'onRequest',
  eager: true,
});
const app = functionsHandler(modules);
export const handler = app;

Alternatively one can still use the handler.ts:

import type { Handler } from 'vite-plugin-mix'

export const handler: Handler = (req, res, next) => {
  if (req.path === '/hello') {
    return res.end('hello')
  }
  next()
}

The handler runs before serving static files, so you should make sure to call next() as a fallback. You can also use express-compatible middlewares in the handler.

To start developing, run the command vite as usual.

To create a production build, run the command vite build as usual.

Now vite build will create a server build to ./build folder alongside your regular client build which is the ./dist folder by default. To run the production build as a Node.js server, run node build/server.mjs or if you have "type": "module" in your package.json, run node build/server.js instead.

Request flow

Adapters

Node.js

By default the server is built for Node.js target, you can run node build/server.mjs or node build/server.js after vite build to start the production server.

By default the server runs at port 3000, you can switch to a custom port by using the PORT environment variable.

Vercel

Warning

This may not work with some packages in a monorepo when using pnpm.

To build for Vercel, use the vercelAdapter in vite.config.ts:

import { defineConfig } from 'vite'
import mix, { vercelAdapter } from 'vite-plugin-mix'

export default defineConfig({
  plugins: [
    mix({
      handler: './handler.ts',
      adapter: vercelAdapter(),
    }),
  ],
})

Then you can run vite build to build for Vercel.

Guide

Using Express

import express from 'express'

const app = express()

export const handler = app

Using Polka

import polka from 'polka'

export const handler = (req, res, next) => {
  const app = polka({
    onNoMatch: () => next(),
  })

  return app.handler(req, res)
}

Using Apollo GraphQL

import { ApolloServer } from 'apollo-server-micro'
import { typeDefs } from './schemas'
import { resolvers } from './resolvers'

const apolloServer = new ApolloServer({ typeDefs, resolvers })

const GRAPHQL_ENDPOINT = '/api/graphql'

const apolloHandler = apolloServer.createHandler({ path: GRAPHQL_ENDPOINT })

export const handler = (req, res, next) => {
  if (req.path === '/api/graphql') {
    return apolloHandler
  }
  next()
}

You can also use express + apollo-server-express if you want.

License

MIT © EGOIST, the original author