Skip to content

📄 Serve static files during local development

License

Notifications You must be signed in to change notification settings

reifiedbeans/vite-plugin-serve-static

Repository files navigation

vite-plugin-serve-static

npm vite license: MIT

A simple Vite plugin for serving arbitrary static files that aren't in your public directory.

// vite.config.ts
import path from "path";
import { defineConfig } from "vite";
import serveStatic from "vite-plugin-serve-static";

const serveStaticPlugin = serveStatic([
  {
    pattern: /^\/metadata\.json/,
    resolve: "./metadata.json",
  },
  {
    pattern: /^\/dog-photos\/.*/,
    resolve: ([match]) => path.join("..", "dog-photos", match),
  },
  {
    pattern: /^\/author-photos\/(.*)/,
    resolve: (groups) => path.join("..", "authors", groups[1]) + ".jpg",
  },
]);

export default defineConfig({
  plugins: [serveStaticPlugin],
});

Config

The configuration is defined as an array of objects defining which patterns to intercept and how to resolve them.

Each pattern is defined as a regular expression. The resolve property can either be a string containing the path to a single file or a function that returns a string given the result of executing the pattern against the request path.

License

Licensed under the MIT License.

About

📄 Serve static files during local development

Topics

Resources

License

Stars

Watchers

Forks