chore: add resolve resources function

package.json

@@ -35,15 +35,22 @@
     "prepack": "nuxt-module-build",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
-    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground"
+    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:coverage:serve": "yarn run test:coverage && yarn run serve -p 5000 ./coverage"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.0.0-rc.5"
+    "@nuxt/kit": "^3.0.0-rc.5",
+    "feed": "^4.2.2"
   },
   "devDependencies": {
     "@nuxt/module-builder": "latest",
     "@nuxtjs/eslint-config-typescript": "latest",
+    "c8": "^7.12.0",
     "eslint": "latest",
-    "nuxt": "^3.0.0-rc.5"
+    "nuxt": "^3.0.0-rc.5",
+    "vitest": "^0.18.1"
   }
 }

playground/nuxt.config.ts

@@ -5,5 +5,25 @@ export default defineNuxtConfig({
   modules: [
     FeedModule
   ],
-  feed: {}
+  feed: {
+    options: {
+      title: 'My blog',
+      description: 'This is my personal feed!'
+    },
+    create () {
+      console.log('common create function')
+    },
+    data: ['common data'],
+    sources: [
+      {
+        type: 'rss2',
+        path: '/feed.xml',
+        options: {},
+        create () {
+          console.log('source create function')
+        },
+        data: ['source data']
+      }
+    ]
+  }
 })

src/feed.ts

@@ -0,0 +1,24 @@
+import { Feed, FeedOptions } from 'feed'
+import type { ModuleOptions } from './module'
+
+export type FeedSource = {
+  type: 'atom1' | 'json1' | 'rss2'
+  path: string
+  options?: FeedOptions
+  create?(feed: Feed, data: FeedSource['data'], commonData: FeedSource['data']): void | Promise<void>
+  data?: any[]
+}
+
+export type FeedSourcesFactory = () => FeedSource[] | Promise<FeedSource[]>
+
+export async function resolveSources (sources: ModuleOptions['sources']): Promise<FeedSource[]> {
+  if (Array.isArray(sources)) {
+    return sources
+  }
+
+  if (typeof sources === 'function') {
+    return await sources()
+  }
+
+  throw new TypeError('`sources` option must be an array of feed sources or a function that returns it')
+}

src/module.ts

@@ -1,6 +1,13 @@
 import { defineNuxtModule } from '@nuxt/kit'
+import { resolveSources } from './feed'
+import type { FeedSource, FeedSourcesFactory } from './feed'
 
-export interface ModuleOptions {}
+export interface ModuleOptions {
+  options?: Partial<FeedSource['options']>
+  create?: FeedSource['create']
+  data?: FeedSource['data']
+  sources: FeedSource[] | FeedSourcesFactory
+}
 
 export default defineNuxtModule<ModuleOptions>({
   meta: {
@@ -10,6 +17,12 @@ export default defineNuxtModule<ModuleOptions>({
       nuxt: '^3.0.0'
     }
   },
-  defaults: {},
-  setup (options, nuxt) {}
+  defaults: {
+    sources: []
+  },
+  async setup (options, nuxt) {
+    console.log(options)
+    const sources = await resolveSources(options.sources)
+    console.log(sources)
+  }
 })

test/feed.test.ts

@@ -0,0 +1,36 @@
+import { expect, it, describe } from 'vitest'
+import { resolveSources } from '../src/feed'
+import type { FeedSource, FeedSourcesFactory } from '../src/feed'
+
+const sources: FeedSource[] = [
+  {
+    type: 'atom1',
+    path: '/feed.atom'
+  },
+  {
+    type: 'json1',
+    path: '/feed.json'
+  },
+  {
+    type: 'rss2',
+    path: '/feed.xml'
+  }
+]
+
+const sourcesFactory: FeedSourcesFactory = () => sources
+
+describe('feed', () => {
+  describe('resolveSources', () => {
+    it('should receive an array and is fulfilled with the received array', async () => {
+      expect(await resolveSources(sources)).toBe(sources)
+    })
+
+    it('should receive a function and is fulfilled with an array return by the function', async () => {
+      expect(await resolveSources(sourcesFactory)).toBe(sources)
+    })
+
+    it('should throw a type error if neither an array nor a function is passed', () => {
+      expect(resolveSources).rejects.toThrowError(/^`sources` option must be an array of feed sources or a function that returns it$/)
+    })
+  })
+})