通过 100 多个技巧学习 Nuxt！
55.5K

nuxt-feedme

用于 Nuxt Web 框架的 RSS Feed 模块，支持 ATOM、JSON 和 RSS
350 次下载
18 颗星
v1.0.0
helltraitorhelltraitor

nuxt-feedme

npm version npm downloads License Nuxt

该模块为实现 RSS Feed 提供了额外的功能。它与module-feed非常相似，但支持nuxt-content。

如果您需要完全自定义的 Feed，您可以自由选择任何 Feed 模块（这个或上面提到的）。但是这个模块可能更灵活。

特性

  • 为 nuxt-content 开箱即用配置
  • 支持两种 Feed 类型的通用和专用钩子
  • 灵活：使用配置默认值（feed，item），映射（item）或钩子进行自定义
  • 支持 SSR 和 SSG

为 nuxt-content 开箱即用配置

默认设置是

{
  feeds: {
    '/feed.atom': { revisit: '6h', type: 'atom1', content: true },
    '/feed.xml': { revisit: '6h', type: 'rss2', content: true },
    '/feed.json': { revisit: '6h', type: 'json1', content: true },
  },
  content: {
    item: {
      templateRoots: [true, 'feedme'],
    },
  },
}

通用和专用钩子

// project-name/server/plugins/feedme.ts
import type { NitroApp } from 'nitropack'

// Nitro hooks can be set only in nitro plugin
export default (nitroApp: NitroApp) => {
  // General hook: feedme:handle:content:item
  // Specialized hook: feedme:handle:content:item[*]
  //
  // When specialized hook set, general also will be called
  nitroApp.hooks.hook('feedme:handle:content:item[/contentDefaults.xml]', async ({ feed: { insert, invoke, parsed } }) => {
    if (parsed.title === 'First item') {
      // Invoke in case if item was created by another callback
      const maybeItemOptions = invoke()

      // Insert replaces current item configuration
      insert({
        ...maybeItemOptions,
        category: [
          ...maybeItemOptions?.category ?? [],
          { name: 'content hook processed' },
        ],
      })
    }
  })

  // Specialized hook for default feed
  nitroApp.hooks.hook('feedme:handle[/feed.xml]', async ({ context: { event }, feed: { create } }) => {
    // Create also replaces current feed
    create({ id: '', title: `Special feed for '${event.path}' route`, copyright: '' })
  })

  // General hook for default feed
  nitroApp.hooks.hook('feedme:handle', async ({ context: { event }, feed: { create, invoke } }) => {
    invoke() ?? create({ id: '', title: `Default feed for '${event.path}' route`, copyright: '' })
  })
}

映射配置

映射用于将 feed item 对象键链接到已解析内容中的路径

{
  item: {
    mapping: [
      // Third item is optional mapping function
      ['date', 'modified', value => value ? new Date(value) : value],
      // When mapping function result is undefined - next variant applied
      ['date', 'created', value => value ? new Date(value) : value],
      // Until the real one value will be set
      ['date', '', () => new Date()],
      // By default mapping is x => x
      ['link', '_path'],
    ],
    // Create default mappings with indicated roots:
    //   [keyof Item /* such as image, id, link */, root + keyof Item]
    //
    // The true value means use empty root:
    //   ['link', 'link']
    //
    // Where any other key means use this as path to value:
    //  ['link', `{root}.link`]
    //
    // Root can be separate by `.` which allows to deep invoking
    templateRoots: [true, 'feedme'],
  }
}

注意：日期值是 feed 模块的特例，因此默认情况下映射为日期字段提供以下映射：value => value ? new Date(value) : new Date() 因此，如果您为日期提供自己的别名 - 您需要提供映射函数

注意：映射函数被序列化，因此需要避免在外部作用域中有任何引用

标签

标签允许根据匹配替换节点值

{
  // Allows to pass optional map function
  tags: [
    // This tags replace first empty symbol if value starts with /
    // Example: /link -> urlBase/link
    [/^(?=\/)/, urlBase],
  ],
}

注意：标签递归应用，item.field.inner (value) 会受到影响

快速设置

  1. 将 nuxt-feedme 依赖项添加到您的项目中

使用您喜欢的包管理器（我更喜欢 yarn）

yarn add -D nuxt-feedme

pnpm add -D nuxt-feedme

npm install --save-dev nuxt-feedme
  1. 将 nuxt-feedme 添加到 nuxt.config.ts 的 modules 部分
export default defineNuxtConfig({
  modules: [
    // After nuxt content
    '@nuxt/content',
    'nuxt-feedme'
  ]
})

就是这样！您现在可以在您的 Nuxt 应用程序中使用 nuxt-feedme ✨