Skip to content

README.md

Latest commit

 

History

History
435 lines (327 loc) · 9.38 KB

README.md

File metadata and controls

435 lines (327 loc) · 9.38 KB
Raw

@hono/vite-dev-server

@hono/vite-dev-server is a Vite Plugin that provides a custom dev-server for fetch-based web applications like those using Hono. You can develop your application with Vite. It's fast.

Features

  • Support any fetch-based applications.
  • Hono applications run on.
  • Fast by Vite.
  • HMR (Only for the client side).
  • Adapters are available, e.g., Cloudflare.
  • Also runs on Bun.

Demo

Screen.Recording.2023-09-07.at.15.05.25.mov

Supported applications

You can run any application on @hono/vite-dev-server that uses fetch and is built with Web Standard APIs. The minimal application is the following.

export default {
  fetch(_request: Request) {
    return new Response('Hello Vite!')
  },
}

This code can also run on Cloudflare Workers or Bun. And if you change the entry point, you can run on Deno, Vercel, Lagon, and other platforms.

Hono is designed for fetch-based applications like this.

import { Hono } from 'hono'

const app = new Hono()

app.get('/', (c) => c.text('Hello Vite!'))

export default app

So, any Hono application will run on @hono/vite-dev-server.

Usage

Installation

You can install vite and @hono/vite-dev-server via npm.

npm i -D vite @hono/vite-dev-server

Or you can install them with Bun.

bun add vite @hono/vite-dev-server

Settings

Add "type": "module" to your package.json. Then, create vite.config.ts and edit it.

import { defineConfig } from 'vite'
import devServer from '@hono/vite-dev-server'

export default defineConfig({
  plugins: [
    devServer({
      entry: 'src/index.ts', // The file path of your application.
    }),
  ],
})

Development

Just run vite.

npm exec vite

Or

bunx --bun vite

Options

The options are below.

export type DevServerOptions = {
  entry?: string
  export?: string
  injectClientScript?: boolean
  exclude?: (string | RegExp)[]
  ignoreWatching?: (string | RegExp)[]
  adapter?: {
    env?: Env
    onServerClose?: () => Promise<void>
  }
  handleHotUpdate?: VitePlugin['handleHotUpdate']
  base?: '' | `/${string}`
}

Default values:

export const defaultOptions: Required<Omit<DevServerOptions, 'cf'>> = {
  entry: './src/index.ts',
  injectClientScript: true,
  exclude: [
    /.*\.css$/,
    /.*\.ts$/,
    /.*\.tsx$/,
    /^\/@.+$/,
    /\?t\=\d+$/,
    /^\/favicon\.ico$/,
    /^\/static\/.+/,
    /^\/node_modules\/.*/,
  ],
  ignoreWatching: [/\.wrangler/],
  handleHotUpdate: ({ server, modules }) => {
    const isSSR = modules.some((mod) => mod.ssrModule)
    if (isSSR) {
      server.hot.send({ type: 'full-reload' })
      return []
    }
  },
  base: '/',
}

injectClientScript

If it's true and the response content type is "HTML", inject the script that enables Hot-reload. default is true.

exclude

The paths that are not served by the dev-server.

