feat: improve static.serveIndex defaults (#4968)

Author: snitin315

lib/Server.js

@@ -863,13 +863,20 @@ class Server {
  ? optionsForStatic.publicPath
  : [optionsForStatic.publicPath]
  : def.publicPath,
- // TODO: do merge in the next major release
  serveIndex:
+ // Check if 'serveIndex' property is defined in 'optionsForStatic'
+ // If 'serveIndex' is a boolean and true, use default 'serveIndex'
+ // If 'serveIndex' is an object, merge its properties with default 'serveIndex'
+ // If 'serveIndex' is neither a boolean true nor an object, use it as-is
+ // If 'serveIndex' is not defined in 'optionsForStatic', use default 'serveIndex'
  // eslint-disable-next-line no-nested-ternary
  typeof optionsForStatic.serveIndex !== "undefined"
- ? typeof optionsForStatic.serveIndex === "boolean" &&
+ ? // eslint-disable-next-line no-nested-ternary
+ typeof optionsForStatic.serveIndex === "boolean" &&
  optionsForStatic.serveIndex
  ? def.serveIndex
+ : typeof optionsForStatic.serveIndex === "object"
+ ? { ...def.serveIndex, ...optionsForStatic.serveIndex }
  : optionsForStatic.serveIndex
  : def.serveIndex,
  watch:

test/__snapshots__/normalize-options.test.js.snap.webpack5

@@ -2363,7 +2363,66 @@ exports[`normalize options static publicPath is an array 1`] = `
 }
 `;
 
-exports[`normalize options static serveIndex is an object 1`] = `
+exports[`normalize options static serveIndex is an object more options 1`] = `
+{
+ "allowedHosts": "auto",
+ "bonjour": false,
+ "client": {
+ "logging": "info",
+ "overlay": true,
+ "reconnect": 10,
+ "webSocketURL": {},
+ },
+ "compress": true,
+ "devMiddleware": {},
+ "historyApiFallback": false,
+ "host": undefined,
+ "hot": true,
+ "liveReload": true,
+ "open": [],
+ "port": "<auto>",
+ "server": {
+ "options": {},
+ "type": "http",
+ },
+ "setupExitSignals": true,
+ "static": [
+ {
+ "directory": "<cwd>/public",
+ "publicPath": [
+ "/",
+ ],
+ "serveIndex": {
+ "hidden": true,
+ "icons": true,
+ "stylesheet": "https://example.com/style.css",
+ "view": "details",
+ },
+ "staticOptions": {},
+ "watch": {
+ "alwaysStat": true,
+ "atomic": false,
+ "followSymlinks": false,
+ "ignoreInitial": true,
+ "ignorePermissionErrors": true,
+ "ignored": undefined,
+ "interval": undefined,
+ "persistent": true,
+ "usePolling": false,
+ },
+ },
+ ],
+ "watchFiles": [],
+ "webSocketServer": {
+ "options": {
+ "path": "/ws",
+ },
+ "type": "ws",
+ },
+}
+`;
+
+exports[`normalize options static serveIndex is an object with icons false 1`] = `
 {
  "allowedHosts": "auto",
  "bonjour": false,

test/normalize-options.test.js

@@ -469,7 +469,7 @@ describe("normalize options", () => {
  },
  },
  {
- title: "static serveIndex is an object",
+ title: "static serveIndex is an object with icons false",
  multiCompiler: false,
  options: {
  static: {
@@ -479,6 +479,19 @@ describe("normalize options", () => {
  },
  },
  },
+ {
+ title: "static serveIndex is an object more options",
+ multiCompiler: false,
+ options: {
+ static: {
+ serveIndex: {
+ hidden: true,
+ stylesheet: "https://example.com/style.css",
+ view: "details",
+ },
+ },
+ },
+ },
 
  {
  title: "single compiler watchOptions is object",