vite-plugin-serve-static 1.2.0 → 2.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2024 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

@@ -2,30 +2,33 @@
 
 [![npm](https://img.shields.io/npm/v/vite-plugin-serve-static/latest)](https://www.npmjs.com/package/vite-plugin-serve-static)
 [![vite](https://img.shields.io/npm/dependency-version/vite-plugin-serve-static/peer/vite)](https://github.com/vitejs/vite)
-[![license: MIT](https://img.shields.io/npm/l/vite-plugin-serve-static)](https://github.com/reifiedbeans/vite-plugin-serve-static/blob/main/LICENSE)
+[![license: MIT](https://img.shields.io/npm/l/vite-plugin-serve-static)](https://github.com/typeparameter/vite-plugin-serve-static/blob/main/LICENSE)
 
 A simple Vite plugin for serving arbitrary static files that aren't in your `public` directory.
 
 ```typescript
 // 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",
-  },
-]);
+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],
@@ -34,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/reifiedbeans/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

@@ -0,0 +1,27 @@
+import { Plugin } from "vite";
+import http from "http";
+
+//#region lib/config.d.ts
+type ResolveFn = (match: RegExpExecArray) => string;
+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, normalizeConfig };

package/dist/index.mjs

@@ -0,0 +1,105 @@
+import fs from "fs";
+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;
+}
+function setupLogger(logger) {
+	const defaultOptions = { timestamp: true };
+	function applyDefaultOptions(log) {
+		return function(msg, options) {
+			log(msg, {
+				...defaultOptions,
+				...options
+			});
+		};
+	}
+	return {
+		clearScreen: logger.clearScreen,
+		hasErrorLogged: logger.hasErrorLogged,
+		hasWarned: logger.hasWarned,
+		info: applyDefaultOptions(logger.info),
+		warn: applyDefaultOptions(logger.warn),
+		warnOnce: applyDefaultOptions(logger.warnOnce),
+		error: applyDefaultOptions(logger.error)
+	};
+}
+
+//#endregion
+//#region lib/middleware.ts
+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, headers } of config.rules) {
+			const match = pattern.exec(req.url);
+			if (match) {
+				const filePath = typeof resolve === "string" ? resolve : resolve(match);
+				const stats = fs.statSync(filePath, { throwIfNoEntry: false });
+				if (!stats || !stats.isFile()) {
+					res.writeHead(404);
+					res.end("Not found");
+					log.error(`File ${filePath} is not a file`);
+					return;
+				}
+				const contentType = headers["content-type"] || config.contentType || mime.contentType(path.basename(filePath)) || "application/octet-stream";
+				res.writeHead(200, {
+					"content-length": stats.size,
+					"content-type": contentType,
+					...headers
+				});
+				fs.createReadStream(filePath).pipe(res);
+				return;
+			}
+		}
+		return next();
+	};
+}
+function applyMiddleware(server, pluginConfig) {
+	const pluginMiddleware = createMiddleware(pluginConfig, server.config.logger);
+	const corsConfig = isDevServer(server) ? server.config.server.cors : server.config.preview.cors;
+	if (corsConfig !== false) {
+		const config = typeof corsConfig === "boolean" ? {} : corsConfig;
+		server.middlewares.use(corsMiddleware(config));
+	}
+	server.middlewares.use(pluginMiddleware);
+}
+
+//#endregion
+//#region lib/index.ts
+function serveStatic(config) {
+	return {
+		name: "serve-static",
+		configureServer(server) {
+			applyMiddleware(server, config);
+		},
+		configurePreviewServer(server) {
+			applyMiddleware(server, config);
+		}
+	};
+}
+
+//#endregion
+export { serveStatic as default, normalizeConfig };

package/package.json

@@ -1,30 +1,31 @@
 {
   "name": "vite-plugin-serve-static",
-  "version": "1.2.0",
+  "version": "2.1.0",
   "description": "A Vite plugin for serving static files during local development",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/reifiedbeans/vite-plugin-serve-static.git"
+    "url": "git+https://github.com/typeparameter/vite-plugin-serve-static.git"
   },
   "license": "MIT",
-  "homepage": "https://github.com/reifiedbeans/vite-plugin-serve-static",
+  "homepage": "https://github.com/typeparameter/vite-plugin-serve-static",
   "keywords": [
     "vite-plugin"
   ],
   "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
   "files": [
     "dist"
   ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/index.mjs",
+  "types": "dist/index.d.mts",
   "scripts": {
-    "build": "tsc && tsup",
+    "build": "tsdown",
     "clean": "rimraf dist",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
-    "lint": "eslint --cache --max-warnings=0 .",
-    "lint:fix": "eslint --fix --cache --max-warnings=0 .",
-    "prepack": "npm-run-all build test lint format:check",
+    "lint": "tsc && eslint --cache --max-warnings=0 .",
+    "lint:fix": "tsc && eslint --fix --cache --max-warnings=0 .",
+    "prepack": "pnpm build",
     "test": "vitest --run"
   },
   "peerDependencies": {
@@ -35,25 +36,15 @@
     "mime-types": "^2.1.35"
   },
   "devDependencies": {
-    "@trivago/prettier-plugin-sort-imports": "^5.2.0",
     "@types/cors": "^2.8.17",
     "@types/mime-types": "^2.1.4",
-    "@typescript-eslint/eslint-plugin": "^8.18.0",
-    "@typescript-eslint/parser": "^8.18.0",
-    "conventional-changelog-conventionalcommits": "^8.0.0",
-    "eslint": "^8.57.1",
-    "eslint-config-prettier": "^9.1.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
-    "tsup": "~8.4.0",
+    "tsdown": "^0.18.4",
     "typescript": "~5.7.2",
-    "vitest": "^3.0.8"
+    "vitest": "^4.0.16"
   },
   "publishConfig": {
-    "access": "public"
-  },
-  "release": {
-    "preset": "conventionalcommits"
+    "access": "public",
+    "provenance": true
   }
 }

package/dist/index.d.ts

@@ -1,11 +0,0 @@
-import { Plugin } from 'vite';
-
-type ResolveFn = (match: RegExpExecArray) => string;
-type Config = {
-    readonly pattern: RegExp;
-    readonly resolve: string | ResolveFn;
-}[];
-
-declare function serveStatic(config: Config): Plugin;
-
-export { type Config, type ResolveFn, serveStatic as default };

package/dist/index.js

@@ -1,84 +0,0 @@
-// lib/middleware.ts
-import * as mime from "mime-types";
-import corsMiddleware from "cors";
-import fs from "fs";
-import path from "path";
-
-// lib/utils.ts
-function isDevServer(server) {
-  return "pluginContainer" in server;
-}
-function setupLogger(logger) {
-  const defaultOptions = { timestamp: true };
-  function applyDefaultOptions(log) {
-    return function(msg, options) {
-      log(msg, { ...defaultOptions, ...options });
-    };
-  }
-  return {
-    clearScreen: logger.clearScreen,
-    hasErrorLogged: logger.hasErrorLogged,
-    hasWarned: logger.hasWarned,
-    info: applyDefaultOptions(logger.info),
-    warn: applyDefaultOptions(logger.warn),
-    warnOnce: applyDefaultOptions(logger.warnOnce),
-    error: applyDefaultOptions(logger.error)
-  };
-}
-
-// lib/middleware.ts
-function createMiddleware(config, rawLogger) {
-  const log = setupLogger(rawLogger);
-  return function serveStaticMiddleware(req, res, next) {
-    if (!req.url) {
-      return next();
-    }
-    for (const { pattern, resolve } of config) {
-      const match = pattern.exec(req.url);
-      if (match) {
-        const filePath = typeof resolve === "string" ? resolve : resolve(match);
-        const stats = fs.statSync(filePath, { throwIfNoEntry: false });
-        if (!stats || !stats.isFile()) {
-          res.writeHead(404);
-          res.end("Not found");
-          log.error(`File ${filePath} is not a file`);
-          return;
-        }
-        const type = mime.contentType(path.basename(filePath));
-        res.writeHead(200, {
-          "Content-Length": stats.size,
-          "Content-Type": type || "application/octet-stream"
-        });
-        const stream = fs.createReadStream(filePath);
-        stream.pipe(res);
-        return;
-      }
-    }
-    return next();
-  };
-}
-function applyMiddleware(server, pluginConfig) {
-  const pluginMiddleware = createMiddleware(pluginConfig, server.config.logger);
-  const corsConfig = isDevServer(server) ? server.config.server.cors : server.config.preview.cors;
-  if (corsConfig !== false) {
-    const config = typeof corsConfig === "boolean" ? {} : corsConfig;
-    server.middlewares.use(corsMiddleware(config));
-  }
-  server.middlewares.use(pluginMiddleware);
-}
-
-// lib/index.ts
-function serveStatic(config) {
-  return {
-    name: "serve-static",
-    configureServer(server) {
-      applyMiddleware(server, config);
-    },
-    configurePreviewServer(server) {
-      applyMiddleware(server, config);
-    }
-  };
-}
-export {
-  serveStatic as default
-};