\n
\n\n### 💬 More i18n Improvements\n\n- Locale domain support ([#155](https://github.com/nuxt-modules/sitemap/issues/155))\n- Support pages opt-outed using `defineI18nRoute(false)` ([#126](https://github.com/nuxt-modules/sitemap/issues/126))\n- Only add trusted i18n routes, will use meta tags when prerendering\n- Less aggressive filtering\n- Opt-in to transform dynamic URLs `__i18nTransform: true`\n\nSee the updated [i18n documentation](/docs/sitemap/guides/i18n)\n\n### 🚀 Caching Improvements\n\nNow utilises native route rules. By default will set up SWR rules for 10 minutes.\n\nLearn more on the [Sitemap Caching](/docs/sitemap/advanced/performance) guide.\n\n## Other Improvements\n\n### Nitro Composables for better types\n\nWhen creating an API endpoint that returns URLs you should use the new [`defineSitemapEventHandler()`{lang=\"ts\"}](/docs/sitemap/nitro-api/nitro-hooks) function for full TypeScript support.\n\n```ts\n// api/sitemap.ts\nexport default defineSitemapEventHandler(() => {\n return ['/foo']\n})\n```\n\n### Prerendering Improvements\n\nPreviously prerendering was done in a Node context, this will now run in a Nitro context which will provide better consistency between prerender and runtime environments.\n\n### Video Support\n\nVideo entries are now supported properly. ([#159](https://github.com/nuxt-modules/sitemap/issues/159))\n\n## ⚠️ Deprecations\n\n- `cacheTtl` is deprecated, you should use `cacheMaxAgeSeconds` which is more explicit.\n- `inferStaticPagesAsRoutes` is deprecated, if you were using this to opt-out of pages, you should use `excludeAppSources: true`\n\n## ☠️ Breaking Changes\n\n### Nuxt Hooks no longer supported\n\nIf you were using Nuxt hooks to modify the prerendered sitemap, you will need to migrate these to Nitro hooks.\n\n```ts [nuxt.config.ts]\nexport default defineNuxtConfig({\n hooks: {\n // old - no longer supported\n 'sitemap:resolved': function (ctx) {},\n 'sitemap:output': function (ctx) {}\n },\n})\n```\n\n```ts [server/plugins/sitemap]\nexport default defineNitroPlugin((nitroApp) => {\n nitroApp.hooks.hook('sitemap:output', async (ctx) => {\n // supported!\n })\n})\n```\n\n### Multi Sitemap App Sources\n\nBy default, app sources will no longer be included in multi sitemap implementations. You will need to use `includeAppSources: true` to re-enable it. See [Extending App Sources](/docs/sitemap/guides/multi-sitemaps#extending-app-sources) for more information.\n\n### Removed deprecations\n\n- The hook `sitemap:prerender` has been removed. You should use `sitemap:resolved` instead.\n- The config `trailingSlash` and `siteUrl` has been removed. You should use site config, see [Setting Site Config](/docs/site-config/guides/how-it-works).\n- The config `autoAlternativeLangPrefixes` has been removed. If you'd like to set up automatic alternative language prefixes use `__i18nTransform`.\n\n## Support my work\n\nThis release took over 40 hours.\nIf technical SEO developer experience in Nuxt is important to you, consider [supporting my work](https://github.com/sponsors/harlan-zw) on Nuxt SEO.\n"
},
{
"path": "docs/content/5.releases/8.v3.md",
"content": "---\ntitle: v3.0.0\ndescription: Release notes for v3.0.0.\n---\n\n## Features :rocket:\n\n### 🤝 Stable I18n Integration\n\nFully supporting i18n sites through the `sitemap` module has been a long requested feature.\n\nV2 Partially supported it, but in v3 support is fully integrated with build-time macros support and more.\n\n### 🚀 Default Caching\n\nCaching is now enabled by default for production sitemaps. Sitemaps will be cached for 1 hour.\n\nYou can change the cache time or disable caching by setting the `cacheTtl` config.\n\n```ts\nexport default defineNuxtConfig({\n sitemap: {\n cacheTtl: 5 * 60 * 60 * 1000 // 5 hours\n }\n})\n```\n\nYou can also provide your own cache instance by setting the `runtimeCacheStorage` config.\n\n```ts\nexport default defineNuxtConfig({\n sitemap: {\n runtimeCacheStorage: {\n driver: 'redis',\n host: 'localhost',\n port: 6379,\n db: 0,\n }\n }\n})\n```\n\nLearn more on the [Performance](/docs/sitemap/advanced/performance) guide.\n\n### Improved XML Stylesheet\n\nThe UI of the sitemap.xml page has been improved slightly. It now features more useful tips and links.\n\nYou can also customise the stylesheet with the new following config:\n- `xslTips` - Toggle the tips displayed on the sitemap.xml pages.\n- `xslColumns` - Customise the columns displayed on the sitemap.xml pages.\n\nFor example, you can change the columns to only show the `loc` and `lastmod` columns.\n\n```ts\nexport default defineNuxtConfig({\n sitemap: {\n xslColumns: [\n // URL column must always be set, no value needed\n { label: 'URL', width: '75%' },\n { label: 'Last Modified', value: 'sitemap:lastmod', width: '25%' },\n ],\n },\n})\n```\n\nLearn more on the [Customising the UI](/docs/sitemap/advanced/customising-ui) guide.\n\n### Debug Mode\n\nA `debug` config has been added\nwhich will give access to a custom endpoint at `/api/__sitemap__/debug` which will show you\nhow your sitemap is being generated.\n\nWhen you build your site with debug on, a `/__sitemap__/debug.json` page will be generated.\n\nThis is disabled by default and should only be enabled for debugging purposes.\n\n## Other Improvements\n\n## New Hook: `sitemap:output`\n\n**Type:** `async (ctx: { sitemap: string; sitemapName: string }) => void | Promise\n \n nuxt-simple-sitemap-devtools.webm\n \n
\n\n \n\n
\n\n"
},
{
"path": "examples/basic/app/pages/contact.vue",
"content": "\n About
\nThis is the about page.
\n\n
\n\n"
},
{
"path": "examples/basic/app/pages/index.vue",
"content": "\n Contact
\nThis is the contact page.
\n\n
\n\n"
},
{
"path": "examples/basic/nuxt.config.ts",
"content": "export default defineNuxtConfig({\n modules: ['@nuxtjs/sitemap'],\n\n site: {\n url: 'https://example.com',\n },\n\n compatibilityDate: '2025-01-01',\n})\n"
},
{
"path": "examples/basic/package.json",
"content": "{\n \"name\": \"nuxtjs-sitemap-basic-example\",\n \"type\": \"module\",\n \"private\": true,\n \"dependencies\": {\n \"@nuxtjs/sitemap\": \"latest\",\n \"nuxt\": \"^4.4.4\",\n \"vue\": \"^3.5.33\"\n }\n}\n"
},
{
"path": "examples/basic/tsconfig.json",
"content": "{\n \"extends\": \"./.nuxt/tsconfig.json\"\n}\n"
},
{
"path": "examples/dynamic-urls/app/app.vue",
"content": "\n Home
\nWelcome to the basic sitemap example.
\n\n
\n\n"
},
{
"path": "examples/dynamic-urls/app/pages/blog/[slug].vue",
"content": "\n Sitemap Dynamic URLs Example
\n \n\n View Sitemap\n
\nDynamic URLs are generated via server/api/_sitemap-urls.ts.
\n\n
\n\n"
},
{
"path": "examples/dynamic-urls/app/pages/index.vue",
"content": "\n Blog Post: {{ $route.params.slug }}
\nThis is a dynamically generated blog post page.
\n\n
\n\n"
},
{
"path": "examples/dynamic-urls/nuxt.config.ts",
"content": "export default defineNuxtConfig({\n modules: ['@nuxtjs/sitemap'],\n\n site: {\n url: 'https://example.com',\n },\n\n compatibilityDate: '2025-01-01',\n})\n"
},
{
"path": "examples/dynamic-urls/package.json",
"content": "{\n \"name\": \"nuxtjs-sitemap-dynamic-urls-example\",\n \"type\": \"module\",\n \"private\": true,\n \"dependencies\": {\n \"@nuxtjs/sitemap\": \"latest\",\n \"nuxt\": \"^4.4.4\",\n \"vue\": \"^3.5.33\"\n }\n}\n"
},
{
"path": "examples/dynamic-urls/server/api/_sitemap-urls.ts",
"content": "export default defineSitemapEventHandler(() => {\n return [\n { loc: '/blog/post-1', lastmod: new Date() },\n { loc: '/blog/post-2', lastmod: new Date() },\n { loc: '/blog/post-3', lastmod: new Date() },\n ]\n})\n"
},
{
"path": "examples/dynamic-urls/tsconfig.json",
"content": "{\n \"extends\": \"./.nuxt/tsconfig.json\"\n}\n"
},
{
"path": "examples/i18n/app/app.vue",
"content": "\n Home
\nWelcome to the dynamic URLs sitemap example.
\n\n
\n\n"
},
{
"path": "examples/i18n/app/pages/about.vue",
"content": "\n Sitemap i18n Example
\n \n\n View Sitemap\n
\nSitemap includes alternate hreflang entries for en, fr, and de locales.
\n\n
\n\n"
},
{
"path": "examples/i18n/app/pages/contact.vue",
"content": "\n About
\nThis is the about page.
\n\n
\n\n"
},
{
"path": "examples/i18n/app/pages/index.vue",
"content": "\n Contact
\nThis is the contact page.
\n\n
\n\n"
},
{
"path": "examples/i18n/nuxt.config.ts",
"content": "export default defineNuxtConfig({\n modules: ['@nuxtjs/sitemap', '@nuxtjs/i18n'],\n\n site: {\n url: 'https://example.com',\n },\n\n i18n: {\n locales: [\n { code: 'en', name: 'English' },\n { code: 'fr', name: 'Français' },\n { code: 'de', name: 'Deutsch' },\n ],\n defaultLocale: 'en',\n strategy: 'prefix_except_default',\n },\n\n compatibilityDate: '2025-01-01',\n})\n"
},
{
"path": "examples/i18n/package.json",
"content": "{\n \"name\": \"nuxtjs-sitemap-i18n-example\",\n \"type\": \"module\",\n \"private\": true,\n \"dependencies\": {\n \"@nuxtjs/i18n\": \"^10.3.0\",\n \"@nuxtjs/sitemap\": \"latest\",\n \"nuxt\": \"^4.4.4\",\n \"vue\": \"^3.5.33\"\n }\n}\n"
},
{
"path": "examples/i18n/tsconfig.json",
"content": "{\n \"extends\": \"./.nuxt/tsconfig.json\"\n}\n"
},
{
"path": "package.json",
"content": "{\n \"name\": \"@nuxtjs/sitemap\",\n \"type\": \"module\",\n \"version\": \"8.0.15\",\n \"packageManager\": \"pnpm@10.33.2\",\n \"description\": \"Powerfully flexible XML Sitemaps that integrate seamlessly, for Nuxt.\",\n \"author\": {\n \"name\": \"Harlan Wilton\",\n \"email\": \"harlan@harlanzw.com\",\n \"url\": \"https://harlanzw.com/\"\n },\n \"license\": \"MIT\",\n \"funding\": \"https://github.com/sponsors/harlan-zw\",\n \"homepage\": \"https://github.com/nuxt-modules/sitemap#readme\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"git+https://github.com/nuxt-modules/sitemap.git\"\n },\n \"bugs\": {\n \"url\": \"https://github.com/nuxt-modules/sitemap/issues\"\n },\n \"exports\": {\n \".\": {\n \"types\": \"./dist/types.d.mts\",\n \"import\": \"./dist/module.mjs\"\n },\n \"./content\": \"./dist/content.mjs\",\n \"./utils\": \"./dist/utils.mjs\"\n },\n \"main\": \"./dist/module.mjs\",\n \"typesVersions\": {\n \"*\": {\n \".\": [\n \"./dist/types.d.mts\"\n ],\n \"content\": [\n \"./dist/content.d.mts\"\n ],\n \"utils\": [\n \"./dist/utils.d.mts\"\n ]\n }\n },\n \"files\": [\n \"dist\"\n ],\n \"engines\": {\n \"node\": \">=18.0.0\"\n },\n \"scripts\": {\n \"lint\": \"eslint .\",\n \"lint:fix\": \"eslint . --fix\",\n \"client:build\": \"nuxt generate devtools\",\n \"prepack\": \"pnpm run build\",\n \"devtools\": \"nuxt dev devtools --port 3030\",\n \"build\": \"nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build && npm run client:build\",\n \"dev\": \"nuxt dev playground\",\n \"prepare:fixtures\": \"nuxt prepare test/fixtures/basic && nuxt prepare test/fixtures/i18n && nuxt prepare test/fixtures/i18n-micro\",\n \"dev:build\": \"nuxt build playground\",\n \"dev:prepare\": \"nuxt-module-build build --stub && nuxt-module-build prepare && nuxt prepare playground\",\n \"release\": \"pnpm build && bumpp -x \\\"npx changelogen --output=CHANGELOG.md\\\"\",\n \"test\": \"vitest run && pnpm run test:attw\",\n \"test:unit\": \"vitest --project=unit\",\n \"test:attw\": \"attw --pack\",\n \"typecheck\": \"nuxt typecheck\",\n \"prepare\": \"skilld prepare || true\"\n },\n \"peerDependencies\": {\n \"zod\": \">=3\"\n },\n \"peerDependenciesMeta\": {\n \"zod\": {\n \"optional\": true\n }\n },\n \"dependencies\": {\n \"@nuxt/kit\": \"catalog:\",\n \"consola\": \"catalog:\",\n \"defu\": \"catalog:\",\n \"fast-xml-parser\": \"catalog:\",\n \"nuxt-site-config\": \"catalog:\",\n \"nuxtseo-shared\": \"catalog:\",\n \"ofetch\": \"catalog:\",\n \"pathe\": \"catalog:\",\n \"pkg-types\": \"catalog:\",\n \"radix3\": \"catalog:\",\n \"ufo\": \"catalog:\",\n \"ultrahtml\": \"catalog:\"\n },\n \"devDependencies\": {\n \"@antfu/eslint-config\": \"catalog:\",\n \"@arethetypeswrong/cli\": \"catalog:\",\n \"@nuxt/content\": \"catalog:\",\n \"@nuxt/devtools-kit\": \"catalog:\",\n \"@nuxt/module-builder\": \"catalog:\",\n \"@nuxt/test-utils\": \"catalog:\",\n \"@nuxt/ui\": \"catalog:\",\n \"@nuxtjs/i18n\": \"catalog:\",\n \"@nuxtjs/robots\": \"catalog:\",\n \"@nuxtjs/sitemap\": \"workspace:*\",\n \"@vue/test-utils\": \"catalog:\",\n \"better-sqlite3\": \"catalog:\",\n \"bumpp\": \"catalog:\",\n \"eslint\": \"catalog:\",\n \"eslint-plugin-harlanzw\": \"catalog:\",\n \"execa\": \"catalog:\",\n \"happy-dom\": \"catalog:\",\n \"nuxt\": \"catalog:\",\n \"nuxt-i18n-micro\": \"catalog:\",\n \"nuxtseo-layer-devtools\": \"catalog:\",\n \"semver\": \"catalog:\",\n \"sirv\": \"catalog:\",\n \"std-env\": \"catalog:\",\n \"typescript\": \"catalog:\",\n \"vitest\": \"catalog:\",\n \"vue-tsc\": \"catalog:\",\n \"zod\": \"catalog:\"\n }\n}\n"
},
{
"path": "patches/@nuxtjs__mdc.patch",
"content": "diff --git a/dist/module.mjs b/dist/module.mjs\nindex e028b1a7fba50c413a0e5e40fd545d998917620a..a74d8a45a98dced151f1fc141f24c16746e0ab25 100644\n--- a/dist/module.mjs\n+++ b/dist/module.mjs\n@@ -350,7 +350,7 @@ const module = defineNuxtModule({\n filename: \"mdc-image-component.mjs\",\n write: true,\n getContents: ({ app }) => {\n- const image = app.components.find((c) => c.pascalName === \"NuxtImg\" && !c.filePath.includes(\"nuxt/dist/app\"));\n+ const image = app.components.find((c) => c.pascalName === \"NuxtImg\" && !c.filePath.includes(\"nuxt/dist/app\") && !c.filePath.includes(\"nuxt-nightly/dist/app\"));\n return image ? `export { default } from \"${image.filePath}\"` : 'export default \"img\"';\n }\n });\n"
},
{
"path": "playground/.nuxtrc",
"content": "imports.autoImport=true\n"
},
{
"path": "playground/app.vue",
"content": "\n\n\n Home
\nWelcome to the i18n sitemap example.
\n\n \n \n \n \n \n \n \n \n
\n \n \n \n \n
\n shouldn't be added
\n\n"
},
{
"path": "playground/pages/[...slug].vue",
"content": "\n {{ $route.params.slug }}
\n\n" }, { "path": "playground/pages/_dir/robots.txt", "content": "User-agent: *\nDisallow: /blocked-by-robots-txt\n" }, { "path": "playground/pages/about.vue", "content": "\n\n\n\n About page\n \n
\n\n"
},
{
"path": "playground/pages/api/foo.vue",
"content": "\n hello world
\n\n"
},
{
"path": "playground/pages/blocked-by-robots-txt/foo.vue",
"content": "\n This should be blocked by @nuxtjs/robots integration automatically.
\n\n"
},
{
"path": "playground/pages/blog/[id].vue",
"content": "\n Hello world
\n\n"
},
{
"path": "playground/pages/blog/categories.vue",
"content": "\n temp
\n\n"
},
{
"path": "playground/pages/blog/index.vue",
"content": "\n temp
\n\n"
},
{
"path": "playground/pages/blog/tags/edit.vue",
"content": "\n edit
\n\n"
},
{
"path": "playground/pages/blog/tags/new.vue",
"content": "\n new
\n\n"
},
{
"path": "playground/pages/blog/tags.vue",
"content": "\n temp
\n\n"
},
{
"path": "playground/pages/blog.vue",
"content": "\n temp
\n\n"
},
{
"path": "playground/pages/foo.bar.vue",
"content": "\n foo.bar
\n\n"
},
{
"path": "playground/pages/hidden-path-but-in-sitemap/index.vue",
"content": "\n \n
\n\n"
},
{
"path": "playground/pages/hide-me.vue",
"content": "\n You found me
\nhide-me
\n\n"
},
{
"path": "playground/pages/ignore-foo.vue",
"content": "\n foo
\n\n"
},
{
"path": "playground/pages/index.vue",
"content": "\n\n\n \n
\n\n"
},
{
"path": "playground/pages/new-page.vue",
"content": "\n \n Sitemap Playground\n
\n\n \n About\n \n \n Blog\n \n \n New Page\n \n \n Secret (robots: false)\n \n \n ignore-foo\n \n \n Dynamic Pre-render\n \n
\n \n New page\n
\n\n"
},
{
"path": "playground/pages/prerender-video.vue",
"content": "\n\n\n \n Pre-render Video Discovery Page\n\n \n \n Sorry, your browser doesn't support embedded videos, but don't worry, you\n can\n download it\n and watch it with your favorite video player!\n \n\n \n \n \n \n Sorry, your browser doesn't support embedded videos, but don't worry, you\n can\n download it\n and watch it with your favorite video player!\n \n
\n\n"
},
{
"path": "playground/pages/prerender.vue",
"content": "\n\n\n \n Pre-render Image Discovery Page\n\n \n \n\n \n \n
\n\n"
},
{
"path": "playground/pages/secret.vue",
"content": "\n\n\n \n
\n\n"
},
{
"path": "playground/pages/users-[group]/[id].vue",
"content": "\n \n Secret page, not for robots.\n
\n Hello world
\n\n"
},
{
"path": "playground/pages/users-[group]/index.vue",
"content": "\n Hello world
\n\n"
},
{
"path": "playground/server/api/_sitemap-urls.ts",
"content": "import { defineSitemapEventHandler } from '#imports'\n\nexport default defineSitemapEventHandler(() => {\n const posts = Array.from({ length: 5 }, (_, i) => i + 1)\n return [\n '/users-lazy/1',\n '/users-lazy/2',\n '/users-lazy/3',\n ...posts.map(post => ({\n loc: `/blog/post-${post}`,\n })),\n ]\n})\n"
},
{
"path": "playground/server/api/fetch.ts",
"content": "import type { asSitemapUrl } from '#imports'\nimport { defineSitemapEventHandler } from '#imports'\n\nexport default defineSitemapEventHandler(async () => {\n return $fetchxsl: false`,\n `View the raw XML by adding ?canonical to the URL`,\n `Check /__sitemap__/debug.json for full sitemap diagnostics`,\n ]\n const hint = hints[Math.floor(Math.random() * hints.length)]\n\n let columns = [...xslColumns!]\n if (!columns.length) {\n columns = [\n { label: 'URL', width: '50%' },\n { label: 'Images', width: '25%', select: 'count(image:image)' },\n { label: 'Last Updated', width: '25%', select: 'concat(substring(sitemap:lastmod,0,11),concat(\\' \\', substring(sitemap:lastmod,12,5)),concat(\\' \\', substring(sitemap:lastmod,20,6)))' },\n ]\n }\n\n return `\n\n \n \n \n \n
\n ${showDevTools\n ? ``\n : ''}\n \n \n \n
\n ${xmlEscape(title)}
\n \n\n \n \n
\n
\n | Sitemap | \nLast Modified | \n
|---|---|
| \n \n | \n \n | \n
\n \n \n
\n
\n | ${c.label} | `).join('\\n')}\n|
|---|---|
| \n \n \n | \n ${columns.filter(c => c.label !== 'URL').map(c => `
About
\n\n"
},
{
"path": "test/fixtures/basic/pages/crawled.vue",
"content": "\n \n \n dynamic crawl\n \n
\n\n"
},
{
"path": "test/fixtures/basic/pages/dynamic/[slug].vue",
"content": "\n hi
\n Hello world
\n\n"
},
{
"path": "test/fixtures/basic/pages/index.vue",
"content": "\n \n\n"
},
{
"path": "test/fixtures/basic/pages/sub/page.vue",
"content": "\n Hello world
\n\n"
},
{
"path": "test/fixtures/basic/server/api/sitemap/bar.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n const posts = Array.from({ length: 5 }, (_, i) => i + 1)\n return [\n ...posts.map(post => ({\n loc: `/bar/${post}`,\n })),\n ]\n})\n"
},
{
"path": "test/fixtures/basic/server/api/sitemap/foo.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n const posts = Array.from({ length: 5 }, (_, i) => i + 1)\n return [\n ...posts.map(post => ({\n loc: `/foo/${post}`,\n })),\n ]\n})\n"
},
{
"path": "test/fixtures/basic/server/routes/__sitemap.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n return [\n '/__sitemap/url',\n {\n loc: '/__sitemap/loc',\n },\n {\n loc: 'https://nuxtseo.com/__sitemap/abs',\n },\n ]\n})\n"
},
{
"path": "test/fixtures/chunk-cache/app.vue",
"content": "\n chunk cache fixture
\n\n"
},
{
"path": "test/fixtures/chunk-cache/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [NuxtSitemap],\n site: { url: 'https://nuxtseo.com' },\n sitemap: {\n autoLastmod: false,\n credits: false,\n cacheMaxAgeSeconds: 600,\n runtimeCacheStorage: { driver: 'memory' },\n sitemaps: {\n posts: {\n sources: ['/api/posts'],\n chunks: 5,\n },\n },\n },\n})\n"
},
{
"path": "test/fixtures/chunk-cache/server/api/posts.ts",
"content": "import { defineEventHandler } from 'h3'\n\ndeclare global {\n // eslint-disable-next-line vars-on-top, no-var\n var __postsSourceCallCount: number\n}\n\nglobalThis.__postsSourceCallCount ??= 0\n\nexport default defineEventHandler(() => {\n globalThis.__postsSourceCallCount++\n return Array.from({ length: 17 }, (_, i) => ({\n loc: `/posts/${i + 1}`,\n }))\n})\n"
},
{
"path": "test/fixtures/chunk-cache/server/api/source-call-count.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n return { count: globalThis.__postsSourceCallCount ?? 0 }\n})\n"
},
{
"path": "test/fixtures/chunk-count/app.vue",
"content": "\n chunk count fixture
\n\n"
},
{
"path": "test/fixtures/chunk-count/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [NuxtSitemap],\n site: { url: 'https://nuxtseo.com' },\n sitemap: {\n autoLastmod: false,\n credits: false,\n sitemaps: {\n posts: {\n sources: ['/api/posts'],\n chunks: 5,\n chunkCount: 4,\n },\n },\n },\n})\n"
},
{
"path": "test/fixtures/chunk-count/server/api/posts-call-count.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => ({ count: globalThis.__chunkCountPostsCalls ?? 0 }))\n"
},
{
"path": "test/fixtures/chunk-count/server/api/posts.ts",
"content": "import { defineEventHandler } from 'h3'\n\ndeclare global {\n // eslint-disable-next-line vars-on-top, no-var\n var __chunkCountPostsCalls: number\n}\n\nglobalThis.__chunkCountPostsCalls ??= 0\n\nexport default defineEventHandler(() => {\n globalThis.__chunkCountPostsCalls++\n return Array.from({ length: 17 }, (_, i) => ({ loc: `/posts/${i + 1}` }))\n})\n"
},
{
"path": "test/fixtures/chunks/app.vue",
"content": "\n hello world
\n\n"
},
{
"path": "test/fixtures/chunks/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\n// https://v3.nuxtjs.org/api/configuration/nuxt.config\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n ],\n site: {\n url: 'https://nuxtseo.com',\n },\n sitemap: {\n autoLastmod: false,\n credits: false,\n debug: true,\n defaultSitemapsChunkSize: 5,\n sitemaps: true,\n urls: Array.from({ length: 20 }, (_, i) => `/foo/${i + 1}`),\n excludeAppSources: true,\n },\n})\n"
},
{
"path": "test/fixtures/chunks/server/api/sitemap/bar.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n const posts = Array.from({ length: 5 }, (_, i) => i + 1)\n return [\n ...posts.map(post => ({\n loc: `/bar/${post}`,\n })),\n ]\n})\n"
},
{
"path": "test/fixtures/chunks/server/api/sitemap/foo.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n const posts = Array.from({ length: 5 }, (_, i) => i + 1)\n return [\n ...posts.map(post => ({\n loc: `/foo/${post}`,\n })),\n ]\n})\n"
},
{
"path": "test/fixtures/chunks/server/routes/__sitemap.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n return [\n '/__sitemap/url',\n {\n loc: '/__sitemap/loc',\n },\n {\n loc: 'https://nuxtseo.com/__sitemap/abs',\n },\n ]\n})\n"
},
{
"path": "test/fixtures/content-v3/.nuxtrc",
"content": "imports.autoImport=true\ntypescript.includeWorkspace=true\n"
},
{
"path": "test/fixtures/content-v3/app.vue",
"content": "\n ![\"Sponsors\"](\"https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg\")
\n"
},
{
"path": "test/fixtures/content-v3/content/foo.md",
"content": "---\nsitemap:\n priority: 0.5\n---\n\n# foo\n"
},
{
"path": "test/fixtures/content-v3/content/posts/.navigation.yml",
"content": "title: 'test'\n"
},
{
"path": "test/fixtures/content-v3/content/posts/bar.md",
"content": "---\nsitemap:\n lastmod: 2021-10-20\n---\n# bar\n"
},
{
"path": "test/fixtures/content-v3/content/posts/fallback.md",
"content": "---\nsitemap:\n lastmod: 2021-10-20\n---\n\n# foo\n\nno sitemap config\n"
},
{
"path": "test/fixtures/content-v3/content/posts/foo.md",
"content": "# foo\n\nno sitemap config\n"
},
{
"path": "test/fixtures/content-v3/content/test-json.json",
"content": "{\n \"title\": \"Test JSON Content\",\n \"description\": \"This is a test JSON file for sitemap\",\n \"sitemap\": {\n \"lastmod\": \"2025-05-14\",\n \"changefreq\": \"weekly\",\n \"priority\": 0.9\n },\n \"content\": \"This is some JSON content\"\n}"
},
{
"path": "test/fixtures/content-v3/content/test-yaml.yml",
"content": "title: Test YAML Content\ndescription: This is a test YAML file for sitemap\nsitemap:\n lastmod: 2025-05-13\n changefreq: monthly\n priority: 0.8\ncontent: This is some YAML content"
},
{
"path": "test/fixtures/content-v3/content.config.ts",
"content": "import { resolve, dirname } from 'node:path'\nimport { defineCollection, defineContentConfig } from '@nuxt/content'\nimport { asSitemapCollection } from '../../../src/content'\nimport { z } from 'zod'\n\n// conjvert file path to url\nconst dirName = dirname(import.meta.url.replace('file://', ''))\n\nexport default defineContentConfig({\n collections: {\n content: defineCollection(\n asSitemapCollection({\n type: 'page',\n source: {\n include: '**/*',\n cwd: resolve(dirName, 'content'),\n },\n schema: z.object({\n date: z.string().optional(),\n }),\n }),\n ),\n },\n})\n"
},
{
"path": "test/fixtures/content-v3/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n '@nuxt/content',\n ],\n\n site: {\n url: 'https://nuxtseo.com',\n },\n compatibilityDate: '2024-12-06',\n\n sitemap: {\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/content-v3/pages/[...slug].vue",
"content": "\n\n\n \n
\n\n"
},
{
"path": "test/fixtures/content-v3-define-schema/app.vue",
"content": "\n \n Page not found\n
\n \n
\n\n"
},
{
"path": "test/fixtures/generate/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\n// https://v3.nuxtjs.org/api/configuration/nuxt.config\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n ],\n\n site: {\n url: 'https://nuxtseo.com',\n },\n\n routeRules: {\n '/foo-redirect': {\n redirect: '/foo',\n },\n '/sub/page': {\n sitemap: {\n changefreq: 'weekly',\n priority: 0.5,\n },\n },\n },\n\n compatibilityDate: '2025-01-15',\n\n nitro: {\n prerender: {\n crawlLinks: true,\n routes: ['/', '/about', '/noindex', '/sub/page'],\n },\n },\n\n sitemap: {\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/generate/pages/about.vue",
"content": "\n\n\n \n Page not found\n
\n About
\n\n"
},
{
"path": "test/fixtures/generate/pages/crawled.vue",
"content": "\n \n \n dynamic crawl\n \n
\n\n"
},
{
"path": "test/fixtures/generate/pages/dynamic/[slug].vue",
"content": "\n hi
\n Hello world
\n\n"
},
{
"path": "test/fixtures/generate/pages/index.vue",
"content": "\n \n \n crawled\n \n \n should be ignored as its a redirect\n \n
\n\n"
},
{
"path": "test/fixtures/generate/pages/noindex.vue",
"content": "\n\n\n Hello World
\nThis page should not be in the sitemap
\n\n"
},
{
"path": "test/fixtures/generate/pages/sub/page.vue",
"content": "\n Hello world
\n\n"
},
{
"path": "test/fixtures/generate/server/api/sitemap/bar.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n const posts = Array.from({ length: 5 }, (_, i) => i + 1)\n return [\n ...posts.map(post => ({\n loc: `/bar/${post}`,\n })),\n ]\n})\n"
},
{
"path": "test/fixtures/generate/server/api/sitemap/foo.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n const posts = Array.from({ length: 5 }, (_, i) => i + 1)\n return [\n ...posts.map(post => ({\n loc: `/foo/${post}`,\n })),\n ]\n})\n"
},
{
"path": "test/fixtures/generate/server/routes/__sitemap.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n return [\n '/__sitemap/url',\n {\n loc: '/__sitemap/loc',\n },\n {\n loc: 'https://nuxtseo.com/__sitemap/abs',\n },\n ]\n})\n"
},
{
"path": "test/fixtures/hooks/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\n// https://v3.nuxtjs.org/api/configuration/nuxt.config\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n ],\n\n site: {\n url: 'https://nuxtseo.com',\n },\n\n routeRules: {\n '/foo-redirect': {\n redirect: '/foo',\n },\n },\n\n compatibilityDate: '2025-01-15',\n\n sitemap: {\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/hooks/pages/index.vue",
"content": "\n \n \n sitemap.xml\n \n
\n\n"
},
{
"path": "test/fixtures/hooks/server/plugins/sitemap.ts",
"content": "import { defineNitroPlugin } from 'nitropack/runtime'\n\nexport default defineNitroPlugin((nitroApp) => {\n nitroApp.hooks.hook('sitemap:input', async (ctx) => {\n ctx.urls.push({\n loc: '/test-1',\n })\n\n ctx.urls.push({\n loc: '/test-2',\n })\n })\n})\n"
},
{
"path": "test/fixtures/hooks/server/routes/__sitemap.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n return [\n '/__sitemap/url',\n {\n loc: '/__sitemap/loc',\n },\n {\n loc: 'https://nuxtseo.com/__sitemap/abs',\n },\n ]\n})\n"
},
{
"path": "test/fixtures/i18n/locales/en.ts",
"content": "export default {\n welcome: 'Welcome',\n}\n"
},
{
"path": "test/fixtures/i18n/locales/hr.ts",
"content": "export default {\n welcome: 'ようこそ',\n}\n"
},
{
"path": "test/fixtures/i18n/locales/ja.ts",
"content": "export default {\n welcome: 'ようこそ',\n}\n"
},
{
"path": "test/fixtures/i18n/locales/nl.ts",
"content": "export default {\n welcome: 'Welcome',\n}\n"
},
{
"path": "test/fixtures/i18n/locales/zh.ts",
"content": "export default {\n welcome: '欢迎光临',\n}\n"
},
{
"path": "test/fixtures/i18n/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\n// https://v3.nuxtjs.org/api/configuration/nuxt.config\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n '@nuxtjs/i18n',\n ],\n site: {\n url: 'https://nuxtseo.com',\n },\n\n compatibilityDate: '2024-07-22',\n nitro: {\n prerender: {\n failOnError: false,\n ignore: ['/'],\n },\n },\n i18n: {\n baseUrl: 'https://nuxtseo.com',\n detectBrowserLanguage: false,\n defaultLocale: 'en',\n strategy: 'prefix',\n locales: [\n {\n code: 'en',\n iso: 'en-US',\n },\n {\n code: 'es',\n iso: 'es-ES',\n },\n {\n code: 'fr',\n iso: 'fr-FR',\n },\n ],\n },\n sitemap: {\n sources: ['/__sitemap'],\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/i18n/pages/dynamic/[page].vue",
"content": "\n\n\n {{ $route.params.page }}
\n\n"
},
{
"path": "test/fixtures/i18n/pages/index.vue",
"content": "\n\n\n \n
\n\n"
},
{
"path": "test/fixtures/i18n/pages/no-i18n.vue",
"content": "\n\n\n {{ $t('welcome') }}
\nhello
\n\n"
},
{
"path": "test/fixtures/i18n/pages/test.vue",
"content": "\n\n\n \n
\n\n"
},
{
"path": "test/fixtures/i18n/server/routes/__sitemap.ts",
"content": "import { defineSitemapEventHandler } from '#imports'\n\nexport default defineSitemapEventHandler(() => {\n return [\n {\n loc: '/__sitemap/url',\n changefreq: 'weekly',\n _i18nTransform: true,\n },\n ]\n})\n"
},
{
"path": "test/fixtures/i18n/server/routes/i18n-urls.ts",
"content": "import { defineSitemapEventHandler } from '#imports'\n\nexport default defineSitemapEventHandler(() => {\n return [\n {\n loc: '/en/dynamic/foo',\n },\n {\n loc: '/fr/dynamic/foo',\n },\n {\n loc: 'endless-dungeon', // issue with en being picked up as the locale\n _i18nTransform: true,\n },\n {\n loc: 'english-url', // issue with en being picked up as the locale\n },\n // absolute URL issue\n { loc: 'https://www.somedomain.com/abc/def' },\n ]\n})\n"
},
{
"path": "test/fixtures/i18n-custom-paths/app.vue",
"content": "\n {{ $t('welcome') }}
\n\n
\n\n"
},
{
"path": "test/fixtures/i18n-custom-paths/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n '@nuxtjs/i18n',\n ],\n site: {\n url: 'https://nuxtseo.com',\n },\n\n compatibilityDate: '2024-07-22',\n nitro: {\n prerender: {\n failOnError: false,\n ignore: ['/'],\n },\n },\n i18n: {\n baseUrl: 'https://nuxtseo.com',\n detectBrowserLanguage: false,\n defaultLocale: 'en',\n strategy: 'prefix_except_default',\n locales: [\n {\n code: 'en',\n iso: 'en-US',\n },\n {\n code: 'es',\n iso: 'es-ES',\n },\n {\n code: 'fr',\n iso: 'fr-FR',\n },\n ],\n pages: {\n test: {\n en: '/test',\n es: '/prueba',\n fr: '/teste',\n },\n about: {\n en: '/about',\n es: '/acerca-de',\n fr: '/a-propos',\n },\n // dynamic route with single parameter (issue #542)\n posts: {\n en: '/posts/[slug]',\n es: '/articulos/[slug]',\n fr: '/article/[slug]',\n },\n // dynamic route with multiple parameters\n products: {\n en: '/products/[category]/[id]',\n es: '/productos/[category]/[id]',\n fr: '/produits/[category]/[id]',\n },\n },\n },\n sitemap: {\n sources: ['/__sitemap'],\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/i18n-custom-paths/server/routes/__sitemap.ts",
"content": "import { defineSitemapEventHandler } from '#imports'\n\nexport default defineSitemapEventHandler(() => {\n return [\n // Static routes\n {\n loc: '/test',\n _i18nTransform: true,\n },\n {\n loc: '/about',\n _i18nTransform: true,\n },\n {\n loc: '/__sitemap/url',\n changefreq: 'weekly',\n },\n // Dynamic route with single parameter (issue #542)\n {\n loc: '/posts/my-slug',\n _i18nTransform: true,\n },\n // Dynamic route with multiple parameters\n {\n loc: '/products/electronics/laptop-123',\n _i18nTransform: true,\n },\n ]\n})\n"
},
{
"path": "test/fixtures/i18n-generate/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n '@nuxtjs/i18n',\n ],\n\n site: {\n url: 'https://nuxtseo.com',\n },\n\n compatibilityDate: '2024-07-22',\n\n nitro: {\n prerender: {\n routes: ['/', '/de'],\n crawlLinks: false,\n },\n },\n\n i18n: {\n baseUrl: 'https://nuxtseo.com',\n detectBrowserLanguage: false,\n defaultLocale: 'en',\n strategy: 'prefix_except_default',\n locales: [\n {\n code: 'en',\n iso: 'en-US',\n },\n {\n code: 'de',\n iso: 'de-DE',\n },\n ],\n },\n\n sitemap: {\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/i18n-generate/pages/index.vue",
"content": "\n \n
\n\n"
},
{
"path": "test/fixtures/i18n-micro/locales/en.ts",
"content": "export default {\n welcome: 'Welcome',\n}\n"
},
{
"path": "test/fixtures/i18n-micro/locales/hr.ts",
"content": "export default {\n welcome: 'ようこそ',\n}\n"
},
{
"path": "test/fixtures/i18n-micro/locales/ja.ts",
"content": "export default {\n welcome: 'ようこそ',\n}\n"
},
{
"path": "test/fixtures/i18n-micro/locales/nl.ts",
"content": "export default {\n welcome: 'Welcome',\n}\n"
},
{
"path": "test/fixtures/i18n-micro/locales/zh.ts",
"content": "export default {\n welcome: '欢迎光临',\n}\n"
},
{
"path": "test/fixtures/i18n-micro/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n 'nuxt-i18n-micro',\n ],\n site: {\n url: 'https://nuxtseo.com',\n },\n\n compatibilityDate: '2024-07-22',\n nitro: {\n prerender: {\n failOnError: false,\n ignore: ['/'],\n },\n },\n i18n: {\n baseUrl: 'https://nuxtseo.com',\n detectBrowserLanguage: false,\n defaultLocale: 'en',\n strategy: 'prefix',\n locales: [\n {\n code: 'en',\n iso: 'en-US',\n },\n {\n code: 'es',\n iso: 'es-ES',\n },\n {\n code: 'fr',\n iso: 'fr-FR',\n },\n ],\n meta: true,\n },\n sitemap: {\n sources: ['/__sitemap'],\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/i18n-micro/pages/dynamic/[page].vue",
"content": "\n Home
\n{{ $route.params.page }}
\n\n"
},
{
"path": "test/fixtures/i18n-micro/pages/index.vue",
"content": "\n\n\n \n
\n\n"
},
{
"path": "test/fixtures/i18n-micro/pages/test.vue",
"content": "\n {{ $t('welcome') }}
\n\n
\n\n"
},
{
"path": "test/fixtures/i18n-micro/server/routes/__sitemap.ts",
"content": "import { defineSitemapEventHandler } from '#imports'\n\nexport default defineSitemapEventHandler(() => {\n return [\n {\n loc: '/__sitemap/url',\n changefreq: 'weekly',\n _i18nTransform: true,\n },\n ]\n})\n"
},
{
"path": "test/fixtures/i18n-micro/server/routes/i18n-urls.ts",
"content": "import { defineSitemapEventHandler } from '#imports'\n\nexport default defineSitemapEventHandler(() => {\n return [\n {\n loc: '/en/dynamic/foo',\n },\n {\n loc: '/fr/dynamic/foo',\n },\n {\n loc: 'endless-dungeon', // issue with en being picked up as the locale\n _i18nTransform: true,\n },\n {\n loc: 'english-url', // issue with en being picked up as the locale\n },\n // absolute URL issue\n { loc: 'https://www.somedomain.com/abc/def' },\n ]\n})\n"
},
{
"path": "test/fixtures/i18n-no-prefix/locales/en.ts",
"content": "export default {\n welcome: 'Welcome',\n}\n"
},
{
"path": "test/fixtures/i18n-no-prefix/locales/hr.ts",
"content": "export default {\n welcome: 'ようこそ',\n}\n"
},
{
"path": "test/fixtures/i18n-no-prefix/locales/ja.ts",
"content": "export default {\n welcome: 'ようこそ',\n}\n"
},
{
"path": "test/fixtures/i18n-no-prefix/locales/nl.ts",
"content": "export default {\n welcome: 'Welcome',\n}\n"
},
{
"path": "test/fixtures/i18n-no-prefix/locales/zh.ts",
"content": "export default {\n welcome: '欢迎光临',\n}\n"
},
{
"path": "test/fixtures/i18n-no-prefix/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n '@nuxtjs/i18n',\n ],\n site: {\n url: 'https://nuxtseo.com',\n },\n\n compatibilityDate: '2024-07-22',\n nitro: {\n prerender: {\n failOnError: false,\n ignore: ['/'],\n },\n },\n i18n: {\n baseUrl: 'https://nuxtseo.com',\n detectBrowserLanguage: false,\n defaultLocale: 'en',\n strategy: 'no_prefix',\n locales: [\n {\n code: 'en',\n iso: 'en-US',\n },\n {\n code: 'es',\n iso: 'es-ES',\n },\n {\n code: 'fr',\n iso: 'fr-FR',\n },\n ],\n pages: {\n test: {\n en: '/test',\n es: '/prueba',\n fr: '/teste',\n },\n about: {\n en: '/about',\n es: '/acerca-de',\n fr: '/a-propos',\n },\n },\n },\n sitemap: {\n sources: ['/__sitemap'],\n autoLastmod: false,\n credits: false,\n debug: true,\n discoverImages: false,\n discoverVideos: false,\n },\n})\n"
},
{
"path": "test/fixtures/i18n-no-prefix/pages/dynamic/[page].vue",
"content": "\n {{ $t('welcome') }}
\n{{ $route.params.page }}
\n\n"
},
{
"path": "test/fixtures/i18n-no-prefix/pages/index.vue",
"content": "\n\n\n \n
\n\n"
},
{
"path": "test/fixtures/i18n-no-prefix/pages/test.vue",
"content": "\n {{ $t('welcome') }}
\n\n
\n\n"
},
{
"path": "test/fixtures/i18n-no-prefix/server/routes/__sitemap.ts",
"content": "import { defineSitemapEventHandler } from '#imports'\n\nexport default defineSitemapEventHandler(() => {\n return [\n {\n loc: '/__sitemap/url',\n changefreq: 'weekly',\n _i18nTransform: true,\n },\n ]\n})\n"
},
{
"path": "test/fixtures/i18n-no-prefix/server/routes/i18n-urls.ts",
"content": "import { defineSitemapEventHandler } from '#imports'\n\nexport default defineSitemapEventHandler(() => {\n return [\n {\n loc: '/en/dynamic/foo',\n },\n {\n loc: '/fr/dynamic/foo',\n },\n {\n loc: 'endless-dungeon', // issue with en being picked up as the locale\n _i18nTransform: true,\n },\n {\n loc: 'english-url', // issue with en being picked up as the locale\n },\n // absolute URL issue\n { loc: 'https://www.somedomain.com/abc/def' },\n ]\n})\n"
},
{
"path": "test/fixtures/issue-384/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n '@nuxtjs/robots',\n NuxtSitemap,\n ],\n\n site: {\n url: 'https://nuxtseo.com',\n },\n\n robots: {\n groups: [\n {\n userAgent: '*',\n disallow: '/',\n },\n ],\n },\n\n compatibilityDate: '2025-01-15',\n\n sitemap: {\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/issue-384/pages/about.vue",
"content": "\n {{ $t('welcome') }}
\n\n
\n\n"
},
{
"path": "test/fixtures/issue-384/pages/index.vue",
"content": "\n About
\n\n
\n\n"
},
{
"path": "test/fixtures/issue-504/nuxt.config.ts",
"content": "import { defineNuxtConfig } from 'nuxt/config'\nimport NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n ],\n site: {\n url: 'https://example.com',\n },\n sitemap: {\n cacheMaxAgeSeconds: 0,\n sitemapsPathPrefix: false,\n sitemaps: {\n test: {\n includeAppSources: true,\n sources: ['/api/__sitemap__/test'],\n },\n },\n },\n})\n"
},
{
"path": "test/fixtures/issue-504/pages/about.vue",
"content": "\n Home
\nAbout
\n\n"
},
{
"path": "test/fixtures/issue-504/pages/index.vue",
"content": "\n Index
\n\n"
},
{
"path": "test/fixtures/issue-504/server/api/__sitemap__/[s_type].ts",
"content": "import { defineEventHandler, getRouterParam } from 'h3'\n\n// Track call count at module level\nlet callCount = 0\n\nexport default defineEventHandler((event) => {\n const category = getRouterParam(event, 's_type')\n callCount++\n // eslint-disable-next-line no-console\n console.log(`sitemap: ${category} (call ${callCount})`)\n\n // Store count in app context for test retrieval\n const storage = (globalThis as any).__sitemapTestStorage = (globalThis as any).__sitemapTestStorage || {}\n storage.callCount = callCount\n\n return [\n { loc: '/dynamic-page-1' },\n { loc: '/dynamic-page-2' },\n ]\n})\n"
},
{
"path": "test/fixtures/issue-504/server/api/__sitemap__/call-count.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n const storage = (globalThis as any).__sitemapTestStorage || {}\n return { count: storage.callCount || 0 }\n})\n"
},
{
"path": "test/fixtures/issue-514/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n ],\n site: {\n url: 'https://example.com',\n },\n sitemap: {\n cacheMaxAgeSeconds: 0,\n sitemapsPathPrefix: '/',\n sitemaps: {\n pages: {\n includeAppSources: true,\n },\n dynamic: {\n sources: ['/api/urls'],\n chunks: 10,\n },\n },\n },\n})\n"
},
{
"path": "test/fixtures/issue-514/pages/about.vue",
"content": "\n About page
\n\n"
},
{
"path": "test/fixtures/issue-514/pages/index.vue",
"content": "\n Home
\n\n"
},
{
"path": "test/fixtures/issue-514/server/api/urls.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n return Array.from({ length: 15 }, (_, i) => ({\n loc: `/dynamic/${i + 1}`,\n lastmod: new Date(2024, 0, i + 1).toISOString(),\n }))\n})\n"
},
{
"path": "test/fixtures/issue-561/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n '@nuxtjs/i18n',\n ],\n\n site: {\n url: 'https://example.com',\n },\n\n compatibilityDate: '2024-07-22',\n\n i18n: {\n baseUrl: 'https://example.com',\n strategy: 'prefix_except_default',\n defaultLocale: 'fr',\n detectBrowserLanguage: false,\n locales: [\n {\n code: 'en',\n iso: 'en-CA',\n language: 'en',\n },\n {\n code: 'fr',\n iso: 'fr-CA',\n language: 'fr',\n },\n ],\n trailingSlash: true,\n customRoutes: 'config',\n pages: {\n 'submit-art': {\n fr: '/envoyer-tableau',\n en: '/submit-art',\n },\n 'privacy-policy': {\n fr: '/politique-de-confidentialite',\n en: '/privacy-policy',\n },\n },\n },\n\n sitemap: {\n autoI18n: false,\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/issue-561/pages/index.vue",
"content": "\n \n
\n\n"
},
{
"path": "test/fixtures/issue-561/pages/privacy-policy.vue",
"content": "\n Home
\n\n
\n\n"
},
{
"path": "test/fixtures/issue-561/pages/submit-art.vue",
"content": "\n Privacy Policy
\n\n
\n\n"
},
{
"path": "test/fixtures/issue-588/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n ],\n\n site: {\n url: 'https://example.com',\n },\n\n compatibilityDate: '2024-07-22',\n\n sitemap: {\n autoI18n: false,\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/issue-588/pages/about.vue",
"content": "\n\n\n Submit Art
\n\n
\n\n"
},
{
"path": "test/fixtures/issue-588/pages/contact.vue",
"content": "\n\n\n About
\n\n
\n\n"
},
{
"path": "test/fixtures/issue-588/pages/index.vue",
"content": "\n Contact
\n\n
\n\n"
},
{
"path": "test/fixtures/issue-592/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n '@nuxtjs/i18n',\n ],\n\n site: {\n url: 'https://nuxtseo.com',\n },\n\n compatibilityDate: '2024-07-22',\n\n i18n: {\n baseUrl: 'https://nuxtseo.com',\n detectBrowserLanguage: false,\n defaultLocale: 'en',\n strategy: 'prefix_except_default',\n locales: [\n {\n code: 'en',\n iso: 'en-US',\n },\n {\n code: 'de',\n iso: 'de-DE',\n },\n ],\n },\n\n sitemap: {\n zeroRuntime: true,\n autoLastmod: false,\n credits: false,\n },\n})\n"
},
{
"path": "test/fixtures/issue-592/pages/index.vue",
"content": "\n Home
\n\n
\n\n"
},
{
"path": "test/fixtures/multi-with-chunks/app.vue",
"content": "\n Home
\n\n
\n\n"
},
{
"path": "test/fixtures/multi-with-chunks/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\n// https://v3.nuxtjs.org/api/configuration/nuxt.config\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n ],\n site: {\n url: 'https://nuxtseo.com',\n },\n sitemap: {\n autoLastmod: false,\n credits: false,\n debug: true,\n defaultSitemapsChunkSize: 5,\n sitemaps: {\n pages: {\n urls: Array.from({ length: 20 }, (_, i) => `/page/${i + 1}`),\n excludeAppSources: true,\n },\n posts: {\n sources: [\n '/api/posts',\n ],\n chunks: true,\n chunkSize: 3,\n },\n products: {\n sources: [\n '/api/products',\n ],\n chunks: 10, // use 10 as chunk size\n },\n },\n },\n})\n"
},
{
"path": "test/fixtures/multi-with-chunks/server/api/posts.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n // Generate 12 posts to test chunking with chunkSize: 3 (should create 4 chunks)\n return Array.from({ length: 12 }, (_, i) => ({\n loc: `/posts/${i + 1}`,\n lastmod: new Date(2024, 0, i + 1).toISOString(),\n }))\n})\n"
},
{
"path": "test/fixtures/multi-with-chunks/server/api/products.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n // Generate 25 products to test chunking with chunkSize: 10 (should create 3 chunks)\n return Array.from({ length: 25 }, (_, i) => ({\n loc: `/products/${i + 1}`,\n lastmod: new Date(2024, 1, i + 1).toISOString(),\n }))\n})\n"
},
{
"path": "test/fixtures/no-pages/app.vue",
"content": "\n Multi Sitemap Chunking Test
\nhello world
\n\n"
},
{
"path": "test/fixtures/no-pages/nuxt.config.ts",
"content": "import NuxtSitemap from '../../../src/module'\n\n// https://v3.nuxtjs.org/api/configuration/nuxt.config\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n ],\n\n site: {\n url: 'https://nuxtseo.com',\n },\n\n compatibilityDate: '2025-03-14',\n\n sitemap: {\n sources: ['/__sitemap'],\n autoLastmod: false,\n credits: false,\n debug: true,\n },\n})\n"
},
{
"path": "test/fixtures/sources-hook/nuxt.config.ts",
"content": "import { defineNuxtConfig } from 'nuxt/config'\nimport NuxtSitemap from '../../../src/module'\n\nexport default defineNuxtConfig({\n modules: [\n NuxtSitemap,\n ],\n site: {\n url: 'https://example.com',\n },\n nitro: {\n plugins: ['~/server/plugins/sources-hook.ts'],\n },\n sitemap: {\n sources: [\n '/api/initial-source',\n ],\n },\n})\n"
},
{
"path": "test/fixtures/sources-hook/pages/index.vue",
"content": "\n Test fixture for sources hook
\n\n"
},
{
"path": "test/fixtures/sources-hook/server/api/dynamic-source.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler(() => {\n return [\n { loc: '/dynamic-source-url' },\n ]\n})\n"
},
{
"path": "test/fixtures/sources-hook/server/api/initial-source.ts",
"content": "import { defineEventHandler } from 'h3'\n\nexport default defineEventHandler((event) => {\n const headers = event.node.req.headers\n\n // Return different URLs based on whether headers were modified by hook\n if (headers['x-hook-modified'] === 'true') {\n return [\n { loc: '/hook-modified' },\n ]\n }\n\n return [\n { loc: '/initial-source-default' },\n ]\n})\n"
},
{
"path": "test/fixtures/sources-hook/server/plugins/sources-hook.ts",
"content": "import { defineNitroPlugin } from 'nitropack/runtime'\n\nexport default defineNitroPlugin((nitroApp) => {\n nitroApp.hooks.hook('sitemap:sources', async (ctx) => {\n // Add a new source dynamically using simple string syntax\n ctx.sources.push('/api/dynamic-source')\n\n // Add a source to be filtered (also using simple string syntax)\n ctx.sources.push('/api/skip-this')\n\n // Modify existing sources to add headers\n ctx.sources = ctx.sources.map((source) => {\n if (typeof source === 'object' && 'fetch' in source && source.fetch === '/api/initial-source') {\n // Modify fetch to add headers\n source.fetch = ['/api/initial-source', { headers: { 'X-Hook-Modified': 'true' } }]\n }\n return source\n })\n\n // Filter out sources we don't want\n ctx.sources = ctx.sources.filter((source) => {\n if (typeof source === 'string')\n return !source.includes('skip-this')\n if (typeof source === 'object' && 'fetch' in source && source.fetch) {\n const fetchUrl = Array.isArray(source.fetch) ? source.fetch[0] : source.fetch\n return !fetchUrl.includes('skip-this')\n }\n return true\n })\n })\n})\n"
},
{
"path": "test/types/templates.test-d.ts",
"content": "import type {\n SitemapIndexRenderCtx,\n SitemapInputCtx,\n SitemapItemDefaults,\n SitemapOutputHookCtx,\n SitemapRenderCtx,\n SitemapSourceBase,\n SitemapSourceResolved,\n SitemapSourcesHookCtx,\n SitemapUrl,\n} from '@nuxtjs/sitemap'\nimport type { NitroRouteConfig, NitroRouteRules, NitroRuntimeHooks, PrerenderRoute } from 'nitropack'\nimport type { NitroRouteConfig as NitroRouteConfigTypes, NitroRouteRules as NitroRouteRulesTypes, NitroRuntimeHooks as NitroRuntimeHooksTypes, PrerenderRoute as PrerenderRouteTypes } from 'nitropack/types'\nimport type { RouteMeta } from 'vue-router'\nimport type { PageMeta } from '#app'\nimport type { sources as childSources } from '#sitemap-virtual/child-sources.mjs'\nimport type { sources as globalSources } from '#sitemap-virtual/global-sources.mjs'\nimport type { readSourcesFromFilesystem } from '#sitemap-virtual/read-sources.mjs'\nimport { describe, expectTypeOf, it } from 'vitest'\n\n// Tests the actual generated type augmentations from .nuxt/types/nuxt-sitemap-augments.d.ts\n// and virtual module declarations from .nuxt/types/nuxt-sitemap-virtual.d.ts.\n// Requires `nuxi prepare` to have been run so .nuxt/ exists.\n\ndescribe('nitropack augmentations', () => {\n it('PrerenderRoute._sitemap is SitemapUrl', () => {\n expectTypeOf![\"Test](\"/_ipx/_/logo.svg\"){kind=logo}