@dnax/serve 0.0.0-stage → 0.0.1

package/README.md

@@ -1,3 +1,82 @@
-# Temporary Holding Version
+# @dnax/serve
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A zero-config static file server for [Bun](https://bun.com), with the same CLI
+syntax as [`http-server`](https://github.com/http-party/http-server).
+
+The package is published as `@dnax/serve` and installs the `dnx` command.
+
+## Usage
+
+```bash
+bun run src/cli.ts serve [path] [options]
+```
+
+Or install it globally and use the `dnx` binary:
+
+```bash
+bun add -g @dnax/serve      # or: npm install -g @dnax/serve
+dnx serve ./public -p 8080
+```
+
+For local development, link the package instead:
+
+```bash
+bun link          # from this directory
+dnx serve ./public -p 8080
+```
+
+`[path]` defaults to `./public` when that directory exists, otherwise `./`.
+The `serve` subcommand is optional, so `dnx [path] [options]` also works.
+
+```bash
+dnx serve ./dist -p 3000 -c-1          # no caching
+dnx serve . -p 0                       # first free port starting at 8080
+dnx serve . --cors -g -b               # CORS + precompressed .gz/.br
+dnx serve . --username admin --password secret
+dnx serve . -S -C cert.pem -K key.pem  # HTTPS
+dnx serve . -P http://localhost:3001   # proxy unresolved requests
+```
+
+Run `dnx serve --help` for the full option list. Flags mirror `http-server`,
+including `-p/-a/-d/-i/-g/-b/-e/-s/-o/-c/-t/-U/-T/-P/-S/-C/-K/-r/-H`,
+`--cors[=headers]`, `--coop`, `--private-network-access`, `--log-ip`,
+`--no-dotfiles`, `--hide-permissions`, `--mimetypes`, `--allowed-hosts`,
+`--base-dir`, `--dir-overrides-404` and `--proxy-all`.
+
+Magic files work as in `http-server`: `index.<ext>` is served for directories
+and `404.<ext>` is served for missing files.
+
+## Library
+
+```ts
+import { startStaticServer } from "@dnax/serve";
+
+const server = await startStaticServer({
+  root: "./public",
+  port: 3000,
+  cors: true,
+  gzip: true,
+});
+
+console.log(server.url);
+// server.stop();
+```
+
+`resolveOptions()` and `createRequestHandler()` are exported for use with your
+own `Bun.serve({ fetch })` configuration.
+
+## Publishing
+
+Scoped packages are private by default, so publish with public access:
+
+```bash
+npm publish --access public
+```
+
+## Development
+
+```bash
+bun install
+bun run typecheck
+bun run start
+```

package/index.ts

@@ -0,0 +1,8 @@
+export {
+  createRequestHandler,
+  resolveOptions,
+  startStaticServer,
+  type ResolvedServeOptions,
+  type ServeOptions,
+  type StaticServer,
+} from "./src/server.ts";

package/package.json

@@ -1,6 +1,27 @@
 {
   "name": "@dnax/serve",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "module": "index.ts",
+  "type": "module",
+  "private": false,
+  "bin": {
+    "dnx": "src/cli.ts"
+  },
+  "exports": {
+    ".": "./index.ts"
+  },
+  "files": [
+    "index.ts",
+    "src"
+  ],
+  "scripts": {
+    "start": "bun run src/cli.ts serve",
+    "typecheck": "bun check"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^7"
+  }
+}