wip: refactor to handle edge case for collection sources

larbish · larbish · commit b254bcc8dc91 · 2025-11-07T17:56:07.000+01:00
diff --git a/src/app/src/composables/useContext.ts b/src/app/src/composables/useContext.ts
@@ -20,7 +20,8 @@ import type { useTree } from './useTree'
 import type { useGit } from './useGit'
 import type { useDraftMedias } from './useDraftMedias'
 import { useRoute, useRouter } from 'vue-router'
-import { findDescendantsFileItemsFromFsPath, generateIdFromFsPath } from '../utils/tree'
+import { findDescendantsFileItemsFromFsPath } from '../utils/tree'
+import { generateIdFromFsPath } from '../utils/collection'
 import { joinURL } from 'ufo'
 import { upperFirst } from 'scule'
 import { generateStemFromFsPath } from '../utils/media'
diff --git a/src/app/src/composables/useTree.ts b/src/app/src/composables/useTree.ts
@@ -2,7 +2,8 @@ import { StudioFeature, TreeStatus, type StudioHost, type TreeItem, DraftStatus
 import { ref, computed } from 'vue'
 import type { useDraftDocuments } from './useDraftDocuments'
 import type { useDraftMedias } from './useDraftMedias'
-import { buildTree, findItemFromFsPath, findItemFromRoute, findParentFromFsPath, generateIdFromFsPath } from '../utils/tree'
+import { buildTree, findItemFromFsPath, findItemFromRoute, findParentFromFsPath } from '../utils/tree'
+import { generateIdFromFsPath } from '../utils/collection'
 import type { RouteLocationNormalized } from 'vue-router'
 import { useHooks } from './useHooks'
 import { useStudioState } from './useStudioState'
diff --git a/src/app/src/shared.ts b/src/app/src/shared.ts
@@ -1 +1,2 @@
 export { generateContentFromDocument, generateDocumentFromContent, removeReservedKeysFromDocument } from './utils/content'
+export { generateIdFromFsPath, parseSourceBase } from './utils/collection'
diff --git a/src/app/src/utils/collection.ts b/src/app/src/utils/collection.ts
@@ -0,0 +1,18 @@
+import type { CollectionSource, CollectionInfo } from '@nuxt/content'
+import { join } from 'pathe'
+
+export function parseSourceBase(source: CollectionSource) {
+  const [fixPart, ...rest] = source.include.includes('*') ? source.include.split('*') : ['', source.include]
+  return {
+    fixed: fixPart || '',
+    dynamic: '*' + rest.join('*'),
+  }
+}
+
+export function generateIdFromFsPath(path: string, collectionInfo: CollectionInfo) {
+  const { fixed } = parseSourceBase(collectionInfo.source[0]!)
+
+  const pathWithoutFixed = path.substring(fixed.length)
+
+  return join(collectionInfo.name, collectionInfo.source[0]?.prefix || '', pathWithoutFixed)
+}
diff --git a/src/app/src/utils/tree.ts b/src/app/src/utils/tree.ts
@@ -11,7 +11,6 @@ import type { BaseItem } from '../types/item'
 import { isEqual } from './database'
 import { studioFlags } from '../composables/useStudio'
 import { getFileExtension, parseName } from './file'
-import { joinURL } from 'ufo'
 
 export const COLOR_STATUS_MAP: { [key in TreeStatus]?: string } = {
   [TreeStatus.Created]: 'green',
@@ -173,10 +172,6 @@ TreeItem[] {
   return tree
 }
 
-export function generateIdFromFsPath(fsPath: string, collectionName: string): string {
-  return joinURL(collectionName, fsPath)
-}
-
 export function getTreeStatus(modified?: BaseItem, original?: BaseItem): TreeStatus {
   if (studioFlags.dev) {
     return TreeStatus.Opened
diff --git a/src/app/test/mocks/collection.ts b/src/app/test/mocks/collection.ts
@@ -0,0 +1,72 @@
+import type { CollectionInfo } from '@nuxt/content'
+
+export const collections: Record<string, CollectionInfo> = {
+  landing: {
+    name: 'landing',
+    pascalName: 'Landing',
+    tableName: '_content_landing',
+    source: [
+      {
+        _resolved: true,
+        prefix: '/',
+        cwd: '/Users/larbish/Documents/nuxt/modules/studio/playground/content',
+        include: 'index.md',
+      },
+    ],
+    type: 'page',
+    fields: {
+      id: 'string',
+      title: 'string',
+      body: 'json',
+      description: 'string',
+      extension: 'string',
+      meta: 'json',
+      navigation: 'json',
+      path: 'string',
+      seo: 'json',
+      stem: 'string',
+    },
+    schema: {
+      $schema: 'http://json-schema.org/draft-07/schema#',
+      $ref: '#/definitions/docs',
+      definitions: {},
+    },
+    tableDefinition: '',
+  },
+  docs: {
+    name: 'docs',
+    pascalName: 'Docs',
+    tableName: '_content_docs',
+    source: [
+      {
+        _resolved: true,
+        prefix: '/',
+        cwd: '/Users/larbish/Documents/nuxt/modules/studio/playground/content',
+        include: '**',
+        exclude: [
+          'index.md',
+        ],
+      },
+    ],
+    type: 'page',
+    fields: {
+      id: 'string',
+      title: 'string',
+      body: 'json',
+      description: 'string',
+      extension: 'string',
+      links: 'json',
+      meta: 'json',
+      navigation: 'json',
+      path: 'string',
+      seo: 'json',
+      stem: 'string',
+    },
+    schema: {
+      $schema: 'http://json-schema.org/draft-07/schema#',
+      $ref: '#/definitions/__SCHEMA__',
+      definitions: {},
+    },
+    tableDefinition: 'CREATE TABLE IF NOT EXISTS',
+  },
+}
diff --git a/src/app/test/unit/utils/collection.test.ts b/src/app/test/unit/utils/collection.test.ts
@@ -0,0 +1,81 @@
+import { describe, it, expect } from 'vitest'
+import { generateIdFromFsPath } from '../../../src/utils/collection'
+import type { CollectionInfo } from '@nuxt/content'
+import { collections } from '../../mocks/collection'
+
+describe('generateIdFromFsPath', () => {
+  it('should generate id for single file with no prefix', () => {
+    const path = 'index.md'
+    const result = generateIdFromFsPath(path, collections.landing!)
+    expect(result).toBe('landing/index.md')
+  })
+
+  it('should generate id for nested file with global pattern', () => {
+    const path = '1.getting-started/2.introduction.md'
+    const result = generateIdFromFsPath(path, collections.docs!)
+    expect(result).toBe('docs/1.getting-started/2.introduction.md')
+  })
+
+  it('should handle deeply nested paths', () => {
+    const path = '2.essentials/1.nested/3.components.md'
+    const result = generateIdFromFsPath(path, collections.docs!)
+    expect(result).toBe('docs/2.essentials/1.nested/3.components.md')
+  })
+
+  it('should handle collection with custom prefix', () => {
+    const customCollection: CollectionInfo = {
+      name: 'docs_en',
+      pascalName: 'DocsEn',
+      tableName: '_content_docs_en',
+      source: [
+        {
+          _resolved: true,
+          prefix: '/en',
+          cwd: '',
+          include: 'en/**/*',
+          exclude: ['en/index.md'],
+        },
+      ],
+      type: 'page',
+      fields: {},
+      schema: {
+        $schema: 'http://json-schema.org/draft-07/schema#',
+        $ref: '#/definitions/docs_en',
+        definitions: {},
+      },
+      tableDefinition: '',
+    }
+
+    const path = 'en/1.getting-started/2.introduction.md'
+    const result = generateIdFromFsPath(path, customCollection)
+    expect(result).toBe('docs_en/en/1.getting-started/2.introduction.md')
+  })
+
+  it('should handle empty prefix correctly', () => {
+    const customCollection: CollectionInfo = {
+      name: 'pages',
+      pascalName: 'Pages',
+      tableName: '_content_pages',
+      source: [
+        {
+          _resolved: true,
+          prefix: '',
+          cwd: '',
+          include: 'content/**/*.md',
+        },
+      ],
+      type: 'page',
+      fields: {},
+      schema: {
+        $schema: 'http://json-schema.org/draft-07/schema#',
+        $ref: '#/definitions/pages',
+        definitions: {},
+      },
+      tableDefinition: '',
+    }
+
+    const path = 'content/about.md'
+    const result = generateIdFromFsPath(path, customCollection)
+    expect(result).toBe('pages/about.md')
+  })
+})
diff --git a/src/app/test/unit/utils/tree.test.ts b/src/app/test/unit/utils/tree.test.ts
@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest'
-import { buildTree, findParentFromFsPath, findItemFromRoute, findItemFromFsPath, findDescendantsFileItemsFromFsPath, getTreeStatus, generateIdFromFsPath } from '../../../src/utils/tree'
+import { buildTree, findParentFromFsPath, findItemFromRoute, findItemFromFsPath, findDescendantsFileItemsFromFsPath, getTreeStatus } from '../../../src/utils/tree'
 import { tree } from '../../../test/mocks/tree'
 import type { TreeItem } from '../../../src/types/tree'
 import { dbItemsList, languagePrefixedDbItemsList, nestedDbItemsList } from '../../../test/mocks/database'
@@ -9,6 +9,7 @@ import { DraftStatus, TreeStatus, TreeRootId } from '../../../src/types'
 import type { RouteLocationNormalized } from 'vue-router'
 import type { DatabaseItem } from '../../../src/types/database'
 import { joinURL, withLeadingSlash } from 'ufo'
+import { generateIdFromFsPath } from '../../../src/utils/collection'
 
 describe('buildTree of documents with one level of depth', () => {
   // Result based on dbItemsList mock
diff --git a/src/module/src/runtime/host.ts b/src/module/src/runtime/host.ts
@@ -2,11 +2,11 @@ import { ref } from 'vue'
 import { ensure } from './utils/ensure'
 import type { CollectionItemBase, CollectionSource, DatabaseAdapter } from '@nuxt/content'
 import type { ContentDatabaseAdapter } from '../types/content'
-import { getCollectionByFilePath, generateIdFromFsPath, createCollectionDocument, generateRecordDeletion, generateRecordInsert, getCollectionInfo, normalizeDocument } from './utils/collection'
+import { getCollectionByFilePath, createCollectionDocument, generateRecordDeletion, generateRecordInsert, getCollectionInfo, normalizeDocument } from './utils/collection'
 import { kebabCase } from 'scule'
 import type { StudioHost, StudioUser, DatabaseItem, MediaItem, Repository } from 'nuxt-studio/app'
 import type { RouteLocationNormalized, Router } from 'vue-router'
-import { generateDocumentFromContent } from 'nuxt-studio/app/utils'
+import { generateDocumentFromContent, generateIdFromFsPath } from 'nuxt-studio/app/utils'
 // @ts-expect-error queryCollection is not defined in .nuxt/imports.d.ts
 import { clearError, getAppManifest, queryCollection, queryCollectionItemSurroundings, queryCollectionNavigation, queryCollectionSearchSections } from '#imports'
 import { collections } from '#content/preview'
diff --git a/src/module/test/utils/collection.test.ts b/src/module/test/utils/collection.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`export { generateContentFromDocument, generateDocumentFromContent, removeReservedKeysFromDocument } from './utils/content'`
	`2`	`+export { generateIdFromFsPath, parseSourceBase } from './utils/collection'`