@t8/serve 0.1.37 → 0.1.39

package/README.md

@@ -2,7 +2,7 @@
 
 Simple static file server + bundler, primarily for demo apps and tests, manual or automated
 
-## Use cases
+Use cases:
 
 - Use the CLI-based server to launch a demo or test app with a single CLI command.
 - Use the code-based setup to launch an own server from multiple tests, each with its own app.
@@ -12,19 +12,29 @@ Simple static file server + bundler, primarily for demo apps and tests, manual o
 ```sh
 npx @t8/serve [url|port] [*] [app_dir] [...assets_dirs] [-b [bundle_input_path] [bundle_output_path] [bundle_output_dir]] [--watch] [--minify]
 # * = SPA mode: serve all unmatched paths as "/"
+```
+
+Examples:
 
+```sh
 npx @t8/serve 3000 app
-npx @t8/serve 3000 app -b
-npx @t8/serve 3000 * app
+# - serve files from './app' at 'localhost:3000'
+
 npx @t8/serve 3000 * app -b
-npx @t8/serve 3000 app public dist
-npx @t8/serve 127.0.0.1:3000 app public dist
-npx @t8/serve 3000 app public dist -b
-npx @t8/serve 3000 app public dist -b src/index.ts
+# - bundle './app/index.ts' to './app/dist/index.js' [-b]
+# - serve files from './app' at 'localhost:3000' in the SPA mode [*] (handling all unmatched paths as "/")
+
+npx @t8/serve 3000 * app -b src/index.ts
+# - bundle './app/src/index.ts' to './app/dist/index.js'
+# - serve files from './app' at 'localhost:3000' in the SPA mode
+
+npx @t8/serve 127.0.0.1:3000 app public dist -b
+# - bundle './app/index.ts' to './app/dist/index.js'
+# - serve files from './app/public' and './app/dist' at '127.0.0.1:3000'
 ```
 
 <details>
-<summary>Example 1 (flat)</summary>
+<summary>Example with Playwright #1 (flat)</summary>
 
 ```
 // package.json
@@ -47,7 +57,6 @@ npm run play
 ```
 
 ```
-// With Playwright:
 // playwright.config.ts
 ...
 use: {
@@ -62,7 +71,7 @@ webServer: {
 </details>
 
 <details>
-<summary>Example 2 (nested)</summary>
+<summary>Example with Playwright #2 (nested)</summary>
 
 ```
 // package.json
@@ -87,7 +96,6 @@ npm run play
 ```
 
 ```
