Documentation
¶
Overview ¶
Package spa serves a single-page app built by Vite from the Go server, in production from the embedded build and in development by proxying to the Vite dev server, so the app has one origin in both.
Index ¶
Constants ¶
const BuildDir = "_build"
BuildDir is where the app's content-hashed build output goes, set in vite.config.ts as build.assetsDir. Handler caches everything under it as immutable, so it must hold nothing else: files copied from public/ keep their names, and cached forever they could never change.
const DevNonce = "vite-dev"
DevNonce is the CSP nonce Vite puts on the scripts and styles it injects in development, such as React's refresh preamble, when vite.config.ts sets html.cspNonce to it. A server's development CSP accepts it (see server.New), so its policy can stay strict while it proxies Vite.
Variables ¶
This section is empty.
Functions ¶
func Built ¶ added in v0.3.0
Built reports whether dist holds a Vite build rather than the placeholder that lets the Go module build before the web app has: whether Handler serves it or proxies to the dev server. Use it for anything else that differs in development, such as where generated files are read from.
func Handler ¶
Handler serves the Vite build in dist. For a request path it serves, in order: the file at that path, preferring a precompressed .br or .gz sibling the client accepts; a prerendered <path>/index.html; for a path with no file extension, index.html, so client-side routes work on reload; and otherwise a 404. Files under BuildDir are cached for a year.
When dist holds no build, as when the Go module is built before the web app, Handler proxies every request to opts.DevServer, including Vite's HMR WebSocket. It returns an error if there is neither a build nor a dev server.
Types ¶
type Options ¶
type Options struct {
// Index rewrites index.html for a request, for example to set <html lang>
// from Accept-Language or add <base href>. It applies in development too.
Index func(r *http.Request, html []byte) []byte
// NotFound reports whether a path other than the root that matches no
// file and no prerendered page is unknown to the app. Its shell is then
// sent with a 404, so crawlers see an honest status while the router
// renders its own page. By default every such path is a client-side
// route, sent with a 200.
NotFound func(r *http.Request) bool
// DevServer is the Vite dev server's URL, such as "http://localhost:5173".
// When dist holds no build, Handler proxies to it.
DevServer string
}
Options configure Handler.
Source Files