[CM2] A collection can render at the root if empty slug

If 'slug:' is added to its frontMatter, its permalink and outputPath will collapse into those of its parent context.

When the parent permalink is just '/', child permalinks would break. So, a simple makePermalink helper is used to encapsulate dealing with this case. This helper is used in all models, with the idea of turning any page into a homepage by using the slug: technique. But this is not implemented in models beyond collection, as it'd take more (and ugly) work.

If turning any entry or index page into a homepage using the slug technique worked easily, it could work behind the scenes of a 'homepage' frontMatter property. But maybe later.

Anyway, rendering a collection in the root is especially helpful for sites with just one collection. The url scheme will work just like it did with CM1.

Author: scriptype

src/compiler/contentModel2/helpers.js

@@ -27,6 +27,13 @@ const parseArray = (array = []) => {
     array
 }
 
+const makePermalink = (...parts) => {
+  if (parts[0] === '/') {
+    return parts[0] + parts.slice(1).join('/')
+  }
+  return parts.join('/')
+}
+
 const Markdown = {
   parse(text) {
     return Markdown.unescapeHandlebarsExpressions(
@@ -52,5 +59,6 @@ module.exports = {
   isTemplateFile,
   removeExtension,
   parseArray,
+  makePermalink,
   Markdown
 }

src/compiler/contentModel2/index.js

@@ -223,12 +223,14 @@ class ContentModel {
       )
     }
 
-    return Promise.all([
-      renderHomepage(),
-      renderCollections(),
-      renderSubpages(),
-      renderAssets()
-    ])
+    return renderHomepage()
+      .then(() =>
+        Promise.all([
+          renderCollections(),
+          renderSubpages(),
+          renderAssets()
+        ])
+      )
   }
 }
 

src/compiler/contentModel2/models/asset.js

@@ -1,4 +1,5 @@
 const { join, resolve } = require('path')
+const { makePermalink } = require('../helpers')
 
 const defaultSettings = {
   assetsDirectory: 'assets'
@@ -20,9 +21,10 @@ module.exports = function Asset(settings = defaultSettings) {
     matchAssetsDirectory: isAssetsDirectory,
 
     create: (node, context) => {
-      const permalink = (
-        context.peek().permalink +
-        [settings.assetsDirectory, node.name].join('/')
+      const permalink = makePermalink(
+        context.peek().permalink,
+        settings.assetsDirectory,
+        node.name
       )
 
       const outputPath = join(

src/compiler/contentModel2/models/attachment.js

@@ -1,15 +1,18 @@
 const { join } = require('path')
 const _ = require('lodash')
+const { makePermalink } = require('../helpers')
 
 module.exports = function Attachment() {
   return {
     match: node => true,
 
     create(node, context) {
-      const permalink = _.compact([
-        context.peek()?.permalink,
-        node.name
-      ]).join('/')
+      const permalink = makePermalink(
+        ..._.compact([
+          context.peek()?.permalink,
+          node.name
+        ])
+      )
 
       const outputPath = join(
         ..._.compact([

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

@@ -1,7 +1,7 @@
 const { join } = require('path')
 const frontMatter = require('front-matter')
 const makeSlug = require('slug')
-const { isTemplateFile, Markdown } = require('../../helpers')
+const { isTemplateFile, Markdown, makePermalink } = require('../../helpers')
 const models = {
   post: require('./post'),
   attachment: require('../attachment')
@@ -78,7 +78,7 @@ module.exports = function Category(settings = defaultSettings, level = 1) {
           contentRaw: '',
           slug,
           title,
-          permalink: [context.peek().permalink, slug].join('/'),
+          permalink: makePermalink(context.peek().permalink, slug),
           outputPath: join(context.peek().outputPath, slug),
           isDefaultCategory: true,
           posts: [],
@@ -103,7 +103,7 @@ module.exports = function Category(settings = defaultSettings, level = 1) {
       const indexProps = indexFile ? frontMatter(indexFile.content) : {}
 
       const slug = indexProps.attributes?.slug || makeSlug(node.name)
-      const permalink = [context.peek().permalink, slug].join('/')
+      const permalink = makePermalink(context.peek().permalink, slug)
       const outputPath = join(context.peek().outputPath, slug)
 
       const categoryContext = {

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

@@ -2,7 +2,12 @@ const { join, resolve } = require('path')
 const _ = require('lodash')
 const frontMatter = require('front-matter')
 const makeSlug = require('slug')
-const { isTemplateFile, removeExtension, Markdown } = require('../../helpers')
+const {
+  isTemplateFile,
+  removeExtension,
+  makePermalink,
+  Markdown
+} = require('../../helpers')
 const models = {
   attachment: require('../attachment'),
   category: require('./category'),
@@ -96,8 +101,10 @@ module.exports = function Collection(settings = defaultSettings, contentTypes =
         .filter(ct => ct.model === 'collection')
         .find(ct => ct.collectionAlias === indexFileName)
 
-      const slug = indexProps.attributes?.slug || makeSlug(node.name)
-      const permalink = context.peek().permalink + slug
+      const slug = indexProps.attributes?.slug === null ?
+        '' :
+        indexProps.attributes?.slug || makeSlug(node.name)
+      const permalink = makePermalink(context.peek().permalink, slug)
       const outputPath = join(context.peek().outputPath, slug)
       const collectionContext = {
         ...indexProps.attributes,

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

@@ -1,5 +1,5 @@
 const { join } = require('path')
-const { isTemplateFile, parseArray } = require('../../helpers')
+const { isTemplateFile, parseArray, makePermalink } = require('../../helpers')
 const models = {
   _baseEntry: require('../_baseEntry'),
   attachment: require('../attachment'),
@@ -29,10 +29,10 @@ module.exports = function Post(settings = defaultSettings) {
     create: (node, context) => {
       const baseEntryProps = models._baseEntry(node, indexFileNameOptions)
 
-      const permalink = [
+      const permalink = makePermalink(
         context.peek().permalink,
         baseEntryProps.slug
-      ].join('/') + (node.children ? '' : '.html')
+      ) + (node.children ? '' : '.html')
 
       const outputPath = join(context.peek().outputPath, baseEntryProps.slug)
 

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

@@ -1,11 +1,12 @@
 const { join } = require('path')
 const makeSlug = require('slug')
+const { makePermalink } = require('../../helpers')
 
 module.exports = function Tag() {
   return {
     create: (name, context) => {
       const slug = makeSlug(name)
-      const permalink = [context.peek().permalink, 'tags', slug].join('/')
+      const permalink = makePermalink(context.peek().permalink, 'tags', slug)
       const outputPath = join(context.peek().outputPath, 'tags', slug)
       return {
         name,

src/compiler/contentModel2/models/subpage.js

@@ -1,5 +1,5 @@
 const { join, resolve } = require('path')
-const { isTemplateFile } = require('../helpers')
+const { isTemplateFile, makePermalink } = require('../helpers')
 const models = {
   _baseEntry: require('./_baseEntry'),
   attachment: require('./attachment'),
@@ -41,11 +41,10 @@ module.exports = function Subpage(settings = defaultSettings) {
     create: (node, context) => {
       const baseEntryProps = models._baseEntry(node, indexFileNameOptions)
 
-      const permalink = (
-        context.peek().permalink +
-        baseEntryProps.slug +
-        (baseEntryProps.hasIndex ? '' : '.html')
-      )
+      const permalink = makePermalink(
+        context.peek().permalink,
+        baseEntryProps.slug
+      ) + (baseEntryProps.hasIndex ? '' : '.html')
 
       const outputPath = join(
         context.peek().outputPath,