[CM2] Build with CM2 + rendering2

scriptype · scriptype · commit 48eb114c1f56 · 2025-03-28T00:48:15.000+03:00
- Turn compiler into a class
- Inject dependencies into compiler based on the temporary compilerVersion setting
- Create a FileSystemParser class and put it under a /lib folder alongside a
  fileSystemHelpers module and delete the compiler/fileSystem. The
  FileSystemParser's settings and debugLog dependencies are also injected
  (tryin something...)
- Update fileSystem's tests to reflect the changes
- Fix forgotten category assumption in attachment permalink
- Fix various small mistakes
- Bring back support for foldered subpages
- Partial preferences when rendering pages should be contemplated more
- Should try a single rendering that works for all kinds of contentModels
diff --git a/src/compiler/contentModel2/index.js b/src/compiler/contentModel2/index.js
@@ -50,7 +50,7 @@ const root = (fsTree) => {
 
     if (isPagesDirectory(node)) {
       node.children.forEach(childNode => {
-        if (isTemplateFile(childNode) || childNode.children) {
+        if (isTemplateFile(childNode) || childNode.children?.find(isTemplateFile)) {
           contentModel.subpages.push(
             models.subpage(childNode)
           )
diff --git a/src/compiler/contentModel2/models/attachment.js b/src/compiler/contentModel2/models/attachment.js
@@ -8,7 +8,7 @@ function attachment(node, context) {
     settings.permalinkPrefix +
     [
       context.collection?.slug,
-      context.category?.isDefaultCategory ? '' : context.category.slug,
+      context.category?.isDefaultCategory ? '' : context.category?.slug,
       context.post?.slug,
       context.page?.slug,
       node.name
diff --git a/src/compiler/fileSystem.js b/src/compiler/fileSystem.js
diff --git a/src/compiler/index.js b/src/compiler/index.js
@@ -1,41 +1,21 @@
 const Debug = require('../debug')
-const Settings = require('../settings').getSettings()
-const FileSystem = require('./fileSystem')
-const ContentModel = require('./contentModel')
-const Rendering = require('./rendering')
 
-const compile2 = async () => {
-  const ContentModel2 = require('./contentModel2')
-  const Rendering2 = require('./rendering2')
-
-  const fileSystemTree = await FileSystem.exploreTree()
-  const contentModel = ContentModel2.create(fileSystemTree)
-
-  return {}
-
-  await Rendering2.render(contentModel)
-  Debug.timeEnd('compiler')
-  return {
-    fileSystemTree,
-    contentModel
+module.exports = class Compiler {
+  constructor({ fileSystemParser, contentModel, renderer }) {
+    this.fileSystemParser = fileSystemParser
+    this.contentModel = contentModel
+    this.renderer = renderer
   }
-}
 
-const compile = async () => {
-  Debug.timeStart('compiler')
-  if (Settings.compilerVersion === 2) {
-    return compile2()
+  async compile() {
+    Debug.timeStart('compiler')
+    const fileSystemTree = await this.fileSystemParser.parse()
+    const contentModel = this.contentModel.create(fileSystemTree)
+    await this.renderer.render(contentModel)
+    Debug.timeEnd('compiler')
+    return {
+      fileSystemTree,
+      contentModel
+    }
   }
-  const fileSystemTree = await FileSystem.exploreTree()
-  const contentModel = await ContentModel.create(fileSystemTree)
-  await Rendering.render(contentModel)
-  Debug.timeEnd('compiler')
-  return {
-    fileSystemTree,
-    contentModel
-  }
-}
-
-module.exports = {
-  compile
 }
diff --git a/src/compiler/rendering/index.js b/src/compiler/rendering/index.js
@@ -12,19 +12,21 @@ const Views = {
 }
 
 module.exports = {
-  async render(contentModel) {
+  async render(contentModelPromise) {
     await Renderer.init()
-    return Promise.all([
-      Views.renderHomepage(Renderer, contentModel),
-      Views.renderTags(Renderer, contentModel),
-      Views.renderSubpages(Renderer, contentModel),
-      Views.renderPostsJSON(contentModel),
-      Views.copyLocalAssets(contentModel),
-      Views.renderCategoryPages(Renderer, contentModel)
-        .then(() => Promise.all([
-          Views.renderPosts(Renderer, contentModel),
-          Views.renderFeeds(Renderer, contentModel)
-        ]))
-    ])
+    return contentModelPromise.then(contentModel => {
+      return Promise.all([
+        Views.renderHomepage(Renderer, contentModel),
+        Views.renderTags(Renderer, contentModel),
+        Views.renderSubpages(Renderer, contentModel),
+        Views.renderPostsJSON(contentModel),
+        Views.copyLocalAssets(contentModel),
+        Views.renderCategoryPages(Renderer, contentModel)
+          .then(() => Promise.all([
+            Views.renderPosts(Renderer, contentModel),
+            Views.renderFeeds(Renderer, contentModel)
+          ]))
+      ])
+    })
   }
 }
diff --git a/src/compiler/rendering2/views/collection/category.js b/src/compiler/rendering2/views/collection/category.js
@@ -20,7 +20,7 @@ const renderCategories = (Renderer, contentModel, collection) => {
         return Renderer.render({
           templates: [
             `pages/${category.template}`,
-            `pages/${category.contentType}`,
+            `pages/category/${category.contentType}`,
             `pages/category`
           ],
           outputPath,
diff --git a/src/compiler/rendering2/views/collection/index.js b/src/compiler/rendering2/views/collection/index.js
@@ -17,12 +17,12 @@ const renderCollections = async (Renderer, contentModel) => {
       page: collection,
       posts: collection.posts,
       postsPerPage: collection.postsPerPage || settings.postsPerPage,
-      outputDir: join(settings.out, collection.lug),
+      outputDir: join(settings.out, collection.slug),
       render: async ({ outputPath, pageOfPosts, paginationData }) => {
         return Renderer.render({
           templates: [
             `pages/${collection.template}`,
-            `pages/${collection.contentType}`,
+            `pages/collection/${collection.contentType}`,
             `pages/collection`
           ],
           outputPath,
diff --git a/src/compiler/rendering2/views/collection/post.js b/src/compiler/rendering2/views/collection/post.js
@@ -6,7 +6,7 @@ const renderPosts = (Renderer, contentModel, collection) => {
     const renderPage = Renderer.render({
       templates: [
         `pages/${post.template}`,
-        `pages/${post.contentType}`,
+        `pages/post/${post.contentType}`,
         `pages/post`
       ],
       outputPath: post.outputPath,
diff --git a/src/compiler/rendering2/views/collection/tags.js b/src/compiler/rendering2/views/collection/tags.js
@@ -23,9 +23,8 @@ const renderTagsPage = (Renderer, contentModel, collection) => {
 }
 
 const renderTagIndices = (Renderer, contentModel, collection) => {
-  const { tags } = collection.tags
   const settings = Settings.getSettings()
-  const compilation = tags.map(tag => {
+  const compilation = collection.tags.map(tag => {
     return paginate({
       page: tag,
       posts: tag.posts,
diff --git a/src/compiler/rendering2/views/homepage.js b/src/compiler/rendering2/views/homepage.js
@@ -7,7 +7,7 @@ const renderHomepage = async (Renderer, contentModel) => {
   const renderPage = Renderer.render({
     templates: [
       `pages/${homepage.template}`,
-      `pages/${homepage.contentType}`,
+      `pages/homepage/${homepage.contentType}`,
       `pages/homepage`
     ],
     outputPath: homepage.outputPath,
diff --git a/src/compiler/rendering2/views/subpage.js b/src/compiler/rendering2/views/subpage.js
@@ -6,7 +6,7 @@ const renderSubpages = (Renderer, contentModel) => {
     const renderPage = Renderer.render({
       templates: [
         `pages/${subpage.template}`,
-        `pages/${subpage.contentType}`,
+        `pages/subpage/${subpage.contentType}`,
         `pages/subpage`
       ],
       outputPath: subpage.outputPath,
diff --git a/src/lib/FileSystemParser.js b/src/lib/FileSystemParser.js
@@ -0,0 +1,103 @@
+const { stat, readdir } = require('fs/promises')
+const { join, relative, resolve, extname } = require('path')
+const { readFileContent, isDirectory } = require('./fileSystemHelpers')
+
+module.exports = class FileSystemParser {
+  static isTextFile(extension) {
+    const acceptedExtensions = [
+      'txt',
+      'md',
+      'markdown',
+      'hbs',
+      'handlebars',
+      'html',
+      'xhtml',
+      'htm',
+      'rtf',
+      'rtfd',
+      'json',
+      'srt'
+    ]
+    return new RegExp(`\.(${acceptedExtensions.join('|')})`, 'i').test(extension)
+  }
+
+  static lookBack(path, depth) {
+    return resolve(path, ...Array(depth).fill('..'))
+  }
+
+  static async contentRoot(rootDirectory, contentDirectory) {
+    if (!rootDirectory) {
+      throw new Error('rootDirectory is a required parameter')
+    }
+    try {
+      await stat(join(rootDirectory, contentDirectory))
+      return join(rootDirectory, contentDirectory)
+    } catch (ENOENT) {
+      return rootDirectory
+    }
+  }
+
+  constructor(fileSystemParserSettings, logger) {
+    this.rootDirectory = fileSystemParserSettings.rootDirectory
+    this.contentDirectory = fileSystemParserSettings.contentDirectory
+    this.ignorePattern = fileSystemParserSettings.IGNORE_PATHS_REG_EXP
+    this.logger = logger
+  }
+
+  shouldIncludePath(path) {
+    return (
+      !path.startsWith('_') &&
+      !path.startsWith('.') &&
+      !path.match(this.ignorePattern)
+    )
+  }
+
+  async parse() {
+    const root = await FileSystemParser.contentRoot(
+      this.rootDirectory,
+      this.contentDirectory
+    )
+    this.logger.debug('contentRoot', root)
+    return this._parse(root)
+  }
+
+  async _parse(path, depth = 0) {
+    this.logger.debug('exploring', path)
+    return Promise.all(
+      (await readdir(path))
+      .filter(this.shouldIncludePath.bind(this))
+      .map(async fileName => {
+        const accumulatedPath = join(path, fileName)
+        const rootPath = FileSystemParser.lookBack(accumulatedPath, depth + 1)
+        const { birthtime } = await stat(accumulatedPath)
+        const baseProperties = {
+          name: fileName,
+          path: relative(rootPath, accumulatedPath),
+          absolutePath: accumulatedPath,
+          stats: { birthtime },
+          depth,
+        }
+        if (await isDirectory(accumulatedPath)) {
+          return {
+            ...baseProperties,
+            children: await this._parse(accumulatedPath, depth + 1)
+          }
+        }
+        const extension = extname(fileName)
+        const fileProperties = {
+          ...baseProperties,
+          extension,
+        }
+        if (FileSystemParser.isTextFile(extension)) {
+          const content = await readFileContent(accumulatedPath)
+          return {
+            ...fileProperties,
+            content
+          }
+        } else {
+          return fileProperties
+        }
+      })
+    )
+  }
+}
diff --git a/src/lib/fileSystemHelpers.js b/src/lib/fileSystemHelpers.js
diff --git a/src/routines.js b/src/routines.js
diff --git a/src/tests/fileSystemParser.js b/src/tests/fileSystemParser.js

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ const root = (fsTree) => {`
`50`	`50`
`51`	`51`	`if (isPagesDirectory(node)) {`
`52`	`52`	`node.children.forEach(childNode => {`
`53`		`- if (isTemplateFile(childNode) \|\| childNode.children) {`
	`53`	`+ if (isTemplateFile(childNode) \|\| childNode.children?.find(isTemplateFile)) {`
`54`	`54`	`contentModel.subpages.push(`
`55`	`55`	`models.subpage(childNode)`
`56`	`56`	`)`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ function attachment(node, context) {`
`8`	`8`	`settings.permalinkPrefix +`
`9`	`9`	`[`
`10`	`10`	`context.collection?.slug,`
`11`		`- context.category?.isDefaultCategory ? '' : context.category.slug,`
	`11`	`+ context.category?.isDefaultCategory ? '' : context.category?.slug,`
`12`	`12`	`context.post?.slug,`
`13`	`13`	`context.page?.slug,`
`14`	`14`	`node.name`