fix: fail on invalid options

NicoPennec · NicoPennec · commit 92a4f2f2ac27 · 2019-11-12T01:41:27.000+01:00
diff --git a/lib/builder.js b/lib/builder.js
@@ -5,6 +5,8 @@ const { URL } = require('url')
 const isHTTPS = require('is-https')
 const sm = require('sitemap')
 
+const logger = require('./logger')
+
 /**
  * Initialize a fresh sitemap instance
  *
@@ -73,11 +75,11 @@ function createSitemapIndex(options, base = null, req = null) {
   const sitemapIndexConfig = {}
 
   // Set urls
-  const defaultHostname = getHostname(options, req, base)
+  const defaultHostname = options.hostname
   sitemapIndexConfig.urls = options.sitemaps.map(options => {
     // Normalize to absolute path
     const path = join('.', options.gzip ? `${options.path}.gz` : options.path)
-    const hostname = options.hostname ? getHostname(options, req, base) : defaultHostname
+    const hostname = getHostname(options.hostname ? options : { ...options, hostname: defaultHostname }, req, base)
     const url = new URL(path, hostname)
     return url.href
   })
@@ -104,6 +106,10 @@ function createSitemapIndex(options, base = null, req = null) {
  * @returns {string}
  */
 function getHostname(options, req, base) {
+  /* istanbul ignore if */
+  if (!options.hostname && !req) {
+    logger.fatal('The `hostname` option is mandatory in your config on `spa` or `generate` build mode', options)
+  }
   return join(
     options.hostname || (req && `${isHTTPS(req) ? 'https' : 'http'}://${req.headers.host}`) || `http://${hostname()}`,
     base
diff --git a/lib/generator.js b/lib/generator.js
@@ -1,11 +1,11 @@
 const path = require('path')
 const { gzipSync } = require('zlib')
 
-const consola = require('consola')
 const fs = require('fs-extra')
 
 const { createSitemap, createSitemapIndex } = require('./builder')
 const { createRoutesCache } = require('./cache')
+const logger = require('./logger')
 const { setDefaultSitemapOptions, setDefaultSitemapIndexOptions } = require('./options')
 const { excludeRoutes } = require('./routes')
 
@@ -34,8 +34,6 @@ async function generateSitemaps(options, globalCache, nuxtInstance) {
  * @param {Nuxt}   nuxtInstance
  */
 async function generateSitemap(options, globalCache, nuxtInstance) {
-  consola.info('Generating sitemap')
-
   // Init options
   options = setDefaultSitemapOptions(options, nuxtInstance)
 
@@ -50,13 +48,13 @@ async function generateSitemap(options, globalCache, nuxtInstance) {
   const sitemap = await createSitemap(options, routes, base)
   const xmlFilePath = path.join(nuxtInstance.options.generate.dir, options.path)
   fs.outputFileSync(xmlFilePath, sitemap.toXML())
-  consola.success('Generated', getPathname(nuxtInstance.options.generate.dir, xmlFilePath))
+  logger.success('Generated', getPathname(nuxtInstance.options.generate.dir, xmlFilePath))
 
   // Generate sitemap.xml.gz
   if (options.gzip) {
     const gzipFilePath = path.join(nuxtInstance.options.generate.dir, options.pathGzip)
     fs.outputFileSync(gzipFilePath, sitemap.toGzip())
-    consola.success('Generated', getPathname(nuxtInstance.options.generate.dir, gzipFilePath))
+    logger.success('Generated', getPathname(nuxtInstance.options.generate.dir, gzipFilePath))
   }
 }
 
@@ -68,8 +66,6 @@ async function generateSitemap(options, globalCache, nuxtInstance) {
  * @param {Nuxt}   nuxtInstance
  */
 async function generateSitemapIndex(options, globalCache, nuxtInstance) {
-  consola.info('Generating sitemapindex')
-
   // Init options
   options = setDefaultSitemapIndexOptions(options)
 
@@ -78,14 +74,14 @@ async function generateSitemapIndex(options, globalCache, nuxtInstance) {
   const xml = createSitemapIndex(options, base)
   const xmlFilePath = path.join(nuxtInstance.options.generate.dir, options.path)
   fs.outputFileSync(xmlFilePath, xml)
-  consola.success('Generated', getPathname(nuxtInstance.options.generate.dir, xmlFilePath))
+  logger.success('Generated', getPathname(nuxtInstance.options.generate.dir, xmlFilePath))
 
   // Generate sitemapindex.xml.gz
   if (options.gzip) {
     const gzip = gzipSync(xml)
     const gzipFilePath = path.join(nuxtInstance.options.generate.dir, options.pathGzip)
     fs.outputFileSync(gzipFilePath, gzip)
-    consola.success('Generated', getPathname(nuxtInstance.options.generate.dir, gzipFilePath))
+    logger.success('Generated', getPathname(nuxtInstance.options.generate.dir, gzipFilePath))
   }
 
   // Generate linked sitemaps
diff --git a/lib/logger.js b/lib/logger.js
@@ -0,0 +1,19 @@
+/* istanbul ignore file */
+
+const consola = require('consola')
+
+function warn(message, options = null) {
+  consola.warn({
+    message: `[sitemap-module] ${message}`,
+    additional: JSON.stringify(options, null, 2)
+  })
+}
+
+function fatal(message, options = null) {
+  consola.fatal({
+    message: `[sitemap-module] ${message}`,
+    additional: options ? JSON.stringify(options, null, 2) : null
+  })
+}
+
+module.exports = { ...consola, warn, fatal }
diff --git a/lib/middleware.js b/lib/middleware.js
@@ -1,9 +1,8 @@
 const { gzipSync } = require('zlib')
 
-const consola = require('consola')
-
 const { createSitemap, createSitemapIndex } = require('./builder')
 const { createRoutesCache } = require('./cache')
+const logger = require('./logger')
 const { setDefaultSitemapOptions, setDefaultSitemapIndexOptions } = require('./options')
 const { excludeRoutes } = require('./routes')
 
@@ -19,7 +18,7 @@ function registerSitemaps(options, globalCache, nuxtInstance, depth = 0) {
   if (depth > 1) {
     // see https://webmasters.stackexchange.com/questions/18243/can-a-sitemap-index-contain-other-sitemap-indexes
     /* istanbul ignore next */
-    consola.warn("A sitemap index file can't list other sitemap index files, but only sitemap files")
+    logger.warn("A sitemap index file can't list other sitemap index files, but only sitemap files")
   }
 
   const isSitemapIndex = options && options.sitemaps && Array.isArray(options.sitemaps) && options.sitemaps.length > 0
diff --git a/lib/module.js b/lib/module.js
@@ -1,9 +1,9 @@
 const path = require('path')
 
-const consola = require('consola')
 const fs = require('fs-extra')
 
 const { generateSitemaps } = require('./generator')
+const logger = require('./logger')
 const { registerSitemaps } = require('./middleware')
 const { getStaticRoutes } = require('./routes')
 
@@ -36,7 +36,7 @@ module.exports = function module(moduleOptions) {
 
   // On "generate" mode, generate static files for each sitemap or sitemapindex
   nuxtInstance.nuxt.hook('generate:done', async () => {
-    consola.info('Generating sitemaps')
+    logger.info('Generating sitemaps')
     await Promise.all(options.map(options => generateSitemaps(options, globalCache, nuxtInstance)))
   })
 
diff --git a/lib/options.js b/lib/options.js
@@ -1,4 +1,4 @@
-const consola = require('consola')
+const logger = require('./logger')
 
 const DEFAULT_NUXT_PUBLIC_PATH = '/_nuxt/'
 
@@ -27,24 +27,24 @@ function setDefaultSitemapOptions(options, nuxtInstance) {
     defaults: {}
   }
 
-  options = {
+  const sitemapOptions = {
     ...defaults,
     ...options
   }
 
   /* istanbul ignore if */
-  if (options.generate) {
-    consola.warn('The "generate" option isn\'t needed anymore')
+  if (sitemapOptions.generate) {
+    logger.warn("The `generate` option isn't needed anymore in your config. Please remove it!")
   }
 
   /* istanbul ignore if */
-  if (!options.path) {
-    consola.warn('The "path" option is either empty or missing for a sitemap')
+  if (!sitemapOptions.path) {
+    logger.fatal('The `path` option is either empty or missing in your config for a sitemap', options)
   }
 
-  options.pathGzip = options.gzip ? `${options.path}.gz` : options.path
+  sitemapOptions.pathGzip = sitemapOptions.gzip ? `${sitemapOptions.path}.gz` : sitemapOptions.path
 
-  return options
+  return sitemapOptions
 }
 
 /**
@@ -63,29 +63,34 @@ function setDefaultSitemapIndexOptions(options) {
     xslUrl: undefined
   }
 
-  options = {
+  const sitemapIndexOptions = {
     ...defaults,
     ...options
   }
 
   /* istanbul ignore if */
-  if (options.generate) {
-    consola.warn("The option `generate` isn't needed anymore")
+  if (sitemapIndexOptions.generate) {
+    logger.warn("The `generate` option isn't needed anymore in your config. Please remove it!")
   }
 
   /* istanbul ignore if */
-  if (!options.path) {
-    consola.warn('The "path" option is either empty or missing for a sitemap index')
+  if (!sitemapIndexOptions.path) {
+    logger.fatal('The `path` option is either empty or missing in your config for a sitemap index', options)
   }
 
-  // set cascading hostname
-  options.sitemaps.forEach(sitemapOptions => {
-    sitemapOptions.hostname = sitemapOptions.hostname || options.hostname
+  sitemapIndexOptions.sitemaps.forEach(sitemapOptions => {
+    /* istanbul ignore if */
+    if (!sitemapOptions.path) {
+      logger.fatal('The `path` option is either empty or missing in your config for a sitemap', sitemapOptions)
+    }
+
+    // set cascading hostname
+    sitemapOptions.hostname = sitemapOptions.hostname || sitemapIndexOptions.hostname
   })
 
-  options.pathGzip = options.gzip ? `${options.path}.gz` : options.path
+  sitemapIndexOptions.pathGzip = sitemapIndexOptions.gzip ? `${sitemapIndexOptions.path}.gz` : sitemapIndexOptions.path
 
-  return options
+  return sitemapIndexOptions
 }
 
 module.exports = { setDefaultSitemapOptions, setDefaultSitemapIndexOptions }
