mvp

Author: DanielJDufour

README.md

@@ -1,2 +1,67 @@
 # srvd
 Another Development Server.  Supports Range Requests.  Configure through Environmental Variables.
+
+# basic usage
+```bash
+srvd
+```
+
+# install
+```bash
+npm install -D srvd
+```
+
+# advanced usage
+## in JavaScript
+```javascript
+const srvd = require("srvd");
+
+// note: all options are optional
+const obj = srvd.serve({
+  // whether to accept HTTP Range Requests to return partial files
+  // default is true
+  acceptRanges: true,
+
+  // set debug to true to see increased logging messages like what port is being used
+  // default is false
+  debug: true,
+
+  // port
+  // default is 8088
+  port: 3000,
+
+  // root directory to serve files from
+  // default is the common working directory
+  root: "/tmp/test"
+});
+```
+serve returns the following object:
+```js
+{
+  // whether byte range requests are being served
+  acceptRanges: true,
+
+  // whether debug logging is on/off
+  debug: true,
+
+  // port server is running on 
+  port: 3000,
+
+  // root being used
+  root: "/tmp/test",
+
+  // the http server object being used
+  server: Server
+}
+```
+
+# in the terminal
+You can just run `srvd`, but you have other options available:
+```bash
+srvd --accept-ranges=false --debug --port=8080 --root=$PWD/data
+```
+
+# even more advanced usage
+## shutting the server down
+If you want to shut the server down (but not kill the main NodeJS process),
+you can run `server.close()` or setting the environmental variable `SRVD_PLZ_CLOSE` to `true` like `process.env.SRVD_PLZ_CLOSE=true`;

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "srvd",
+  "version": "0.0.0",
+  "description": "Another Development Server.  Supports Range Requests.  Configure through Environmental Variables.",
+  "main": "srvd.js",
+  "files": [
+    "srvd.js"
+  ],
+  "scripts": {
+    "test": "node test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DanielJDufour/srvd.git"
+  },
+  "keywords": [
+    "async",
+    "byte",
+    "config",
+    "data",
+    "dev",
+    "env",
+    "http",
+    "range",
+    "requests",
+    "server",
+    "static"
+  ],
+  "author": "Daniel J. Dufour",
+  "license": "CC0-1.0",
+  "bugs": {
+    "url": "https://github.com/DanielJDufour/srvd/issues"
+  },
+  "homepage": "https://github.com/DanielJDufour/srvd#readme"
+}

srvd.js

@@ -0,0 +1,51 @@
+const serveStatic = require("serve-static");
+const http = require("http");
+const finalhandler = require("finalhandler");
+
+const DEFAULT_PORT = 8080;
+
+function serve ({ acceptRanges = true, debug = false, root, port } = { acceptRanges: true }) {
+  if (!root) {
+    root = process.cwd();
+    if (debug) console.log(`[srvd] root not set so using current working directory "${root}"`);
+  }
+
+
+
+  if (!port) port = process.env.SRVD_DEFAULT_PORT ? process.env.SRVD_DEFAULT_PORT : DEFAULT_PORT;
+  port = parseInt(port);
+
+  const serve = serveStatic(root, {
+    acceptRanges
+  });
+
+  const server = http.createServer(function onRequest(req, res) {
+    serve(req, res, finalhandler(req, res));
+  });
+
+  server.listen(port);
+  if (debug) console.log("[srvd] serving on port " + port);
+
+  function checkForCloseRequest() {
+    if (["TRUE","True","true"].includes(process.env.SRVD_PLZ_CLOSE)) {
+      server.close();
+    } else {
+      setTimeout(() => checkForCloseRequest(), 500);
+    }
+  }
+  setTimeout(() => checkForCloseRequest(), 500);
+
+  return { acceptRanges, debug, server, port, root };
+};
+
+module.exports = { serve };
+
+if (require.main === module) {
+  const args = Array.from(process.argv);
+  const str = args.join(" ");
+  serve({
+    debug: !!str.match(/-?-debug((=|== )(true|True|TRUE))?/),
+    port: str.match(/-?-port(?:=|== )(\d+)/)?.[1],
+    root: str.match(/-?-root(?:=|== )([^ ]+)/)?.[1]
+  });
+}

test.js

@@ -0,0 +1,12 @@
+const test = require("flug");
+const srvd = require("./srvd");
+
+test("shutting down via callback", ({ eq }) => {
+  const { server } = srvd.serve();
+  server.close();
+});
+
+test("shutting down via env", ({ eq }) => {
+  srvd.serve();
+  process.env.SRVD_PLZ_CLOSE = true;
+});