-// With Playwright:
 // playwright.config.ts
 ...
 use: {
@@ -102,7 +110,7 @@ webServer: {
 </details>
 
 <details>
-<summary>Example 3 (index.html)</summary>
+<summary>Example with the watch mode</summary>
 
 ```
 /app
@@ -137,9 +145,10 @@ import { serve } from "@t8/serve";
 
 // Start
 let server = await serve({
-  port: 3000,
+  host: "localhost", // default
+  port: 3000, // default
   path: "app",
-  bundle: true, // or input path, or `{ input, output, dir }`
+  bundle: true, // or input path, or { input, output, dir }
   spa: true,
 });
 
@@ -148,7 +157,7 @@ server.close();
 ```
 
 <details>
-<summary>Example 1 (flat)</summary>
+<summary>Example with Playwright 1 (flat)</summary>
 
 ```
 /playground
@@ -182,7 +191,7 @@ test.afterAll(() => {
 </details>
 
 <details>
-<summary>Example 2 (nested)</summary>
+<summary>Example with Playwright 2 (nested)</summary>
 
 ```
 /tests/x
@@ -220,7 +229,7 @@ test.afterAll(() => {
 </details>
 
 <details>
-<summary>Example 3 (simple API)</summary>
+<summary>Example with an API mock</summary>
 
 ```ts
 import { serve } from "@t8/serve";

package/dist/index.cjs

@@ -0,0 +1,127 @@
+let node_fs = require("node:fs");
+let node_http = require("node:http");
+let node_path = require("node:path");
+let node_fs_promises = require("node:fs/promises");
+let esbuild = require("esbuild");
+
+async function bundle({ path = "", bundle: options, watch, minify } = {}) {
+  if (!options) return;
+  let normalizedOptions;
+  if (typeof options === "boolean") normalizedOptions = {};
+  else if (typeof options === "string") normalizedOptions = { input: options };
+  else normalizedOptions = options;
+  let dir = normalizedOptions.dir ?? "dist";
+  let inputFile = (0, node_path.join)(path, normalizedOptions.input ?? "index.ts");
+  await (0, node_fs_promises.rm)((0, node_path.join)(path, dir), {
+    recursive: true,
+    force: true
+  });
+  let buildOptions = {
+    entryPoints: [inputFile],
+    bundle: true,
+    format: "esm",
+    platform: "browser",
+    logLevel: "warning",
+    minify
+  };
+  if (normalizedOptions.output) buildOptions.outfile = (0, node_path.join)(path, dir, normalizedOptions.output);
+  else {
+    buildOptions.outdir = (0, node_path.join)(path, dir);
+    buildOptions.splitting = true;
+  }
+  if (watch) {
+    let ctx = await (0, esbuild.context)(buildOptions);
+    await ctx.watch();
+    return async () => {
+      await ctx.dispose();
+    };
+  }
+  await (0, esbuild.build)(buildOptions);
+}
+
+async function isValidFilePath(filePath, dirPath) {
+  if (!filePath.startsWith(dirPath)) return false;
+  try {
+    await (0, node_fs_promises.access)(filePath);
+    return !(await (0, node_fs_promises.lstat)(filePath)).isDirectory();
+  } catch {
+    return false;
+  }
+}
+
+const cwd = process.cwd();
+async function getFilePath(url = "", { path = "", dirs = [], spa }) {
+  let urlPath = url.replace(/[?#].*$/, "");
+  for (let dir of dirs.length === 0 ? [""] : dirs) {
+    let dirPath = (0, node_path.join)(cwd, path, dir);
+    let filePath = (0, node_path.join)(dirPath, urlPath);
+    if (!urlPath.endsWith("/") && await isValidFilePath(filePath, dirPath)) return filePath;
+    filePath = (0, node_path.join)(dirPath, spa ? "" : urlPath, "index.html");
+    if (await isValidFilePath(filePath, dirPath)) return filePath;
+  }
+}
+
+const defaultHost = "localhost";
+const defaultPort = 3e3;
+function getTarget(config = {}) {
+  let { host, port, url } = config;
+  let [, , urlHost, , urlPort] = url?.match(/^(https?:\/\/)?([^:/]+)(:(\d+))?\/?/) ?? [];
+  if (!urlPort && /^\d+$/.test(urlHost)) {
+    urlPort = urlHost;
+    urlHost = "";
+  }
+  return {
+    port: port || Number(urlPort) || defaultPort,
+    host: host || urlHost || defaultHost
+  };
+}
+
+const mimeTypes = {
+  html: "text/html; charset=utf-8",
+  js: "text/javascript",
+  json: "application/json",
+  css: "text/css",
+  svg: "image/svg+xml",
+  png: "image/png",
+  jpg: "image/jpeg",
+  gif: "image/gif",
+  ico: "image/x-icon",
+  txt: "text/plain",
+  md: "text/markdown"
+};
+
+/**
+* Starts a static server as configured by the `config` parameter and
+* returns the `Server` object.
+*
+* Bundles the code before starting the server, if configured with
+* `config.bundle` to do so.
+*/
+async function serve(config = {}) {
+  let stop = await bundle(config);
+  return new Promise((resolve) => {
+    let server = (0, node_http.createServer)(async (req, res) => {
+      await config.onRequest?.(req, res);
+      if (res.headersSent) return;
+      let filePath = await getFilePath(req.url, config);
+      if (filePath === void 0) {
+        res.writeHead(404, { "content-type": "text/plain" });
+        res.end("Not found");
+        return;
+      }
+      let mimeType = mimeTypes[(0, node_path.extname)(filePath).slice(1).toLowerCase()] ?? "application/octet-stream";
+      res.writeHead(200, { "content-type": mimeType });
+      (0, node_fs.createReadStream)(filePath).pipe(res);
+    });
+    if (stop) server.on("close", async () => {
+      await stop();
+    });
+    let { host, port } = getTarget(config);
+    server.listen(port, host, () => {
+      if (config.log) console.log(`Server running at http://${host}:${port}`);
+      resolve(server);
+    });
+  });
+}
+
+exports.serve = serve;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import type { IncomingMessage, ServerResponse, createServer } from "node:http";
+import { IncomingMessage, ServerResponse, createServer } from "node:http";
 
