feat: Add major features from webpack-dev-server

* compress
* proxy
* before
* after
* historyApiFallback (object format)
* contentBasePublicPath
* serveIndex
* headers

Author: prantlf

README.md

@@ -65,10 +65,24 @@ serve({
   // Multiple folders to serve from
   contentBase: ['dist', 'static'],
 
+  // URL root path to serve the static content at
+  contentBasePublicPath: '/',
+
+  // Customize serving of static files, see https://expressjs.com/en/resources/middleware/serve-static.html
+  staticOptions: {},
+
+  // Set to true to enable the default compression, or to an object to customize the compression
+  // according to https://expressjs.com/en/resources/middleware/compression.html
+  compress: false,
+
+  // Set to true to enable directory indexes, or to an object to customize the index generation
+  // according to https://expressjs.com/en/resources/middleware/serve-index.html
+  serveIndex: false,
+
   // Set to true to return index.html (200) instead of error page (404)
   historyApiFallback: false,
 
-  // Path to fallback page
+  // Path to fallback page, see also https://github.com/bripkens/connect-history-api-fallback
   historyApiFallback: '/200.html',
 
   // Options used in setting up server
@@ -82,18 +96,38 @@ serve({
     ca: fs.readFileSync('/path/to/ca.pem')
   },
 
-  //set headers
+  // Set additional headers
   headers: {
     'Access-Control-Allow-Origin': '*',
     foo: 'bar'
   },
 
-  // set custom mime types, usage https://github.com/broofa/mime#mimedefinetypemap-force--false
+  // Set custom mime types, usage https://github.com/broofa/mime#mimedefinetypemap-force--false
   mimeTypes: {
     'application/javascript': ['js_commonjs-proxy']
-  }
+  },
+
+  // Let requests to /api/* be forwarded to http://localhost:3000/*
+  // See the full documentation at https://webpack.js.org/configuration/dev-server/#devserverproxy
+  proxy: [
+    {
+      context: ['/api'],
+      target: 'http://localhost:3000',
+      pathRewrite: { '^/api': '' },
+    },
+  ],
+
+  // Customize the Express instance before all middlewares are installed
+  before: function(app) {
+    ...
+  },
+
+  // Customize the Express instance after all middlewares are installed
+  after: function(app) {
+    ...
+  },
 
-  // execute function after server has begun listening
+  // Execute function after server has begun listening
   onListening: function (server) {
     const address = server.address()
     const host = address.address === '::' ? 'localhost' : address.address

index.d.ts

@@ -2,6 +2,7 @@ import { Plugin } from 'rollup'
 import { IncomingHttpHeaders, OutgoingHttpHeaders, Server } from 'http'
 import { ServerOptions } from 'https'
 import { TypeMap } from 'mime'
+import { Application } from 'express'
 
 export interface RollupServeOptions {
   /**
@@ -26,6 +27,29 @@ export interface RollupServeOptions {
    */
   contentBase?: string | string[]
 
+  /**
+   * URL root path to serve the static content at (default: `'/'`)
+   */
+  contentBasePublicPath?: string
+
+  /**
+   * Options to be passed to the serve-static middleware, see the documentation
+   * at https://expressjs.com/en/resources/middleware/serve-static.html.
+   */
+  staticOptions?: object
+
+  /**
+   * Enable compression of the served content. If you want to customize the default
+   * settings, see https://expressjs.com/en/resources/middleware/compression.html.
+   */
+  compress?: boolean | object
+
+  /**
+   * Enable directory indexes. If you want to customize the default
+   * settings, see https://expressjs.com/en/resources/middleware/serve-index.html.
+   */
+  serveIndex?: boolean | object
+
   /**
    * Set to `true` to return index.html (200) instead of error page (404)
    * or path to fallback page
@@ -63,6 +87,23 @@ export interface RollupServeOptions {
    */
   mimeTypes?: TypeMap
 
+  /**
+   * Let some requests be forwarded to other servers by their URL path. For example,
+   * requests to /api/* be can be forwarded to http://localhost:3000/*. See the full
+   * documentation at https://webpack.js.org/configuration/dev-server/#devserverproxy.
+   */
+  proxy?: object[]
+
+  /**
+   * Function to be called before all Express middlewares are installed.
+   */
+  before?: (app: Application) => void
+
+  /**
+   * Function to be called after all Express middlewares are installed.
+   */
+  after?: (app: Application) => void
+
   /**
    * Execute function after server has begun listening
    */

package.json

@@ -40,8 +40,14 @@
   ],
   "type": "module",
   "dependencies": {
+    "compression": "^1.8.1",
+    "connect-history-api-fallback": "^2.0.0",
+    "express": "^5.2.1",
+    "http-proxy-middleware": "^3.0.5",
+    "killable": "^1.0.1",
     "mime": "^4",
-    "opener": "1"
+    "opener": "1",
+    "serve-index": "^1.9.1"
   },
   "devDependencies": {
     "@rollup/plugin-buble": "^1.0.0",

rollup.config.js

@@ -6,6 +6,25 @@ export default {
     { file: 'dist/index.cjs', format: 'cjs', exports: 'default' },
     { file: 'dist/index.mjs', format: 'esm' }
   ],
-  plugins: [buble()],
-  external: ['fs', 'https', 'http', 'path', 'mime', 'opener']
+  plugins: [
+    buble({
+      transforms: { forOf: false }
+    })
+  ],
+  external: [
+    'fs',
+    'https',
+    'http',
+    'path',
+    'mime/lite',
+    'mime/types/standard.js',
+    'mime/types/other.js',
+    'opener',
+    'express',
+    'killable',
+    'compression',
+    'serve-index',
+    'connect-history-api-fallback',
+    'http-proxy-middleware'
+  ]
 }