Skip to content

feat: allow customization of response headers #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typeparameter merged 3 commits into from
Mar 3, 2026
Merged

feat: allow customization of response headers #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5c78b8
feat: allow customization of response headers
typeparameter Mar 2, 2026
c798afa
filter out undefined header values
typeparameter Mar 2, 2026
34b4e20
update documentation
typeparameter Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 34 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,22 @@ import path from "path";
import { defineConfig } from "vite";
import serveStatic from "vite-plugin-serve-static";

const serveStaticPlugin = serveStatic([
{
pattern: /^\/metadata\.json/,
resolve: path.join(".", "metadata.json"),
},
{
pattern: /^\/dog-photos\/.*/,
resolve: ([match]) => path.join("..", "dog-photos", match),
},
{
pattern: /^\/author-photos\/(.*)/,
resolve: (groups) => path.join("..", "authors", groups[1]) + ".jpg",
},
]);
const serveStaticPlugin = serveStatic({
rules: [
{
pattern: /^\/metadata\.json/,
resolve: path.join(".", "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],
Expand All @@ -35,9 +37,25 @@ export default defineConfig({

## Config

The configuration is defined as an array of objects defining which patterns to intercept and how to resolve them.
The configuration is provided as an object with `rules`, plus an optional global `contentType`.

Each rule defines 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. Rules can also specify `headers` to apply per match.

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.
```typescript
const serveStaticPlugin = serveStatic({
contentType: "text/plain",
rules: [
{
pattern: /^\/metadata\.json/,
resolve: path.join(".", "metadata.json"),
headers: {
"Cache-Control": "no-store",
"X-Static-File": "true",
},
},
],
});
```

## License

Expand Down
30 changes: 16 additions & 14 deletions apps/example/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,21 @@ const staticDir = path.join(__dirname, "static");

export default defineConfig({
plugins: [
serveStatic([
{
pattern: /^\/metadata\.json$/,
resolve: path.join(staticDir, "metadata.json"),
},
{
pattern: /^\/data\/(.*)$/,
resolve: (match: RegExpExecArray) => path.join(staticDir, "data", `${match[1]!}.csv`),
},
{
pattern: /^\/pages\/(.*)$/,
resolve: (match: RegExpExecArray) => path.join(staticDir, "pages", `${match[1]!}.html`),
},
]),
serveStatic({
rules: [
{
pattern: /^\/metadata\.json$/,
resolve: path.join(staticDir, "metadata.json"),
},
{
pattern: /^\/data\/(.*)$/,
resolve: (match: RegExpExecArray) => path.join(staticDir, "data", `${match[1]!}.csv`),
},
{
pattern: /^\/pages\/(.*)$/,
resolve: (match: RegExpExecArray) => path.join(staticDir, "pages", `${match[1]!}.html`),
},
],
}),
],
});
34 changes: 18 additions & 16 deletions packages/vite-plugin-serve-static/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,22 @@ import path from "path";
import { defineConfig } from "vite";
import serveStatic from "vite-plugin-serve-static";

const serveStaticPlugin = serveStatic([
{
pattern: /^\/metadata\.json/,
resolve: path.join(".", "metadata.json"),
},
{
pattern: /^\/dog-photos\/.*/,
resolve: ([match]) => path.join("..", "dog-photos", match),
},
{
pattern: /^\/author-photos\/(.*)/,
resolve: (groups) => path.join("..", "authors", groups[1]) + ".jpg",
},
]);
const serveStaticPlugin = serveStatic({
rules: [
{
pattern: /^\/metadata\.json/,
resolve: path.join(".", "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],
Expand All @@ -35,9 +37,9 @@ export default defineConfig({

## Config

The configuration is defined as an array of objects defining which patterns to intercept and how to resolve them.
The configuration is provided as an object with `rules`, plus an optional global `contentType`.

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.
Each rule defines 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

Expand Down
Loading