-export type BundleConfig = {
+type BundleConfig = {
   /**
    * Output directory path relative to the server config `path`.
    *
@@ -20,7 +20,8 @@ export type BundleConfig = {
    */
   output?: string | undefined;
 };
-export type Config = {
+
+type Config = {
   /** Server URL. */
   url?: string;
   /**
@@ -65,7 +66,15 @@ export type Config = {
   /** Custom request handler. */
   onRequest?: (req?: IncomingMessage, res?: ServerResponse<IncomingMessage>) => void | Promise<void>;
 };
-export type Server = ReturnType<typeof createServer>;
-export declare function serve(config?: Config): Promise<Server>;
 
-export {};
+type Server = ReturnType<typeof createServer>;
+/**
+ * Starts a static server as configured by the `config` parameter and
+ * returns the `Server` object.
+ *
+ * Bundles the code before starting the server, if configured with
+ * `config.bundle` to do so.
+ */
+declare function serve(config?: Config): Promise<Server>;
+
+export { BundleConfig, Config, Server, serve };

package/dist/{index.js → index.mjs}

@@ -1,29 +1,21 @@
-// src/serve.ts
 import { createReadStream } from "node:fs";
 import { createServer } from "node:http";
-import { extname } from "node:path";
-
-// src/bundle.ts
-import { rm } from "node:fs/promises";
-import { join } from "node:path";
+import { extname, join } from "node:path";
+import { access, lstat, rm } from "node:fs/promises";
 import { build, context } from "esbuild";
-async function bundle({
-  path = "",
-  bundle: options,
-  watch,
-  minify
-} = {}) {
+
+async function bundle({ path = "", bundle: options, watch, minify } = {}) {
   if (!options) return;
   let normalizedOptions;
   if (typeof options === "boolean") normalizedOptions = {};
-  else if (typeof options === "string")
-    normalizedOptions = {
-      input: options
-    };
+  else if (typeof options === "string") normalizedOptions = { input: options };
   else normalizedOptions = options;
   let dir = normalizedOptions.dir ?? "dist";
   let inputFile = join(path, normalizedOptions.input ?? "index.ts");
-  await rm(join(path, dir), { recursive: true, force: true });
+  await rm(join(path, dir), {
+    recursive: true,
+    force: true
+  });
   let buildOptions = {
     entryPoints: [inputFile],
     bundle: true,
@@ -32,8 +24,7 @@ async function bundle({
     logLevel: "warning",
     minify
   };
-  if (normalizedOptions.output)
-    buildOptions.outfile = join(path, dir, normalizedOptions.output);
+  if (normalizedOptions.output) buildOptions.outfile = join(path, dir, normalizedOptions.output);
   else {
     buildOptions.outdir = join(path, dir);
     buildOptions.splitting = true;
@@ -48,11 +39,6 @@ async function bundle({
   await build(buildOptions);
 }
 
-// src/getFilePath.ts
-import { join as join2 } from "node:path";
-
-// src/isValidFilePath.ts
-import { access, lstat } from "node:fs/promises";
 async function isValidFilePath(filePath, dirPath) {
   if (!filePath.startsWith(dirPath)) return false;
   try {
@@ -63,23 +49,20 @@ async function isValidFilePath(filePath, dirPath) {
   }
 }
 
-// src/getFilePath.ts
-var cwd = process.cwd();
+const cwd = process.cwd();
 async function getFilePath(url = "", { path = "", dirs = [], spa }) {
   let urlPath = url.replace(/[?#].*$/, "");
   for (let dir of dirs.length === 0 ? [""] : dirs) {
-    let dirPath = join2(cwd, path, dir);
-    let filePath = join2(dirPath, urlPath);
-    if (!urlPath.endsWith("/") && await isValidFilePath(filePath, dirPath))
-      return filePath;
-    filePath = join2(dirPath, spa ? "" : urlPath, "index.html");
+    let dirPath = join(cwd, path, dir);
+    let filePath = join(dirPath, urlPath);
+    if (!urlPath.endsWith("/") && await isValidFilePath(filePath, dirPath)) return filePath;
+    filePath = join(dirPath, spa ? "" : urlPath, "index.html");
     if (await isValidFilePath(filePath, dirPath)) return filePath;
   }
 }
 
-// src/getTarget.ts
-var defaultHost = "localhost";
-var defaultPort = 3e3;
+const defaultHost = "localhost";
+const defaultPort = 3e3;
 function getTarget(config = {}) {
   let { host, port, url } = config;
   let [, , urlHost, , urlPort] = url?.match(/^(https?:\/\/)?([^:/]+)(:(\d+))?\/?/) ?? [];
@@ -93,8 +76,7 @@ function getTarget(config = {}) {
   };
 }
 
-// src/mimeTypes.ts
-var mimeTypes = {
+const mimeTypes = {
   html: "text/html; charset=utf-8",
   js: "text/javascript",
   json: "application/json",
@@ -108,7 +90,13 @@ var mimeTypes = {
   md: "text/markdown"
 };
 
-// src/serve.ts
+/**
+* Starts a static server as configured by the `config` parameter and
+* returns the `Server` object.
+*
+* Bundles the code before starting the server, if configured with
+* `config.bundle` to do so.
+*/
 async function serve(config = {}) {
   let stop = await bundle(config);
   return new Promise((resolve) => {
@@ -121,16 +109,13 @@ async function serve(config = {}) {
         res.end("Not found");
         return;
       }
-      let ext = extname(filePath).slice(1).toLowerCase();
-      let mimeType = mimeTypes[ext] ?? "application/octet-stream";
+      let mimeType = mimeTypes[extname(filePath).slice(1).toLowerCase()] ?? "application/octet-stream";
       res.writeHead(200, { "content-type": mimeType });
       createReadStream(filePath).pipe(res);
     });
-    if (stop) {
-      server.on("close", async () => {
-        await stop();
-      });
-    }
+    if (stop) server.on("close", async () => {
+      await stop();
+    });
     let { host, port } = getTarget(config);
     server.listen(port, host, () => {
       if (config.log) console.log(`Server running at http://${host}:${port}`);
@@ -138,6 +123,5 @@ async function serve(config = {}) {
     });
   });
 }
-export {
-  serve
-};
+
+export { serve };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t8/serve",
-  "version": "0.1.37",
+  "version": "0.1.39",
   "description": "Simple static file server + bundler, primarily for demo apps and tests, manual or automated",
   "keywords": [
     "node",
@@ -9,7 +9,7 @@
     "bundler"
   ],
   "bin": {
-    "serve": "dist/run.js"
+    "serve": "./dist/run.mjs"
   },
   "repository": {
     "type": "git",
@@ -18,14 +18,13 @@
   "license": "MIT",
   "author": "axtk",
   "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "scripts": {
-    "clean": "node -e \"require('node:fs').rmSync('dist', { force: true, recursive: true });\"",
-    "compile": "npx esbuild index.ts --bundle --outdir=dist --platform=node --format=esm --external:esbuild",
-    "compile-bin": "npx esbuild src/run.ts --bundle --outfile=dist/run.js --platform=node --format=esm --external:esbuild",
-    "preversion": "npx npm-run-all clean shape -p compile compile-bin",
-    "shape": "npx codeshape --typecheck --emit-types"
+    "compile-bin": "npx esbuild src/run.ts --bundle --outfile=dist/run.mjs --platform=node --format=esm --external:esbuild",
+    "preversion": "npx npm-run-all shape compile-bin",
+    "shape": "npx codeshape"
   },
   "devDependencies": {
     "@types/node": "^24.5.2"

package/src/serve.ts

@@ -9,6 +9,13 @@ import { mimeTypes } from "./mimeTypes.ts";
 
 export type Server = ReturnType<typeof createServer>;
 
+/**
+ * Starts a static server as configured by the `config` parameter and
+ * returns the `Server` object.
+ *
+ * Bundles the code before starting the server, if configured with
+ * `config.bundle` to do so.
+ */
 export async function serve(config: Config = {}): Promise<Server> {
   let stop = await bundle(config);
 

package/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "include": ["index.ts", "src"],
+  "include": ["./index.ts", "./src"],
   "compilerOptions": {
     "declaration": true,
     "emitDeclarationOnly": true,