feat: add directoryCallback option

Author: brettz9

CHANGES.md

@@ -34,6 +34,7 @@
 - Fix: ensure `--default-extension` and `--server-info` are settable by CLI
 - Fix: change `fs.createReadStream()` mode to integer (@pixcai)
 - Enhancement: TypeScript support
+- Enhancement: Add `directoryCallback` option
 - Enhancement: Allow access with local ip (@flyingsky)
 - Enhancement: Allow `serverInfo` to be `null` (@martindale)
 - Enhancement: Time display logging with leading 0 (@mauris)

README.md

@@ -152,6 +152,21 @@ const server = http.createServer((req, res) => {
 }).listen(9010);
 ```
 
+### Serving custom directory
+
+```js
+fileServer = new statik.Server(__dirname + '/../fixtures', {
+    directoryCallback (pathname, req, res) {
+        res.writeHead(200, {
+            'Content-Type': 'text/html'
+        });
+        res.end(`Hi <b>${basename(pathname)}</b>!`);
+
+        // You could add a listing of files by `readdir` here
+    }
+});
+```
+
 ### Intercepting errors & Listening
 
 An optional callback can be passed as last argument, it will be called every

lib/node-static.js

@@ -59,6 +59,13 @@ function tryStat(p, callback) {
 /**
  * @typedef {{
  *   indexFile?: string,
+ *   directoryCallback?: (
+ *     pathname: string,
+ *     req: http.IncomingMessage,
+ *     res: http.ServerResponse<http.IncomingMessage> & {
+ *       req: http.IncomingMessage;
+ *     }
+ *   ) => void,
  *   gzip?: boolean|RegExp,
  *   headers?: http.OutgoingHttpHeaders,
  *   serverInfo?: string|null,
@@ -138,6 +145,11 @@ class Server extends events.EventEmitter {
      * @param {(status: number, headers: http.OutgoingHttpHeaders) => void} finish
      */
     serveDir (pathname, req, res, finish) {
+        if (this.options.directoryCallback) {
+            this.options.directoryCallback(pathname, req, res);
+            return;
+        }
+
         const htmlIndex = path.join(pathname, this.options.indexFile);
 
         tryStat(htmlIndex, (e, stat) => {

test/integration/node-static-test.js

@@ -1,4 +1,5 @@
 import http from 'http';
+import {basename} from 'path';
 
 import {assert} from 'chai';
 import fetch from 'node-fetch';
@@ -725,13 +726,38 @@ describe('node-static', function () {
             this.server.close();
         });
 
-        it('returns 200 with missing JSON file', async function () {
+        it('returns 200 with multiple JSON files config', async function () {
             const response = await fetch(this.getTestServer() + '/');
             assert.equal(response.status, 200, 'should respond with 200');
             assert.equal(await response.text(), 'Hi\nhello world', 'should respond with Hi\nhello world');
         });
     });
 
+    describe('once an http server is listening with directoryCallback', function () {
+        before(function () {
+            fileServer = new statik.Server(__dirname + '/../fixtures', {
+                directoryCallback (pathname, req, res) {
+                    res.writeHead(200, {
+                        'Content-Type': 'text/html'
+                    });
+                    res.end(`Hi ${basename(pathname)}!`);
+                }
+            });
+        });
+        beforeEach(async function () {
+            await setupStaticServer(this);
+        });
+        afterEach(async function () {
+            this.server.close();
+        });
+
+        it('returns 200 with directoryCallback', async function () {
+            const response = await fetch(this.getTestServer() + '/there');
+            assert.equal(response.status, 200, 'should respond with 200');
+            assert.equal(await response.text(), 'Hi there!', 'should respond with Hi there!');
+        });
+    });
+
     describe('once an http server is listening with bad JSON files configuration', function () {
         before(function () {
             fileServer = new statik.Server(__dirname + '/../fixtures/index-with-bad-json');