clean up parseOpts function and add jsdoc for parsed options object

Author: velzie

lib/core/defaults.json

@@ -103,19 +103,9 @@ module.exports = function createMiddleware(_dir, _options) {
 
   const root = path.join(path.resolve(dir), '/');
   const opts = optsParser(options);
-  const cache = opts.cache;
-  const autoIndex = opts.autoIndex;
-  const baseDir = opts.baseDir;
-  let defaultExt = opts.defaultExt;
-  const handleError = opts.handleError;
-  const headers = opts.headers;
-  const weakEtags = opts.weakEtags;
-  const handleOptionsMethod = opts.handleOptionsMethod;
 
   opts.root = dir;
-  if (defaultExt && /^\./.test(defaultExt)) {
-    defaultExt = defaultExt.replace(/^\./, '');
-  }
+  
 
   // Support hashes and .types files in mimeTypes @since 0.8
   if (opts.mimeTypes) {
@@ -197,7 +187,7 @@ module.exports = function createMiddleware(_dir, _options) {
     file = path.normalize(
       path.join(
         root,
-        path.relative(path.join('/', baseDir), pathname)
+        path.relative(path.join('/', opts.baseDir), pathname)
       )
     );
     // determine compressed forms if they were to exist, make sure to handle pre-compressed files, i.e. files with .br/.gz extension. we will serve them "as-is"
@@ -209,11 +199,11 @@ module.exports = function createMiddleware(_dir, _options) {
       if ( file.endsWith('.br') ) brotliFile = file;
     }
 
-    Object.keys(headers).forEach((key) => {
-      res.setHeader(key, headers[key]);
+    Object.keys(opts.headers).forEach((key) => {
+      res.setHeader(key, opts.headers[key]);
     });
 
-    if (req.method === 'OPTIONS' && handleOptionsMethod) {
+    if (req.method === 'OPTIONS' && opts.handleOptionsMethod) {
       res.end();
       return;
     }
@@ -238,8 +228,8 @@ module.exports = function createMiddleware(_dir, _options) {
       let contentType = mime.lookup(file, defaultType);
       const range = (req.headers && req.headers.range);
       const lastModified = (new Date(stat.mtime)).toUTCString();
-      const etag = generateEtag(stat, weakEtags);
-      let cacheControl = cache;
+      const etag = generateEtag(stat, opts.weakEtags);
+      let cacheControl = opts.cache;
       let stream = null;
       if (contentType && isTextFile(contentType)) {
         if (stat.size < buffer.constants.MAX_LENGTH) {
@@ -266,7 +256,7 @@ module.exports = function createMiddleware(_dir, _options) {
       }
 
       if (typeof cacheControl === 'function') {
-        cacheControl = cache(pathname);
+        cacheControl = opts.cache(pathname);
       }
       if (typeof cacheControl === 'number') {
         cacheControl = `max-age=${cacheControl}`;
@@ -374,11 +364,11 @@ module.exports = function createMiddleware(_dir, _options) {
               // This means we're already trying ./404.html and can not find it.
               // So send plain text response with 404 status code
               status[404](res, next);
-            } else if (!path.extname(parsed.pathname).length && defaultExt) {
+            } else if (!path.extname(parsed.pathname).length && opts.defaultExt) {
               // If there is no file extension in the path and we have a default
               // extension try filename and default extension combination before rendering 404.html.
               middleware({
-                url: `${parsed.pathname}.${defaultExt}${(parsed.search) ? parsed.search : ''}`,
+                url: `${parsed.pathname}.${opts.defaultExt}${(parsed.search) ? parsed.search : ''}`,
                 headers: req.headers,
               }, res, next);
             } else if (opts.showDir && opts.dirOverrides404) {
@@ -388,7 +378,7 @@ module.exports = function createMiddleware(_dir, _options) {
               return;
             } else {
               // Try to serve default ./404.html
-              const rawUrl = (handleError ? `/${path.join(baseDir, `404.${defaultExt}`)}` : req.url);
+              const rawUrl = (opts.handleError ? `/${path.join(opts.baseDir, `404.${opts.defaultExt}`)}` : req.url);
               const encodedUrl = ensureUriEncoded(rawUrl);
               middleware({
                 url: encodedUrl,
@@ -399,7 +389,7 @@ module.exports = function createMiddleware(_dir, _options) {
           } else if (err) {
             status[500](res, next, { error: err });
           } else if (stat.isDirectory()) {
-            if (!autoIndex && !opts.showDir) {
+            if (!opts.autoIndex && !opts.showDir) {
               status[404](res, next);
               return;
             }
@@ -417,11 +407,11 @@ module.exports = function createMiddleware(_dir, _options) {
               return;
             }
 
-            if (autoIndex) {
+            if (opts.autoIndex) {
               middleware({
                 url: urlJoin(
                   encodeURIComponent(pathname),
-                  `/index.${defaultExt}`
+                  `/index.${opts.defaultExt}`
                 ),
                 headers: req.headers,
               }, res, (autoIndexError) => {