@t8/serve 0.1.14 → 0.1.16

package/README.md

@@ -1,6 +1,12 @@
+# @t8/serve
+
+Simple static file server + bundler, primarily for tests, manual or automated
+
+## CLI
+
 ```sh
 npx @t8/serve [url|port] [*] [app_dir] [...assets_dirs] [-b [bundle_input_path] [bundle_output_path]]
-# * = SPA mode: serve all paths as "/"
+# * = SPA mode: serve all unmatched paths as "/"
 
 npx @t8/serve 3000 app
 npx @t8/serve 3000 app -b
@@ -11,3 +17,89 @@ 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
 ```
+
+<details>
+<summary>Example</summary>
+
+```
+// package.json
+"scripts": {
+  "play": "npx @t8/serve 3000 * playground -b"
+}
+```
+
+```
+/playground
+  - index.css
+  - index.html
+     + <script src="/dist/index.js"></script>
+  - index.ts
+```
+
+```sh
+npm run play
+```
+
+```
+// playwright.config.ts
+...
+use: {
+  baseURL: "http://localhost:3000",
+},
+webServer: {
+  command: "npm run play",
+  url: "http://localhost:3000",
+},
+```
+
+</details>
+
+## Code
+
+```ts
+import { serve } from "@t8/serve";
+
+// Start
+let server = await serve({
+  port: 3000,
+  path: "app",
+  spa: true,
+  bundle: true,
+});
+
+// Stop
+server.close();
+```
+
+<details>
+<summary>Example</summary>
+
+```
+/playground
+  - index.css
+  - index.html
+     + <script src="/dist/index.js"></script>
+  - index.ts
+```
+
+```ts
+// x.test.ts
+import { test } from "@playwright/test";
+import { serve, type Server } from "@t8/serve";
+
+let server: Server;
+
+test.beforeAll(async () => {
+  server = await serve({
+    path: "playground",
+    spa: true,
+    bundle: true,
+  });
+});
+
+test.afterAll(() => {
+  server.close();
+});
+```
+
+</details>

package/dist/index.js

@@ -49,6 +49,22 @@ async function getFilePath(url = "", { path = "", dirs = [], spa }) {
   }
 }
 
