!refactor: simplify source definition

Author: farnabaz

playground/content.config.ts

@@ -3,8 +3,8 @@ import { defineCollection, z } from '@nuxt/content'
 const content = defineCollection({
   type: 'page',
   source: {
-    path: '**',
-    ignore: [
+    include: '**',
+    exclude: [
       'data/**',
       'pages/**',
     ],
@@ -50,9 +50,9 @@ export const collections = {
     type: 'page',
     source: {
       repository: 'https://github.com/nuxt/content',
-      path: 'docs/content/**',
+      include: 'docs/content/**',
       prefix: '/content-v2',
-      ignore: [
+      exclude: [
         '**/_dir.yml',
       ],
     },
@@ -61,9 +61,9 @@ export const collections = {
     type: 'page',
     source: {
       repository: 'https://github.com/nuxt/nuxt',
-      path: 'docs/**',
+      include: 'docs/**',
       prefix: '/nuxt',
-      ignore: [
+      exclude: [
         '**/_dir.yml',
       ],
     },
@@ -72,7 +72,7 @@ export const collections = {
     type: 'page',
     source: {
       repository: 'https://github.com/vuejs/docs',
-      path: 'src/**/*.md',
+      include: 'src/**/*.md',
       prefix: '/vue',
     },
   }),

src/module.ts

@@ -17,7 +17,7 @@ import { join, dirname, isAbsolute } from 'pathe'
 import fastGlob from 'fast-glob'
 import htmlTags from '@nuxtjs/mdc/runtime/parser/utils/html-tags-list'
 import { kebabCase, pascalCase } from 'scule'
-import { generateCollectionInsert, generateCollectionTableDefinition, parseSourceBase } from './utils/collection'
+import { generateCollectionInsert, generateCollectionTableDefinition } from './utils/collection'
 import { collectionsTemplate, componentsManifestTemplate, contentTypesTemplate, fullDatabaseRawDumpTemplate, manifestTemplate, moduleTemplates } from './utils/templates'
 import type { ResolvedCollection } from './types/collection'
 import type { ModuleOptions, SqliteDatabaseConfig } from './types/module'
@@ -239,10 +239,8 @@ async function processCollectionItems(nuxt: Nuxt, collections: ResolvedCollectio
       await collection.source.prepare(nuxt)
     }
 
-    const { fixed, dynamic } = parseSourceBase(collection.source)
-    const cwd = join(collection.source.cwd, fixed)
-
-    const _keys = await fastGlob(dynamic, { cwd, ignore: collection.source!.ignore || [], dot: true })
+    const cwd = collection.source.cwd
+    const _keys = await fastGlob(collection.source.include, { cwd, ignore: collection.source!.exclude || [], dot: true })
       .catch(() => [])
 
     filesCount += _keys.length

src/types/collection.ts

@@ -9,11 +9,11 @@ export interface Collections {}
 export type CollectionType = 'page' | 'data'
 
 export type CollectionSource = {
+  include: string
+  prefix?: string
+  exclude?: string[]
   repository?: string
   cwd?: string
-  path: string
-  prefix?: string
-  ignore?: string[]
 }
 
 export interface ResolvedCollectionSource extends CollectionSource {

src/utils/collection.ts

@@ -71,7 +71,7 @@ function resolveSource(source: string | CollectionSource | undefined): ResolvedC
   }
 
   if (typeof source === 'string') {
-    return defineLocalSource({ path: source })
+    return defineLocalSource({ include: source })
   }
 
   if ((source as ResolvedCollectionSource)._resolved) {
@@ -85,14 +85,6 @@ function resolveSource(source: string | CollectionSource | undefined): ResolvedC
   return defineLocalSource(source)
 }
 
-export function parseSourceBase(source: CollectionSource) {
-  const [fixPart, ...rest] = source.path.includes('*') ? source.path.split('*') : ['', source.path]
-  return {
-    fixed: fixPart || '',
-    dynamic: '*' + rest.join('*'),
-  }
-}
-
 // Convert collection data to SQL insert statement
 export function generateCollectionInsert(collection: ResolvedCollection, data: Record<string, unknown>) {
   const fields: string[] = []
@@ -103,7 +95,7 @@ export function generateCollectionInsert(collection: ResolvedCollection, data: R
     const value = (collection.extendedSchema).shape[key]
     const underlyingType = getUnderlyingType(value as ZodType<unknown, ZodOptionalDef>)
 
-    let defaultValue = value._def.defaultValue ? value._def.defaultValue() : 'NULL'
+    let defaultValue = value?._def.defaultValue ? value?._def.defaultValue() : 'NULL'
 
     if (!(defaultValue instanceof Date) && typeof defaultValue === 'object') {
       defaultValue = JSON.stringify(defaultValue)
@@ -138,7 +130,7 @@ export function generateCollectionInsert(collection: ResolvedCollection, data: R
 export function generateCollectionTableDefinition(collection: ResolvedCollection, opts: { drop?: boolean } = {}) {
   const sortedKeys = Object.keys((collection.extendedSchema).shape).sort()
   const sqlFields = sortedKeys.map((key) => {
-    const type = (collection.extendedSchema).shape[key]
+    const type = (collection.extendedSchema).shape[key]!
     const underlyingType = getUnderlyingType(type)
 
     if (key === '_id') return `${key} TEXT PRIMARY KEY`

src/utils/config.ts

@@ -10,7 +10,7 @@ const defaultConfig = {
   collections: {
     content: defineCollection({
       type: 'page',
-      source: '**/*.md',
+      source: '**/*',
     }),
   },
 }

src/utils/source.ts

@@ -1,14 +1,20 @@
 import { join } from 'pathe'
+import { withLeadingSlash, withoutTrailingSlash } from 'ufo'
 import type { CollectionSource, ResolvedCollectionSource } from '../types/collection'
 import { downloadRepository, parseGitHubUrl } from './git'
 
 export function defineLocalSource(source: CollectionSource): ResolvedCollectionSource {
+  const { fixed, dynamic } = parseSourceBase(source)
   const resolvedSource: ResolvedCollectionSource = {
     _resolved: true,
+    prefix: withoutTrailingSlash(withLeadingSlash(fixed)),
     ...source,
-    cwd: '',
+    include: dynamic,
+    cwd: withoutTrailingSlash(join('~~/content/', fixed)),
     prepare: async (nuxt) => {
-      resolvedSource.cwd = source.cwd || join(nuxt.options.rootDir, 'content')
+      resolvedSource.cwd = source.cwd
+        ? String(source.cwd).replace(/^~~\//, nuxt.options.rootDir)
+        : join(nuxt.options.rootDir, 'content', fixed)
     },
   }
   return resolvedSource
@@ -34,3 +40,11 @@ export function defineGitHubSource(source: CollectionSource): ResolvedCollection
   }
   return resolvedSource
 }
+
+export function parseSourceBase(source: CollectionSource) {
+  const [fixPart, ...rest] = source.include.includes('*') ? source.include.split('*') : ['', source.include]
+  return {
+    fixed: fixPart || '',
+    dynamic: '*' + rest.join('*'),
+  }
+}

test/base.test.ts

@@ -42,7 +42,7 @@ describe('empty', async () => {
       expect(pagesCollection).toBeDefined()
       expect(pagesCollection?.type).toBe('page')
       expect(pagesCollection?.source).toBeDefined()
-      expect(pagesCollection?.source?.path).toBe('**/*.md')
+      expect(pagesCollection?.source?.include).toBe('**/*')
     })
   })
 

test/unit/defineCollection.test.ts

@@ -19,8 +19,8 @@ describe('defineCollection', () => {
       type: 'page',
       source: {
         _resolved: true,
-        cwd: '',
-        path: 'pages/**',
+        include: '**',
+        cwd: '~~/content/pages',
       },
     })
 
@@ -50,9 +50,9 @@ describe('defineCollection', () => {
     const collection = defineCollection({
       type: 'page',
       source: {
-        path: 'pages/**',
+        include: 'pages/**',
         prefix: 'blog',
-        ignore: ['pages/blog/index.md'],
+        exclude: ['pages/blog/index.md'],
       },
       schema: z.object({
         customField: z.string(),
@@ -62,9 +62,10 @@ describe('defineCollection', () => {
     expect(collection).toMatchObject({
       type: 'page',
       source: {
-        path: 'pages/**',
+        include: '**',
         prefix: 'blog',
-        ignore: ['pages/blog/index.md'],
+        exclude: ['pages/blog/index.md'],
+        cwd: '~~/content/pages',
       },
     })
 
@@ -87,8 +88,8 @@ describe('defineCollection', () => {
       type: 'data',
       source: {
         _resolved: true,
-        cwd: '',
-        path: 'data/**',
+        include: '**',
+        cwd: '~~/content/data',
       },
     })
 
@@ -103,9 +104,9 @@ describe('defineCollection', () => {
     const collection = defineCollection({
       type: 'data',
       source: {
-        path: 'data/**',
+        include: 'data/**',
         prefix: 'blog',
-        ignore: ['data/blog/index.md'],
+        exclude: ['data/blog/index.md'],
       },
       schema: z.object({
         customField: z.string(),
@@ -115,9 +116,10 @@ describe('defineCollection', () => {
     expect(collection).toMatchObject({
       type: 'data',
       source: {
-        path: 'data/**',
+        include: '**',
+        cwd: '~~/content/data',
         prefix: 'blog',
-        ignore: ['data/blog/index.md'],
+        exclude: ['data/blog/index.md'],
       },
     })
   })