feat: add option "serveIndex" to enable/disable serveIndex middleware (#1752)

Author: EslamHiko

Diff for: bin/options.js

@@ -21,6 +21,11 @@ const options = {
     type: 'boolean',
     describe: 'Lazy',
   },
+  serveIndex: {
+    type: 'boolean',
+    describe: 'Enables/Disables serveIndex middleware',
+    default: true,
+  },
   inline: {
     type: 'boolean',
     default: true,

Diff for: lib/Server.js

@@ -106,6 +106,8 @@ class Server {
     this.headers = options.headers;
     this.progress = options.progress;
 
+    this.serveIndex = options.serveIndex;
+
     this.clientOverlay = options.overlay;
     this.clientLogLevel = options.clientLogLevel;
 
@@ -557,9 +559,15 @@ class Server {
 
     defaultFeatures.push('magicHtml');
 
-    if (contentBase !== false) {
+    // checking if it's set to true or not set (Default : undefined => true)
+    this.serveIndex = this.serveIndex || this.serveIndex === undefined;
+
+    const shouldHandleServeIndex = contentBase && this.serveIndex;
+
+    if (shouldHandleServeIndex) {
       defaultFeatures.push('contentBaseIndex');
     }
+
     // compress is placed last and uses unshift so that it will be the first middleware used
     if (options.compress) {
       defaultFeatures.unshift('compress');

Diff for: lib/options.json

@@ -1,6 +1,9 @@
 {
   "type": "object",
   "properties": {
+    "serveIndex": {
+      "type": "boolean"
+    },
     "hot": {
       "type": "boolean"
     },

Diff for: test/ContentBase.test.js

@@ -64,7 +64,89 @@ describe('ContentBase', () => {
       }, 1000);
     });
   });
+  describe('test listing files in folders without index.html using the option serveIndex:false', () => {
+    beforeAll((done) => {
+      server = helper.start(
+        config,
+        {
+          contentBase: contentBasePublic,
+          watchContentBase: true,
+          serveIndex: false,
+        },
+        done
+      );
+      req = request(server.app);
+    });
+
+    afterAll((done) => {
+      helper.close(() => {
+        done();
+      });
+    });
+
+    it("shouldn't list the files inside the assets folder (404)", (done) => {
+      req.get('/assets/').expect(404, done);
+    });
+
+    it('should show Heyo. because bar has index.html inside it (200)', (done) => {
+      req.get('/bar/').expect(200, /Heyo/, done);
+    });
+  });
+  describe('test listing files in folders without index.html using the option serveIndex:true', () => {
+    beforeAll((done) => {
+      server = helper.start(
+        config,
+        {
+          contentBase: contentBasePublic,
+          watchContentBase: true,
+          serveIndex: true,
+        },
+        done
+      );
+      req = request(server.app);
+    });
 
+    afterAll((done) => {
+      helper.close(() => {
+        done();
+      });
+    });
+
+    it('should list the files inside the assets folder (200)', (done) => {
+      req.get('/assets/').expect(200, done);
+    });
+
+    it('should show Heyo. because bar has index.html inside it (200)', (done) => {
+      req.get('/bar/').expect(200, /Heyo/, done);
+    });
+  });
+  describe('test listing files in folders without index.html using the option serveIndex default (true)', () => {
+    beforeAll((done) => {
+      server = helper.start(
+        config,
+        {
+          contentBase: contentBasePublic,
+          watchContentBase: true,
+        },
+        done
+      );
+      req = request(server.app);
+    });
+
+    afterAll((done) => {
+      helper.close(() => {
+        done();
+      });
+    });
+
+    it('should list the files inside the assets folder (200)', (done) => {
+      req.get('/assets/').expect(200, done);
+    });
+
+    it('should show Heyo. because bar has index.html inside it (200)', (done) => {
+      req.get('/bar/').expect(200, /Heyo/, done);
+    });
+  });
   describe('to directories', () => {
     beforeAll((done) => {
       server = helper.start(

Diff for: test/fixtures/contentbase-config/public/bar/index.html

@@ -0,0 +1 @@
+Heyo