feat: unix domain sockets and windows named pipe support

README.md

@@ -209,6 +209,10 @@ Option can be a function for Node.js `upgrade` handler (`(req, head) => void`) o
 
 When using dev server CLI, you can easily use `--ws` and a named export called `websocket` to define [CrossWS Hooks](https://github.com/unjs/crossws) with HMR support!
 
+### `ipc [name]`
+
+Enables IPC: Unix domain sockets are used on unixoid systems - instead of listening to network interfaces - and named pipes on windows (unix: `$PWD/listhen.sock`; windows: `\\?\pipe\listhen`). It's also possible to pass an absolute socket path and full pipe path.
+
 ## License
 
 <!-- automd:contributors license=MIT author="pi0" -->

src/_utils.ts

@@ -1,4 +1,4 @@
-import { networkInterfaces } from "node:os";
+import { networkInterfaces, platform } from "node:os";
 import { relative } from "pathe";
 import { colors } from "consola/utils";
 import { consola } from "consola";
@@ -88,6 +88,18 @@
   return preferPublic ? "" : "localhost";
 }
 
+export function getSocketPath(name: true | string) {
+  const _name = typeof name === "string" && name.length > 0 ? name : "listhen";
+  if (platform() === "win32") {
+    if (_name.startsWith("\\\\?\\pipe\\")) {
+      return _name;
+    }
+    return `\\\\?\\pipe\\${_name}`;
+  }
+
+  return _name === "listhen" ? "listhen.sock" : _name;
+}
+
 export function getPublicURL(
   listhenOptions: ListenOptions,
   baseURL?: string,

src/cli.ts

@@ -141,6 +141,11 @@
       description: "Open a tunnel using https://github.com/unjs/untun",
       required: false,
     },
+    socket: {
+      description:
+        "Listen on a Unix Domain Socket/Windows Pipe, optionally with custom name or given absolute path",
+      required: false,
+    },
   } as const satisfies ArgsDef;
 }
 
@@ -158,6 +163,7 @@
     publicURL: args.publicURL,
     public: args.public,
     tunnel: args.tunnel,
+    socket: args.socket as boolean | string | undefined,
     https: args.https
       ? <HTTPSOptions>{
           cert: args["https.cert"],

src/listen.ts

@@ -12,6 +12,7 @@
 import { renderUnicodeCompact as renderQRCode } from "uqr";
 import type { Tunnel } from "untun";
 import type { AdapterOptions as CrossWSOptions } from "crossws";
+import { isAbsolute, sep } from "pathe";
 import { open } from "./lib/open";
 import type {
   ListenOptions,
@@ -27,6 +28,7 @@
   isLocalhost,
   isAnyhost,
   getPublicURL,
+  getSocketPath,
   generateURL,
   getDefaultHost,
   validateHostname,
@@ -62,6 +64,7 @@
     isTest: _isTest,
     isProd: _isProd,
     public: _public,
+    socket: false,
     autoClose: true,
   });
 
@@ -110,22 +113,28 @@
 
   // --- Listen ---
   let server: Server | HTTPServer;
+
+  const serverOptions = listhenOptions.socket
+    ? { path: getSocketPath(listhenOptions.socket) }
+    : { port, host: listhenOptions.hostname };
+
   let https: Listener["https"] = false;
   const httpsOptions = listhenOptions.https as HTTPSOptions;
+
   let _addr: AddressInfo;
   if (httpsOptions) {
     https = await resolveCertificate(httpsOptions);
     server = createHTTPSServer(https, handle);
     addShutdown(server);
     // @ts-ignore
-    await promisify(server.listen.bind(server))(port, listhenOptions.hostname);
+    await promisify(server.listen.bind(server))(serverOptions);
     _addr = server.address() as AddressInfo;
     listhenOptions.port = _addr.port;
   } else {
     server = createServer(handle);
     addShutdown(server);
     // @ts-ignore
-    await promisify(server.listen.bind(server))(port, listhenOptions.hostname);
+    await promisify(server.listen.bind(server))(serverOptions);
     _addr = server.address() as AddressInfo;
     listhenOptions.port = _addr.port;
   }
@@ -150,7 +159,9 @@
 
   // --- GetURL Utility ---
   const getURL = (host = listhenOptions.hostname, baseURL?: string) =>
-    generateURL(host, listhenOptions, baseURL);
+    serverOptions.path
+      ? `unix+http${listhenOptions.https ? "s" : ""}://${serverOptions.path}`
+      : generateURL(host, listhenOptions, baseURL);
 
   // --- Start Tunnel ---
   let tunnel: Tunnel | undefined;
@@ -193,6 +204,17 @@
       }
     };
 
+    if (serverOptions.path) {
+      let _path = serverOptions.path;
+      const currentDirPath = `.${sep}`;
+
+      if (!(isAbsolute(_path) || _path.startsWith(currentDirPath))) {
+        _path = currentDirPath + _path;
+      }
+      _addURL("local", _path);
+      return urls;
+    }
+
     // Add public URL
     const publicURL =
       getURLOptions.publicURL ||
@@ -259,8 +281,12 @@
 
     for (const url of urls) {
       const type = typeMap[url.type];
+      let infix = "";
+      if (listhenOptions.socket && url.type === "local") {
+        infix = listhenOptions.https ? " (https)" : " (http)";
+      }
       const label = getColor(type[1])(
-        `  ➜ ${(type[0] + ":").padEnd(8, " ")}${nameSuffix} `,
+        `  ➜ ${(type[0] + infix + ":").padEnd(8, " ")}${nameSuffix} `,
       );
       let suffix = "";
       if (url === firstLocalUrl && listhenOptions.clipboard) {
@@ -272,7 +298,7 @@
       lines.push(`${label} ${formatURL(url.url)}${suffix}`);
     }
 
-    if (!firstPublicUrl) {
+    if (!firstPublicUrl && !listhenOptions.socket) {
       lines.push(
         colors.gray(`  ➜ Network:  use ${colors.white("--host")} to expose`),
       );

src/types.ts

@@ -67,6 +67,10 @@ export interface ListenOptions {
     | boolean
     | CrossWSOptions
     | ((req: IncomingMessage, head: Buffer) => void);
+  /**
+   * Listhen on a unix domain socket/windows pipe, optionally with custom name
+   */
+  socket: boolean | string;
 }
 
 export type GetURLOptions = Pick<