Skip to content

Commit

Permalink
fix: warn about mixing multi and single sitemap config
Browse files Browse the repository at this point in the history
Relates to #287
  • Loading branch information
harlan-zw committed Jul 1, 2024
1 parent 630cae1 commit 32b9f86
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,20 @@ export default defineNuxtModule<ModuleOptions>({
config.defaults.lastmod = normaliseDate(new Date())
}

// warn about bad config
if (!nuxt.options._prepare && Object.keys(config.sitemaps || {}).length) {
// if the user is doing multi-sitempas using the sitemaps config, we warn when root keys are used as they won't do anything
const invalidRootKeys = [
'includeAppSources',
'sources',
]
for (const key of invalidRootKeys) {
if (Object.keys(config).includes(key))
logger.warn(`You are using multiple-sitemaps but have provided \`sitemap.${key}\` in your Nuxt config. This will be ignored, please move it to the child sitemap config.`)
logger.warn('Learn more at: https://nuxtseo.com/sitemap/guides/multi-sitemaps')
}
}

// for trailing slashes / canonical absolute urls
await installNuxtSiteConfig()
const userGlobalSources: SitemapSourceInput[] = [
Expand Down

0 comments on commit 32b9f86

Please sign in to comment.