+// src/getTarget.ts
+var defaultHost = "localhost";
+var 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
+  };
+}
+
 // src/mimeTypes.ts
 var mimeTypes = {
   html: "text/html; charset=utf-8",
@@ -65,14 +81,7 @@ var mimeTypes = {
 };
 
 // src/serve.ts
-var defaultHost = "localhost";
-var defaultPort = 3e3;
 async function serve(config = {}) {
-  let [, , host, , port] = config.url?.match(/^(https?:\/\/)?([^:/]+)(:(\d+))?\/?/) ?? [];
-  if (!port && /^\d+$/.test(host)) {
-    port = host;
-    host = defaultHost;
-  }
   await bundle(config);
   return new Promise((resolve) => {
     let server = createServer(async (req, res) => {
@@ -87,11 +96,9 @@ async function serve(config = {}) {
       res.writeHead(200, { "content-type": mimeType });
       createReadStream(filePath).pipe(res);
     });
-    let serverPort = Number(port) || defaultPort;
-    let serverHost = host || defaultHost;
-    server.listen(serverPort, serverHost, () => {
-      if (!config.silent)
-        console.log(`Server running at http://${serverHost}:${serverPort}`);
+    let { host, port } = getTarget(config);
+    server.listen(port, host, () => {
+      if (config.log) console.log(`Server running at http://${host}:${port}`);
       resolve(server);
     });
   });

package/dist/run.cjs

@@ -52,6 +52,22 @@ async function getFilePath(url = "", { path = "", dirs = [], spa }) {
   }
 }
 
+// src/getTarget.ts
+var defaultHost = "localhost";
+var 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
+  };
+}
+
 // src/mimeTypes.ts
 var mimeTypes = {
   html: "text/html; charset=utf-8",
@@ -68,14 +84,7 @@ var mimeTypes = {
 };
 
 // src/serve.ts
-var defaultHost = "localhost";
-var defaultPort = 3e3;
 async function serve(config = {}) {
-  let [, , host, , port] = config.url?.match(/^(https?:\/\/)?([^:/]+)(:(\d+))?\/?/) ?? [];
-  if (!port && /^\d+$/.test(host)) {
-    port = host;
-    host = defaultHost;
-  }
   await bundle(config);
   return new Promise((resolve) => {
     let server = (0, import_node_http.createServer)(async (req, res) => {
@@ -90,11 +99,9 @@ async function serve(config = {}) {
       res.writeHead(200, { "content-type": mimeType });
       (0, import_node_fs.createReadStream)(filePath).pipe(res);
     });
-    let serverPort = Number(port) || defaultPort;
-    let serverHost = host || defaultHost;
-    server.listen(serverPort, serverHost, () => {
-      if (!config.silent)
-        console.log(`Server running at http://${serverHost}:${serverPort}`);
+    let { host, port } = getTarget(config);
+    server.listen(port, host, () => {
+      if (config.log) console.log(`Server running at http://${host}:${port}`);
       resolve(server);
     });
   });
@@ -125,7 +132,8 @@ async function run() {
     path,
     dirs,
     spa,
-    bundle: bundle2
+    bundle: bundle2,
+    log: true
   });
 }
 run();

package/dist/run.mjs

@@ -51,6 +51,22 @@ async function getFilePath(url = "", { path = "", dirs = [], spa }) {
   }
 }
 
+// src/getTarget.ts
+var defaultHost = "localhost";
+var 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
+  };
+}
+
 // src/mimeTypes.ts
 var mimeTypes = {
   html: "text/html; charset=utf-8",
@@ -67,14 +83,7 @@ var mimeTypes = {
 };
 
 // src/serve.ts
-var defaultHost = "localhost";
-var defaultPort = 3e3;
 async function serve(config = {}) {
-  let [, , host, , port] = config.url?.match(/^(https?:\/\/)?([^:/]+)(:(\d+))?\/?/) ?? [];
-  if (!port && /^\d+$/.test(host)) {
-    port = host;
-    host = defaultHost;
-  }
   await bundle(config);
   return new Promise((resolve) => {
     let server = createServer(async (req, res) => {
@@ -89,11 +98,9 @@ async function serve(config = {}) {
       res.writeHead(200, { "content-type": mimeType });
       createReadStream(filePath).pipe(res);
     });
-    let serverPort = Number(port) || defaultPort;
-    let serverHost = host || defaultHost;
-    server.listen(serverPort, serverHost, () => {
-      if (!config.silent)
-        console.log(`Server running at http://${serverHost}:${serverPort}`);
+    let { host, port } = getTarget(config);
+    server.listen(port, host, () => {
+      if (config.log) console.log(`Server running at http://${host}:${port}`);
       resolve(server);
     });
   });
@@ -124,7 +131,8 @@ async function run() {
     path,
     dirs,
     spa,
-    bundle: bundle2
+    bundle: bundle2,
+    log: true
   });
 }
 run();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t8/serve",
-  "version": "0.1.14",
+  "version": "0.1.16",
   "description": "",
   "keywords": [
     "node",

package/src/Config.ts

@@ -2,9 +2,11 @@ import type { BundleConfig } from "./BundleConfig";
 
 export type Config = {
   url?: string;
+  host?: string;
+  port?: number;
   path?: string;
   dirs?: string[];
   spa?: boolean;
-  silent?: boolean;
+  log?: boolean;
   bundle?: boolean | BundleConfig;
 };

package/src/getTarget.ts

@@ -0,0 +1,21 @@
+import type { Config } from "./Config";
+
+const defaultHost = "localhost";
+const defaultPort = 3000;
+
+export function getTarget(config: 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,
+  };
+}

package/src/run.ts

@@ -32,6 +32,7 @@ async function run() {
     dirs,
     spa,
     bundle,
+    log: true,
   });
 }
 

package/src/serve.ts

@@ -4,22 +4,12 @@ import { extname } from "node:path";
 import { bundle } from "./bundle";
 import type { Config } from "./Config";
 import { getFilePath } from "./getFilePath";
+import { getTarget } from "./getTarget";
 import { mimeTypes } from "./mimeTypes";
 
-const defaultHost = "localhost";
-const defaultPort = 3000;
-
 export type Server = ReturnType<typeof createServer>;
 
 export async function serve(config: Config = {}): Promise<Server> {
-  let [, , host, , port] =
-    config.url?.match(/^(https?:\/\/)?([^:/]+)(:(\d+))?\/?/) ?? [];
-
-  if (!port && /^\d+$/.test(host)) {
-    port = host;
-    host = defaultHost;
-  }
-
   await bundle(config);
 
   return new Promise((resolve) => {
@@ -39,12 +29,10 @@ export async function serve(config: Config = {}): Promise<Server> {
       createReadStream(filePath).pipe(res);
     });
 
-    let serverPort = Number(port) || defaultPort;
-    let serverHost = host || defaultHost;
+    let { host, port } = getTarget(config);
 
-    server.listen(serverPort, serverHost, () => {
-      if (!config.silent)
-        console.log(`Server running at http://${serverHost}:${serverPort}`);
+    server.listen(port, host, () => {
+      if (config.log) console.log(`Server running at http://${host}:${port}`);
 
       resolve(server);
     });