sable 0.5.16 → 0.5.18

package/README.md

@@ -3,7 +3,17 @@
 [![test](https://github.com/kei-ito/sable/actions/workflows/test.yml/badge.svg)](https://github.com/kei-ito/sable/actions/workflows/test.yml)
 [![codecov](https://codecov.io/gh/kei-ito/sable/branch/master/graph/badge.svg)](https://codecov.io/gh/kei-ito/sable)
 
-Starts a server for development.
+An HTTP development server that serves static files and reloads the browser when files change. If the configured port is already in use, sable automatically tries the next one, so multiple projects can run side by side without any configuration changes.
+
+## Quick start
+
+No installation required. Run the following command to serve the current directory:
+
+```
+npx sable .
+```
+
+The server URL is printed to stdout once it is ready. Edit any file in the directory and the browser reloads automatically.
 
 ## Install
 
@@ -15,17 +25,19 @@ npm install sable --save-dev
 
 ```
 $ sable -h
-Usage: sable [options] <documentRoot ...>
+Usage: sable [options] [documentRoot...]
 
-Starts a HTTP server for development
+Starts an HTTP development server
 
 Options:
-  -V, --version    output the version number
-  -p, --port <n>   A port number for HTTP, HTTPS (4000)
-  -h, --host <s>   Hostname
-  --noWatch        Disable watching
-  -i, --index <s>  A filename of index (index.html)
-  -h, --help       output usage information
+  -V, --version    Output the version number
+  -p, --port <n>   Port number for HTTP/HTTPS (default: 4000)
+  -h, --host <s>   Host name to bind
+  -v, --verbose    Enable verbose logging
+  --noWatch        Set the watch option to false
+  -i, --index <s>  Value for the index option (default: index.html)
+  [documentRoot...] Directories that contain files to be served
+  -h, --help       Output usage information
 ```
 
 ## Javascript API
@@ -38,11 +50,11 @@ startServer({/* options */})
 
 ### Options
 
-`startServer` supports all of the options provided by [middleware-static-livereload]
-, `port`, `host` and `middlewares`.
+`startServer` supports all options from [middleware-static-livereload], plus
+`port`, `host`, and `middlewares`.
 
 ```javascript
-interface SableOptions extends MiddlewareStaticLivereload.Options {
+interface SableOptions extends Partial<MiddlewareOptions> {
     /**
      * The first argument of server.listen()
      * https://nodejs.org/api/net.html#net_server_listen_port_host_backlog_callback

package/cjs/cli.cjs

@@ -74,11 +74,11 @@ if (!packageJsonPath) {
   throw new Error("Unable to resolve path to package.json");
 }
 var { version } = JSON.parse((0, import_node_fs.readFileSync)(packageJsonPath, "utf8"));
-var program = new import_commander.Command().version(version).description("Starts a HTTP server for development").option(
+var program = new import_commander.Command().version(version).description("Starts an HTTP development server").option(
   "-p, --port <n>",
-  "A port number for HTTP, HTTPS (4000)",
+  "Port number for HTTP/HTTPS (default: 4000)",
   Number.parseInt
-).option("-h, --host <s>", "Hostname").option("-v, --verbose", "Enable verbose logging").option("--noWatch", "Disable watching").option("-i, --index <s>", "A filename of index (index.html)").argument("[documentRoot...]", "Paths to serve");
+).option("-h, --host <s>", "Host name to bind").option("-v, --verbose", "Enable verbose logging").option("--noWatch", "Set the watch option to false").option("-i, --index <s>", "Value for the index option (default: index.html)").argument("[documentRoot...]", "Directories that contain files to be served");
 program.parse();
 var {
   noWatch,

package/esm/cli.mjs

@@ -50,11 +50,11 @@ if (!packageJsonPath) {
   throw new Error("Unable to resolve path to package.json");
 }
 var { version } = JSON.parse(readFileSync(packageJsonPath, "utf8"));
-var program = new Command().version(version).description("Starts a HTTP server for development").option(
+var program = new Command().version(version).description("Starts an HTTP development server").option(
   "-p, --port <n>",
-  "A port number for HTTP, HTTPS (4000)",
+  "Port number for HTTP/HTTPS (default: 4000)",
   Number.parseInt
-).option("-h, --host <s>", "Hostname").option("-v, --verbose", "Enable verbose logging").option("--noWatch", "Disable watching").option("-i, --index <s>", "A filename of index (index.html)").argument("[documentRoot...]", "Paths to serve");
+).option("-h, --host <s>", "Host name to bind").option("-v, --verbose", "Enable verbose logging").option("--noWatch", "Set the watch option to false").option("-i, --index <s>", "Value for the index option (default: index.html)").argument("[documentRoot...]", "Directories that contain files to be served");
 program.parse();
 var {
   noWatch,

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "sable",
-    "version": "0.5.16",
-    "description": "Starts a server and a file watcher",
+    "version": "0.5.18",
+    "description": "HTTP development server with file watching",
     "author": {
         "name": "Kei Ito",
         "email": "kei.itof@gmail.com",
@@ -30,18 +30,19 @@
         "types"
     ],
     "scripts": {
-        "lint": "npx @biomejs/biome lint",
+        "lint": "npx @biomejs/biome check",
+        "format": "npx @biomejs/biome format --write",
         "build": "run-s build:*",
         "build:typedef": "tsc --project tsconfig.typedef.json",
         "build:code": "node build.ts",
         "test": "node --test test/index.mjs",
-        "version": "run-s version:changelog version:add",
+        "version": "run-s version:changelog format version:add",
         "version:changelog": "npx @nlib/changelog --output CHANGELOG.md",
         "version:add": "git add ."
     },
     "dependencies": {
-        "commander": "14.0.1",
+        "commander": "14.0.2",
         "connect": "3.7.0",
-        "middleware-static-livereload": "1.4.3"
+        "middleware-static-livereload": "1.5.2"
     }
 }

package/types/index.d.ts

@@ -1,7 +1,11 @@
 import * as http from "node:http";
-import { type HandleFunction } from "connect";
 import * as staticLivereload from "middleware-static-livereload";
 export { LogLevel } from "middleware-static-livereload";
+type NextFunction = (err?: unknown) => void;
+export type SimpleHandleFunction = (req: http.IncomingMessage, res: http.ServerResponse) => void;
+export type NextHandleFunction = (req: http.IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
+export type ErrorHandleFunction = (err: unknown, req: http.IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
+export type HandleFunction = SimpleHandleFunction | NextHandleFunction | ErrorHandleFunction;
 export interface SableOptions extends Partial<staticLivereload.MiddlewareOptions> {
     port?: number;
     host?: string;