feat: Nuxt Content v3 (#175)

Author: harlan-zw

Diff for: docs/content/2.guides/3.content.md

@@ -3,36 +3,77 @@ title: Nuxt Content
 description: How to use the Nuxt Robots module with Nuxt Content.
 ---
 
-Nuxt Robots integrates with Nuxt Content out of the box. Allowing you to configure if
-a page should be indexable or not right from your markdown files.
+## Introduction
 
-## Setup
+Nuxt Robots comes with an integration for Nuxt Content that allows you to configure robots straight from your markdown directly.
 
-Simply use the `robots: false` frontmatter key to opt out of indexing a page.
+## Setup Nuxt Content v3
 
-```md [content/foo.md]
----
-robots: false
----
+In Nuxt Content v3 we need to use the `asRobotsCollection()`{lang="ts"} function to augment any collections
+to be able to use the `robots` frontmatter key.
+
+```ts [content.config.ts]
+import { defineCollection, defineContentConfig, z } from '@nuxt/content'
+import { asRobotsCollection } from '@nuxtjs/robots'
+
+export default defineContentConfig({
+  collections: {
+    content: defineCollection(
+      // adds the robots frontmatter key to the collection
+      asRobotsCollection({
+        type: 'page',
+        source: '**/*.md',
+      }),
+    ),
+  },
+})
 ```
 
-This will require that your markdown files have an associated path. When using [Document Driven Mode](https://content.nuxt.com/document-driven/introduction), all markdown files will automatically
-have a path set.
+To ensure the tags actually gets rendered you need to ensure you're using the `useSeoMeta()`{lang="ts"} composable with `seo`.
 
-Otherwise, you will need to make sure your markdown files have a `path` key.
+```vue [[...slug].vue]
+<script setup lang="ts">
+import { queryCollection, useRoute } from '#imports'
+
+const route = useRoute()
+const { data: page } = await useAsyncData(`page-${route.path}`, () => {
+  return queryCollection('content').path(route.path).first()
+})
+useSeoMeta(page.value.seo)
+</script>
+```
+
+## Setup Nuxt Content v2
+
+In Nuxt Content v2 markdown files require either [Document Driven Mode](https://content.nuxt.com/document-driven/introduction) or a `path` key to be set
+in the frontmatter.
 
 ```md [content/foo.md]
 ---
 path: /foo
-robots: false
 ---
 ```
 
-### Requirements
+## Usage
 
-The Nuxt Content integration does not currently work with the v3 of Nuxt Content. It also won't work when using deploying your site with Cloudflare.
+You can use any boolean or string value as `robots` that will be forwarded as a
+[Meta Robots Tag](/learn/controlling-crawlers/meta-tags).
 
-It's recommended to manually disable to integration in these cases:
+::code-group
+
+```md [input.md]
+robots: false
+```
+
+```html [output]
+<meta name="robots" content="noindex, nofollow">
+```
+
+::
+
+### Disabling Nuxt Content Integration
+
+If you need to disable the Nuxt Content integration, you can do so by setting the `disableNuxtContentIntegration`{lang="ts"} option in the module configuration.
 
 ```ts [nuxt.config.ts]
 export default defineNuxtConfig({
@@ -41,15 +82,3 @@ export default defineNuxtConfig({
   }
 })
 ```
-
-## How it works
-
-This will add an entry to your `robots.txt` file that looks like this:
-
-```robots-txt [robots.txt]
-User-agent: *
-Disallow: /foo
-```
-
-It will add the `X-Robots-Tag` header and `<meta name="robots">` tag to the page with the value of
-[`robotsDisabledValue`](/docs/robots/api/config#robotsdisabledvalue).

Diff for: package.json

@@ -74,7 +74,8 @@
     "@iconify-json/logos": "^1.2.4",
     "@iconify-json/ri": "^1.2.5",
     "@iconify-json/tabler": "^1.2.14",
-    "@nuxt/content": "^2.13.4",
+    "@nuxt/content": "^3.0.0",
+    "@nuxt/content-v2": "npm:@nuxt/content@2.13.4",
     "@nuxt/devtools-ui-kit": "^1.7.0",
     "@nuxt/module-builder": "^0.8.4",
     "@nuxt/test-utils": "^3.15.4",
@@ -93,7 +94,7 @@
     "nuxt": "^3.15.1",
     "typescript": "5.6.3",
     "unocss": "^65.4.0",
-    "vitest": "^2.1.8",
+    "vitest": "^3.0.2",
     "vue": "3.5.13",
     "vue-router": "^4.5.0"
   },
@@ -103,7 +104,8 @@
   "build": {
     "externals": [
       "h3",
-      "consola"
+      "consola",
+      "@nuxt/content"
     ]
   }
 }

Diff for: pnpm-lock.yaml

@@ -1,3 +1,4 @@
 packages:
   - client
   - .playground
+  - test/fixtures/**

Diff for: pnpm-workspace.yaml

@@ -0,0 +1,20 @@
+import { z } from '@nuxt/content'
+
+export function asRobotsCollection(collection: any) {
+  if (collection.type !== 'page') {
+    return
+  }
+  if (!collection.schema) {
+    collection.schema = z.object({
+      robots: z.union([z.string(), z.boolean()]).optional(),
+    })
+  }
+  else {
+    collection.schema = collection.schema.extend({
+      robots: z.union([z.string(), z.boolean()]).optional(),
+    })
+  }
+  collection._integrations = collection._integrations || []
+  collection._integrations.push('robots')
+  return collection
+}

Diff for: src/content.ts

@@ -169,6 +169,8 @@ export interface ModulePublicRuntimeConfig {
   ['nuxt-robots']: ResolvedModuleOptions
 }
 
+export * from './content'
+
 export default defineNuxtModule<ModuleOptions>({
   meta: {
     name: '@nuxtjs/robots',
@@ -331,16 +333,26 @@ export default defineNuxtModule<ModuleOptions>({
     }
 
     const nitroPreset = resolveNitroPreset(nuxt.options.nitro)
-    let usingNuxtContent = hasNuxtModule('@nuxt/content') && config.disableNuxtContentIntegration !== true
-    if (usingNuxtContent) {
-      if (await hasNuxtModuleCompatibility('@nuxt/content', '^3')) {
-        logger.warn('Nuxt Robots does not work with Nuxt Content v3 yet, the integration will be disabled. Learn more at: https://nuxtseo.com/docs/robots/guides/content')
-        usingNuxtContent = false
-      }
-      else if (nitroPreset.startsWith('cloudflare')) {
-        logger.warn('The Nuxt Robots, Nuxt Content integration does not work with CloudFlare yet, the integration will be disabled. Learn more at: https://nuxtseo.com/docs/robots/guides/content')
-        usingNuxtContent = false
-      }
+    const usingNuxtContent = hasNuxtModule('@nuxt/content')
+    const isNuxtContentV3 = usingNuxtContent && await hasNuxtModuleCompatibility('@nuxt/content', '^3')
+    let isNuxtContentV2 = usingNuxtContent && await hasNuxtModuleCompatibility('@nuxt/content', '^2')
+    if (isNuxtContentV3) {
+      // @ts-expect-error runtime type
+      nuxt.hooks.hook('content:file:afterParse', (ctx) => {
+        if (typeof ctx.content.robots !== 'undefined') {
+          let rule = ctx.content.robots
+          if (typeof rule === 'boolean' || !rule) {
+            rule = rule ? config.robotsEnabledValue : config.robotsDisabledValue
+          }
+          // add route rule for the path
+          ctx.content.seo = ctx.content.seo || {}
+          ctx.content.seo.robots = rule
+        }
+      })
+    }
+    else if (isNuxtContentV2 && nitroPreset.startsWith('cloudflare')) {
+      logger.warn('The Nuxt Robots, Nuxt Content integration does not work with CloudFlare yet, the integration will be disabled. Learn more at: https://nuxtseo.com/docs/robots/guides/content')
+      isNuxtContentV2 = false
     }
 
     nuxt.hook('modules:done', async () => {
@@ -435,7 +447,7 @@ export default defineNuxtModule<ModuleOptions>({
 
       nuxt.options.runtimeConfig['nuxt-robots'] = {
         version: version || '',
-        usingNuxtContent,
+        isNuxtContentV2,
         debug: config.debug,
         credits: config.credits,
         groups,
@@ -515,10 +527,10 @@ declare module 'h3' {
     })
     addServerPlugin(resolve('./runtime/server/plugins/initContext'))
 
-    if (usingNuxtContent) {
+    if (isNuxtContentV2) {
       addServerHandler({
         route: '/__robots__/nuxt-content.json',
-        handler: resolve('./runtime/server/routes/__robots__/nuxt-content'),
+        handler: resolve('./runtime/server/routes/__robots__/nuxt-content-v2'),
       })
     }
 

Diff for: src/module.ts

@@ -8,7 +8,7 @@ import { getSiteRobotConfig } from './getSiteRobotConfig'
 
 export function getPathRobotConfig(e: H3Event, options?: { userAgent?: string, skipSiteIndexable?: boolean, path?: string }): { rule: string, indexable: boolean, debug?: { source: string, line: string } } {
   // has already been resolved
-  const { robotsDisabledValue, robotsEnabledValue, usingNuxtContent } = useRuntimeConfig()['nuxt-robots']
+  const { robotsDisabledValue, robotsEnabledValue, isNuxtContentV2 } = useRuntimeConfig()['nuxt-robots']
   if (!options?.skipSiteIndexable) {
     if (!getSiteRobotConfig(e).indexable) {
       return {
@@ -69,7 +69,7 @@ export function getPathRobotConfig(e: H3Event, options?: { userAgent?: string, s
   }
 
   // 2. nuxt content rules
-  if (usingNuxtContent && nitroApp._robots?.nuxtContentUrls?.has(withoutTrailingSlash(path))) {
+  if (isNuxtContentV2 && nitroApp._robots?.nuxtContentUrls?.has(withoutTrailingSlash(path))) {
     return {
       indexable: false,
       rule: robotsDisabledValue,

Diff for: src/runtime/server/composables/getPathRobotConfig.ts

@@ -1,4 +1,4 @@
-import type { NitroApp } from 'nitropack'
+import type { NitroApp } from 'nitropack/types'
 import { defineNitroPlugin, getRouteRules, useRuntimeConfig } from 'nitropack/runtime'
 import { withoutTrailingSlash } from 'ufo'
 import { logger } from '../logger'
@@ -9,11 +9,11 @@ const PRERENDER_NO_SSR_ROUTES = new Set(['/index.html', '/200.html', '/404.html'
 // we need to init our state using a nitro plugin so the user doesn't throttle the resolve context hook
 // important when we integrate with nuxt-simple-sitemap and we're checking thousands of URLs
 export default defineNitroPlugin(async (nitroApp: NitroApp) => {
-  const { usingNuxtContent, robotsDisabledValue } = useRuntimeConfig()['nuxt-robots']
+  const { isNuxtContentV2, robotsDisabledValue } = useRuntimeConfig()['nuxt-robots']
   nitroApp._robots = {} as typeof nitroApp._robots
   await resolveRobotsTxtContext(undefined, nitroApp)
   const nuxtContentUrls = new Set<string>()
-  if (usingNuxtContent) {
+  if (isNuxtContentV2) {
     let urls: string[] | undefined
     try {
       urls = await (await nitroApp.localFetch('/__robots__/nuxt-content.json', {})).json()

Diff for: src/runtime/server/plugins/initContext.ts

@@ -1,3 +1,4 @@
+// @ts-expect-error v3 installed
 import type { ParsedContent } from '@nuxt/content'
 // @ts-expect-error alias module
 import { serverQueryContent } from '#content/server'

Diff for: src/runtime/server/routes/__robots__/nuxt-content.ts renamed to src/runtime/server/routes/__robots__/nuxt-content-v2.ts

@@ -10,7 +10,7 @@ import { resolveRobotsTxtContext } from '../util'
 export default defineEventHandler(async (e) => {
   const nitro = useNitroApp()
   const { indexable, hints } = getSiteRobotConfig(e)
-  const { credits, usingNuxtContent, cacheControl } = useRuntimeConfig(e)['nuxt-robots']
+  const { credits, isNuxtContentV2, cacheControl } = useRuntimeConfig(e)['nuxt-robots']
   // move towards deprecating indexable
   let robotsTxtCtx: Omit<HookRobotsConfigContext, 'context' | 'event'> = {
     errors: [],
@@ -32,7 +32,7 @@ export default defineEventHandler(async (e) => {
         // validate sitemaps are absolute
         .map(s => !s.startsWith('http') ? withSiteUrl(e, s, { withBase: true, absolute: true }) : s),
     )]
-    if (usingNuxtContent) {
+    if (isNuxtContentV2) {
       const contentWithRobotRules = await e.$fetch<string[]>('/__robots__/nuxt-content.json', {
         headers: {
           Accept: 'application/json',

Diff for: src/runtime/server/routes/robots-txt.ts

@@ -11,6 +11,10 @@ export default defineNuxtConfig({
     url: 'https://nuxtseo.com',
   },
 
+  alias: {
+    '@nuxt/content': '@nuxt/content-v2',
+  },
+
   debug: process.env.NODE_ENV === 'test',
   compatibilityDate: '2024-12-18',
 })

Diff for: test/fixtures/content/app.vue renamed to test/fixtures/content-v2/app.vue

@@ -0,0 +1,2 @@
+imports.autoImport=true
+typescript.includeWorkspace=true

Diff for: test/fixtures/content/content/_partial.md renamed to test/fixtures/content-v2/content/_partial.md

@@ -0,0 +1,3 @@
+<template>
+  <NuxtPage />
+</template>

Diff for: test/fixtures/content/content/bar.md renamed to test/fixtures/content-v2/content/bar.md

@@ -0,0 +1,16 @@
+import { defineCollection, defineContentConfig, z } from '@nuxt/content'
+import { asRobotsCollection } from '../../../src/module'
+
+export default defineContentConfig({
+  collections: {
+    content: defineCollection(
+      asRobotsCollection({
+        type: 'page',
+        source: '**/*.md',
+        schema: z.object({
+          date: z.string().optional(),
+        }),
+      }),
+    ),
+  },
+})

Diff for: test/fixtures/content/content/foo.md renamed to test/fixtures/content-v2/content/foo.md

@@ -0,0 +1,5 @@
+---
+robots: false
+---
+
+# bar

Diff for: test/fixtures/content/content/posts/bar.md renamed to test/fixtures/content-v2/content/posts/bar.md

@@ -0,0 +1,6 @@
+---
+path: /bar
+robots: "test"
+---
+
+# bar

Diff for: test/fixtures/content/content/posts/fallback.md renamed to test/fixtures/content-v2/content/posts/fallback.md

@@ -0,0 +1,7 @@
+---
+path: '/foo'
+robots: false
+date: 2026-10-10
+---
+
+# foo

Diff for: test/fixtures/content/content/posts/foo.md renamed to test/fixtures/content-v2/content/posts/foo.md

@@ -0,0 +1,4 @@
+---
+---
+
+# index

Diff for: test/fixtures/content/nuxt.config.ts renamed to test/fixtures/content-v2/nuxt.config.ts

@@ -0,0 +1,6 @@
+---
+sitemap:
+  loc: /blog/posts/bar
+  lastmod: 2021-10-20
+---
+# bar

Diff for: test/fixtures/content-v3/.nuxtrc

@@ -0,0 +1,9 @@
+---
+path: /blog/posts/fallback
+sitemap:
+  lastmod: 2021-10-20
+---
+
+# foo
+
+no sitemap config

Diff for: test/fixtures/content-v3/app.vue

@@ -0,0 +1,3 @@
+# foo
+
+no sitemap config

Diff for: test/fixtures/content-v3/content.config.ts

@@ -0,0 +1,36 @@
+import { createResolver } from '@nuxt/kit'
+import NuxtRobots from '../../../src/module'
+
+const resolver = createResolver(import.meta.url)
+
+const nuxtContent3Resolved = resolver.resolve('node_modules/@nuxt/content/dist/module.mjs')
+
+export default defineNuxtConfig({
+  modules: [
+    NuxtRobots,
+    nuxtContent3Resolved,
+    '@nuxt/content',
+  ],
+
+  content: {
+    build: {
+      markdown: {
+        remarkPlugins: {
+          // [resolver.resolve('remarkRobots.mjs')]: {},
+        },
+      },
+    },
+  },
+
+  site: {
+    url: 'https://nuxtseo.com',
+  },
+
+  alias: {
+    '@nuxt/content': nuxtContent3Resolved,
+    'remarkRobots': resolver.resolve('remarkRobots.ts'),
+  },
+
+  debug: process.env.NODE_ENV === 'test',
+  compatibilityDate: '2024-12-06',
+})

Diff for: test/fixtures/content-v3/content/_partial.md

@@ -0,0 +1,12 @@
+{
+  "private": "true",
+  "scripts": {
+    "dev": "nuxi dev"
+  },
+  "dependencies": {
+    "nuxt": "^3.5.3"
+  },
+  "devDependencies": {
+    "@nuxt/content": "3.0.0-alpha.9"
+  }
+}

Diff for: test/fixtures/content-v3/content/bar.md

@@ -0,0 +1,18 @@
+<script setup lang="ts">
+import { queryCollection, useRoute } from '#imports'
+
+const route = useRoute()
+const { data: page } = await useAsyncData(`page-${route.path}`, () => {
+  return queryCollection('content').path(route.path).first()
+})
+useSeoMeta(page.value.seo)
+</script>
+
+<template>
+  <div>
+    <ContentRenderer v-if="page" :value="page" />
+    <div v-else>
+      Page not found
+    </div>
+  </div>
+</template>

Diff for: test/fixtures/content-v3/content/foo.md

@@ -0,0 +1,12 @@
+import { visit } from 'unist-util-visit'
+import { parse } from 'yaml'
+
+// TODO experiment with remark plugins
+export default function remarkFrontmatterProcessor() {
+  return (tree) => {
+    visit(tree, 'yaml', (node) => {
+      parse(node.value)
+      // Process the frontmatter data here
+    })
+  }
+}

Diff for: test/fixtures/content-v3/content/index.md

@@ -5,7 +5,7 @@ import { describe, expect, it } from 'vitest'
 const { resolve } = createResolver(import.meta.url)
 
 await setup({
-  rootDir: resolve('./fixtures/content'),
+  rootDir: resolve('./fixtures/content-v2'),
 })
 describe('nuxt/content default', () => {
   it('basic', async () => {

Diff for: test/fixtures/content-v3/content/posts/bar.md

@@ -0,0 +1,29 @@
+import { createResolver } from '@nuxt/kit'
+import { $fetch, setup } from '@nuxt/test-utils'
+import { describe, expect, it } from 'vitest'
+
+const { resolve } = createResolver(import.meta.url)
+
+await setup({
+  rootDir: resolve('./fixtures/content-v3'),
+})
+describe('nuxt/content default', () => {
+  it('basic', async () => {
+    const barHtml = await $fetch('/bar')
+    // extract robots tag
+    expect(barHtml.match(/<meta name="robots" content="([^"]+)">/)).toMatchInlineSnapshot(`
+      [
+        "<meta name="robots" content="test">",
+        "test",
+      ]
+    `)
+
+    const fooHtml = await $fetch('/foo')
+    expect(fooHtml.match(/<meta name="robots" content="([^"]+)">/)).toMatchInlineSnapshot(`
+      [
+        "<meta name="robots" content="noindex, nofollow">",
+        "noindex, nofollow",
+      ]
+    `)
+  }, 60000)
+})