[CM2] Most basically introduce collection index

It's just a copy of how homepage works for the root. Cascade of content types
(collection -> category -> entry) is not implemented.

Author: scriptype

src/compiler/contentModel2/collection/contentTypes.js

@@ -1,4 +1,6 @@
 module.exports = {
+  COLLECTION_HOME: 'collectionHome',
+  FOLDERED_COLLECTION_HOME_INDEX: 'folderedCollectionHomeIndex',
   COLLECTION: 'collection',
   CATEGORY: 'category',
   CATEGORY_INDEX: 'categoryIndex',

src/compiler/contentModel2/collection/fsToContent.js

@@ -2,9 +2,14 @@ const { dirname } = require('path')
 const _ = require('lodash')
 const Dictionary = require('../../../dictionary')
 const { last } = require('../../../helpers')
-const contentTypes = require('./contentTypes')
 const { createLocalAsset } = require('../models/localAsset')
 
+const {
+  createCollectionHome,
+  createFolderedCollectionHome,
+  createFolderedCollectionHomeIndex
+} = require('./models/collectionHome')
+
 const {
   createCategory,
   createCategoryIndex
@@ -31,6 +36,14 @@ const isTemplateFile = (fsObject) => {
   return new RegExp(templateExtensions.join('|'), 'i').test(fsObject.extension)
 }
 
+const isCollectionHomeFile = (fsObject) => {
+  return isTemplateFile(fsObject) && fsObject.name.match(/^(index|home|collection)\..+$/)
+}
+
+const isCollectionHomeDirectory = (fsObject) => {
+  return fsObject.name.match(`^(index|home|collection)$`)
+}
+
 const isFolderedPostIndexFile = (fsObject) => {
   return isTemplateFile(fsObject) && fsObject.name.match(/^post\..+$/)
 }
@@ -85,6 +98,39 @@ const upsertEntry = ({
   }
 }
 
+const withCollectionHome = (contentModel, fsObject) => {
+  return newEntry({
+    contentModel,
+    key: 'index',
+    entryFn: () => createCollectionHome(fsObject).data,
+    replace: true
+  })
+}
+
+const withFolderedCollectionHome = (contentModel, fsObject) => {
+  return newEntry({
+    contentModel,
+    key: 'index',
+    entryFn: () => {
+      return createFolderedCollectionHome({
+        ...fsObject,
+        children: fsObject.children.map(mapFolderedCollectionHomeTree)
+      }).data
+    },
+    replace: true
+  })
+}
+
+const mapFolderedCollectionHomeTree = (fsObject) => {
+  if (isCollectionHomeFile(fsObject)) {
+    return createFolderedCollectionHomeIndex(fsObject)
+  }
+  return createLocalAsset({
+    ...fsObject,
+    isFolder: !!fsObject.children
+  })
+}
+
 const withLocalAsset = (contentModel, fsObject) => {
   return newEntry({
     contentModel,
@@ -190,6 +236,9 @@ const mapCategoryTree = (fsObject) => {
 
 const mapCollectionTree = (fsTree) => {
   return fsTree.reduce((contentModel, fsObject) => {
+    if (isCollectionHomeFile(fsObject)) {
+      return withCollectionHome(contentModel, fsObject)
+    }
     if (isTemplateFile(fsObject)) {
       return withDefaultCategory(
         withDefaultCategoryPost(contentModel, fsObject),
@@ -199,6 +248,9 @@ const mapCollectionTree = (fsTree) => {
     if (!fsObject.children) {
       return withLocalAsset(contentModel, fsObject)
     }
+    if (isCollectionHomeDirectory(fsObject)) {
+      return withFolderedCollectionHome(contentModel, fsObject)
+    }
     if (fsObject.children.some(isFolderedPostIndexFile)) {
       return withDefaultCategory(
         withFolderedPost(contentModel, fsObject),
@@ -207,6 +259,7 @@ const mapCollectionTree = (fsTree) => {
     }
     return withCategory(contentModel, fsObject)
   }, {
+    index: createCollectionHome({}).data,
     categories: [],
     posts: [],
     localAssets: [],

src/compiler/contentModel2/collection/models/collectionHome.js

@@ -0,0 +1,66 @@
+const _ = require('lodash')
+const Settings = require('../../../../settings')
+const { maybeRawHTMLType } = require('../../../../helpers')
+const contentTypes = require('../../contentTypes')
+const parseTemplate = require('../../parseTemplate')
+const { isLocalAsset } = require('../../models/localAsset')
+
+const DEFAULT_TYPE = 'basic'
+
+const isFolderedCollectionHomeIndex = (fsObject) => {
+  return fsObject.type === contentTypes.FOLDERED_COLLECTION_HOME_INDEX
+}
+
+const _createCollectionHome = (fsObject, { foldered }) => {
+  const indexFile = foldered ?
+    fsObject.children.find(isFolderedCollectionHomeIndex) :
+    fsObject
+
+  const localAssets = foldered ?
+    fsObject.children.filter(isLocalAsset) :
+    []
+
+  const permalink = Settings.getSettings().permalinkPrefix
+
+  const metadata = parseTemplate(indexFile, {
+    permalink,
+    localAssets
+  })
+
+  return {
+    ..._.omit(fsObject, 'children'),
+    type: contentTypes.COLLECTION_HOME,
+    data: {
+      type: metadata.type || maybeRawHTMLType(indexFile?.extension) || DEFAULT_TYPE,
+      title: metadata.title || '',
+      content: metadata.content || '',
+      mentions: metadata.mentions || [],
+      ...metadata.attributes,
+      foldered,
+      localAssets,
+      permalink
+    }
+  }
+}
+
+const createFolderedCollectionHomeIndex = (fsObject) => {
+  return {
+    ...fsObject,
+    type: contentTypes.FOLDERED_COLLECTION_HOME_INDEX
+  }
+}
+
+const createCollectionHome = (fsObject) => {
+  return _createCollectionHome(fsObject, { foldered: false })
+}
+
+const createFolderedCollectionHome = (fsObject) => {
+  return _createCollectionHome(fsObject, { foldered: true })
+}
+
+module.exports = {
+  createCollectionHome,
+  createFolderedCollectionHome,
+  isFolderedCollectionHomeIndex,
+  createFolderedCollectionHomeIndex
+}

src/tests/fixtures/contentModel2FSTree.json

@@ -7,6 +7,16 @@
     },
     "depth": 0,
     "children": [
+      {
+        "name": "collection.md",
+        "path": "Blog/collection.md",
+        "stats": {
+          "birthtime": "2025-03-01T03:38:49.442Z"
+        },
+        "depth": 1,
+        "extension": ".md",
+        "content": "---\ntitle: Blog\n---\nWelcome to my blog"
+      },
       {
         "name": "Türkçe",
         "path": "Blog/Türkçe",

src/tests/fixtures/contentModel2FSTreeWin32.json

@@ -7,6 +7,16 @@
     },
     "depth": 0,
     "children": [
+      {
+        "name": "collection.md",
+        "path": "Blog\\collection.md",
+        "stats": {
+          "birthtime": "2025-03-01T03:38:49.442Z"
+        },
+        "depth": 1,
+        "extension": ".md",
+        "content": "---\ntitle: Blog\n---\nWelcome to my blog"
+      },
       {
         "name": "Türkçe",
         "path": "Blog\\Türkçe",