If you have static files in public/assets/* and want to return them, exclude /assets/* as follows:

import devServer, { defaultOptions } from '@hono/vite-dev-server'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    devServer({
      exclude: ['/assets/*', ...defaultOptions.exclude],
    }),
  ],
})

ignoreWatching

You can add target directories for the server to watch.

adapter

You can pass the env value of a specified environment to the application.

base

The base option specifies the base path under which your application is served. It provides behavior equivalent to Hono's .basePath(), but does not depend on Hono itself. Note that c.req will contain paths without the base you specify here.

Provide an empty string or / to serve from the root, or a leading-slash path such as /foo/bar.

When this option is set, the Vite base configuration will be overridden by the vite-dev-server.

For example, if you set base to /foo/bar, when a browser requests /foo/bar/path the vite-dev-server will handle that request and pass /path to your application.

import { defineConfig } from 'vite'
import devServer from '@hono/vite-dev-server'

export default defineConfig({
  plugins: [
    devServer({
      entry: 'src/index.tsx',
      base: '/foo/bar', // The app runs under '/foo/bar'
    }),
  ],
})

Adapter

Cloudflare

You can pass the Bindings specified in wrangler.toml to your application by using "Cloudflare Adapter".

Install miniflare and wrangler to develop and deploy your cf project.

npm i -D wrangler miniflare
import devServer from '@hono/vite-dev-server'
import cloudflareAdapter from '@hono/vite-dev-server/cloudflare'
import { defineConfig } from 'vite'

export default defineConfig(async () => {
  return {
    plugins: [
      devServer({
        adapter: cloudflareAdapter,
      }),
    ],
  }
})

Node.js & Bun

No additional dependencies needed.

import devServer from '@hono/vite-dev-server'
import nodeAdapter from '@hono/vite-dev-server/node'
// OR
// import bunAdapter from '@hono/vite-dev-server/bun'
import { defineConfig } from 'vite'

export default defineConfig(async () => {
  return {
    plugins: [
      devServer({
        adapter: nodeAdapter,
        // OR
        // adapter: bunAdapter,
      }),
    ],
  }
})

Helper

ConnInfo

You can use the ConnInfo helper to get connection information. For more details: ConnInfo Helper.

You can use it like this:

import { Hono } from 'hono'
import { getConnInfo } from '@hono/vite-dev-server/conninfo'

const app = new Hono()

app.get('/', (c) => {
  const info = getConnInfo(c) // info is `ConnInfo`
  return c.text(`Your remote address is ${info.remote.address}`)
})

You can also use different ConnInfo Helpers in development and production environments as shown below:

const getConnInfo = import.meta.env.DEV
  ? (await import('@hono/vite-dev-server/conninfo')).getConnInfo
  : (await import('hono/bun')).getConnInfo

Tips

You can get vite dev server's instance from request context.

import { Hono } from 'hono'
import type { ViteDevServer } from 'vite'

const app = new Hono<{ Bindings: { vite: ViteDevServer } }>()

app.get('/', (c) => {
  const vite = c.env.vite

  // ...

  const html = await vite.transformIndexHtml(c.req.url, someHtmlString)
  return c.html(html)
})

Client-side

You can write client-side scripts and import them into your application using Vite's features. If /src/client.ts is the entry point, simply write it in the script tag. Additionally, import.meta.env.PROD is useful for detecting whether it's running on a dev server or in the build phase.

app.get('/', (c) => {
  return c.html(
    <html>
      <head>
        {import.meta.env.PROD ? (
          <script type='module' src='/static/client.js'></script>
        ) : (
          <script type='module' src='/src/client.ts'></script>
        )}
      </head>
      <body>
        <h1>Hello</h1>
      </body>
    </html>
  )
})

In order to build the script properly, you can use the example config file vite.config.ts as shown below.

import { defineConfig } from 'vite'
import devServer from '@hono/vite-dev-server'

export default defineConfig(({ mode }) => {
  if (mode === 'client') {
    return {
      build: {
        rollupOptions: {
          input: ['./app/client.ts'],
          output: {
            entryFileNames: 'static/client.js',
            chunkFileNames: 'static/assets/[name]-[hash].js',
            assetFileNames: 'static/assets/[name].[ext]',
          },
        },
        emptyOutDir: false,
        copyPublicDir: false,
      },
    }
  } else {
    return {
      build: {
        minify: true,
        rollupOptions: {
          output: {
            entryFileNames: '_worker.js',
          },
        },
      },
      plugins: [
        devServer({
          entry: './app/server.ts',
        }),
      ],
    }
  }
})

You can run the following command to build the client script.

vite build --mode client

Frequently Asked Questions

exports is not defined

If you use a package that only supports CommonJS, you will encounter the error exports is not defined.

exports is not defined

In that case, specify the target package in ssr.external in vite.config.ts:

export default defineConfig({
  ssr: {
    external: ['react', 'react-dom'],
  },
  plugins: [devServer()],
})

Importing Asset as URL is not working

If you want to import assets as URL with the following code, the logo image may not be found.

import { Hono } from 'hono'

import logo from './logo.png'

const app = new Hono()

app.get('/', async (c) => {
  return c.html(
    <html>
      <body>
        <img src={logo} />
      </body>
    </html>
  )
})

export default app

This is because logo.png is served from this dev-server, even though it is expected to be served from Vite itself. So to fix it, you can add *.png to the exclude option:

import devServer, { defaultOptions } from '@hono/vite-dev-server'

export default defineConfig({
  plugins: [
    devServer({
      entry: 'src/index.tsx',
      exclude: [/.*\.png$/, ...defaultOptions.exclude],
    }),
  ],
})

Authors

License

MIT