vite-plugin-serve-static 2.0.0 → 2.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2025 Drew Davis
+Copyright (c) 2023-2026 Drew Davis
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -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],
@@ -35,12 +37,12 @@ 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
 
-Licensed under the [MIT License](https://github.com/typeparameter/vite-plugin-serve-static/blob/main/LICENSE).
+Licensed under the [MIT License](https://github.com/typeparameter/vite-plugin-serve-static/blob/main/packages/vite-plugin-serve-static/LICENSE).
 
 [regular expression]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp

package/dist/index.d.mts

@@ -1,13 +1,27 @@
 import { Plugin } from "vite";
+import http from "http";
 
 //#region lib/config.d.ts
 type ResolveFn = (match: RegExpExecArray) => string;
-type Config = {
+type RuleConfig = {
   readonly pattern: RegExp;
   readonly resolve: string | ResolveFn;
-}[];
+  readonly headers?: http.OutgoingHttpHeaders;
+};
+type Config = RuleConfig[] | {
+  readonly rules: RuleConfig[];
+  readonly contentType?: string;
+};
+declare function normalizeConfig(config: Config): {
+  contentType?: string;
+  rules: {
+    headers: http.OutgoingHttpHeaders;
+    pattern: RegExp;
+    resolve: string | ResolveFn;
+  }[];
+};
 //#endregion
 //#region lib/index.d.ts
 declare function serveStatic(config: Config): Plugin;
 //#endregion
-export { Config, ResolveFn, serveStatic as default };
+export { Config, ResolveFn, serveStatic as default, normalizeConfig };

package/dist/index.mjs

@@ -3,6 +3,24 @@ import path from "path";
 import corsMiddleware from "cors";
 import * as mime from "mime-types";
 
+//#region lib/config.ts
+function normalizeConfig(config) {
+	const { rules, ...rest } = Array.isArray(config) ? { rules: config } : config;
+	return {
+		rules: rules.map((rule) => ({
+			...rule,
+			headers: normalizeHeaders(rule.headers)
+		})),
+		...rest
+	};
+}
+function normalizeHeaders(headers) {
+	if (!headers) return {};
+	const entries = Object.entries(headers).filter(([, value]) => value !== void 0).map(([key, value]) => [key.toLowerCase(), value]);
+	return Object.fromEntries(entries);
+}
+
+//#endregion
 //#region lib/utils.ts
 function isDevServer(server) {
 	return "pluginContainer" in server;
@@ -30,11 +48,12 @@ function setupLogger(logger) {
 
 //#endregion
 //#region lib/middleware.ts
-function createMiddleware(config, rawLogger) {
+function createMiddleware(pluginConfig, rawLogger) {
 	const log = setupLogger(rawLogger);
+	const config = normalizeConfig(pluginConfig);
 	return function serveStaticMiddleware(req, res, next) {
 		if (!req.url) return next();
-		for (const { pattern, resolve } of config) {
+		for (const { pattern, resolve, headers } of config.rules) {
 			const match = pattern.exec(req.url);
 			if (match) {
 				const filePath = typeof resolve === "string" ? resolve : resolve(match);
@@ -45,10 +64,11 @@ function createMiddleware(config, rawLogger) {
 					log.error(`File ${filePath} is not a file`);
 					return;
 				}
-				const type = mime.contentType(path.basename(filePath));
+				const contentType = headers["content-type"] || config.contentType || mime.contentType(path.basename(filePath)) || "application/octet-stream";
 				res.writeHead(200, {
-					"Content-Length": stats.size,
-					"Content-Type": type || "application/octet-stream"
+					"content-length": stats.size,
+					"content-type": contentType,
+					...headers
 				});
 				fs.createReadStream(filePath).pipe(res);
 				return;
@@ -82,4 +102,4 @@ function serveStatic(config) {
 }
 
 //#endregion
-export { serveStatic as default };
+export { serveStatic as default, normalizeConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-serve-static",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A Vite plugin for serving static files during local development",
   "repository": {
     "type": "git",
@@ -20,12 +20,9 @@
   ],
   "main": "dist/index.mjs",
   "types": "dist/index.d.mts",
-  "packageManager": "pnpm@10.0.0",
   "scripts": {
     "build": "tsdown",
     "clean": "rimraf dist",
-    "format": "prettier --cache --write .",
-    "format:check": "prettier --cache --check .",
     "lint": "tsc && eslint --cache --max-warnings=0 .",
     "lint:fix": "tsc && eslint --fix --cache --max-warnings=0 .",
     "prepack": "pnpm build",
@@ -39,26 +36,15 @@
     "mime-types": "^2.1.35"
   },
   "devDependencies": {
-    "@eslint/compat": "^2.0.0",
-    "@eslint/js": "^9.39.2",
-    "@ianvs/prettier-plugin-sort-imports": "^4.7.0",
     "@types/cors": "^2.8.17",
     "@types/mime-types": "^2.1.4",
-    "conventional-changelog-conventionalcommits": "^8.0.0",
-    "eslint": "^9.39.2",
-    "eslint-config-prettier": "^10.1.8",
-    "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
     "tsdown": "^0.18.4",
     "typescript": "~5.7.2",
-    "typescript-eslint": "^8.51.0",
     "vitest": "^4.0.16"
   },
   "publishConfig": {
     "access": "public",
     "provenance": true
-  },
-  "release": {
-    "preset": "conventionalcommits"
   }
 }