coralite-scripts 0.19.0 → 0.21.0

package/README.md

@@ -4,16 +4,6 @@ Welcome to **Coralite starter script**, a lightweight Static Site Generator (SSG
 
 ---
 
-## Prerequisites
-
-Ensure you have:
-- Node.js ≥ 20.x
-- npm or pnpm installed
-
-> Coralite uses experimental ES modules (`--experimental-vm-modules`) — make sure your Node version supports it.
-
----
-
 ## Project Structure
 
 Coralite expects a standard folder layout:

package/bin/index.js

@@ -1,15 +1,17 @@
-#!/usr/bin/env -S node --experimental-vm-modules --experimental-import-meta-resolve
+#!/usr/bin/env node
 
 import loadConfig from '../libs/load-config.js'
 import { Command, Argument } from 'commander'
 import server from '../libs/server.js'
 import colours from 'kleur'
-import buildHTML from '../libs/build-html.js'
-import pkg from '../package.json' with { type: 'json'}
+import pkg from '../package.json' with { type: 'json' }
 import buildSass from '../libs/build-sass.js'
-import { join } from 'node:path'
-import { deleteDirectoryRecursive, copyDirectory, toMS, toTime } from '../libs/build-utils.js'
+import { join, relative } from 'node:path'
+import { deleteDirectoryRecursive, copyDirectory, toMS, toTime, displayError } from '../libs/build-utils.js'
 import buildCSS from '../libs/build-css.js'
+import { Coralite } from 'coralite'
+import { mkdir, writeFile } from 'node:fs/promises'
+import ora from 'ora'
 
 // remove all Node warnings before doing anything else
 process.removeAllListeners('warning')
@@ -37,56 +39,117 @@ if (mode === 'dev') {
 } else if (mode === 'build') {
   const PAD = '  '
   const border = '─'.repeat(Math.min(process.stdout.columns, 36) / 2)
+  const dash = colours.gray(' ─ ')
+
+  if (options.verbose) {
+    // log the response time and status code
+    process.stdout.write('\n' + PAD + colours.yellow('Compiling Coralite... \n\n'))
+    process.stdout.write(border + colours.inverse(` LOGS `) + border + '\n\n')
+  } else {
+    process.stdout.write('\n' + PAD + colours.yellow('Compiling Coralite... \n\n'))
+  }
 
-  // log the response time and status code
-  process.stdout.write('\n' + PAD + colours.yellow('Compiling Coralite... \n\n'))
-  process.stdout.write(border + colours.inverse(` LOGS `) + border + '\n\n')
   // delete old output files
   deleteDirectoryRecursive(config.output)
 
   const start = process.hrtime()
-  const documents = await buildHTML(config)
-  const dash = colours.gray(' ─ ')
+  // start coralite
+  const coralite = new Coralite({
+    templates: config.templates,
+    pages: config.pages,
+    plugins: config.plugins
+  })
+  await coralite.initialise()
+
+  let spinner
+  let pageCount = 0
+
+  try {
+    if (!options.verbose) {
+      spinner = ora('Building pages...').start()
+    }
 
-  for (let i = 0; i < documents.length; i++) {
-    const document = documents[i]
+    // compile website
+    await coralite.build(async (result) => {
+      const relDir = relative(config.pages, result.path.dirname)
+      const outDir = join(config.output, relDir)
+      const outFile = join(outDir, result.path.filename)
 
-    process.stdout.write(toTime() + toMS(document.duration) + dash + document.item.path.pathname + '\n')
-  }
+      await mkdir(outDir, { recursive: true })
+      await writeFile(outFile, result.html)
 
-  const publicDir = config.public
+      if (options.verbose) {
+        process.stdout.write(toTime() + toMS(result.duration) + dash + result.path.pathname + '\n')
+      } else {
+        pageCount++
+        spinner.text = `Building pages... (${pageCount} completed)`
+      }
 
-  if (publicDir) {
-    copyDirectory(publicDir, config.output)
-  }
+      return outFile
+    })
 
-  if (config.styles) {
-    if (config.styles.type === 'sass' || config.styles.type === 'scss') {
-      const results = await buildSass({
-        input: config.styles.input,
-        output: join(config.output, 'css'),
-        options: config.sassOptions,
-        start
-      })
+    if (!options.verbose) {
+      spinner.succeed(`Pages built (${pageCount} completed)`)
+    }
 
-      for (let i = 0; i < results.length; i++) {
-        const result = results[i]
+    const publicDir = config.public
 
-        process.stdout.write(toTime() + toMS(result.duration) + dash + result.output + '\n')
+    if (publicDir) {
+      if (!options.verbose) {
+        spinner = ora('Copying public directory...').start()
       }
-    } else if (config.styles.type === 'css') {
-      const results = await buildCSS({
-        input: config.styles.input,
-        output: join(config.output, 'css'),
-        plugins: config.cssPlugins,
-        start
-      })
-
-      for (let i = 0; i < results.length; i++) {
-        const result = results[i]
-
-        process.stdout.write(toTime() + toMS(result.duration) + dash + result.output + '\n')
+      await copyDirectory(publicDir, config.output)
+      if (!options.verbose) {
+        spinner.succeed('Public directory copied')
       }
     }
+
+    if (config.styles) {
+      if (!options.verbose) {
+        spinner = ora('Building styles...').start()
+      }
+
+      if (config.styles.type === 'sass' || config.styles.type === 'scss') {
+        const results = await buildSass({
+          input: config.styles.input,
+          output: join(config.output, 'css'),
+          options: config.sassOptions,
+          start
+        })
+
+        for (let i = 0; i < results.length; i++) {
+          const result = results[i]
+
+          if (options.verbose) {
+            process.stdout.write(toTime() + toMS(result.duration) + dash + result.output + '\n')
+          }
+        }
+      } else if (config.styles.type === 'css') {
+        const results = await buildCSS({
+          input: config.styles.input,
+          output: join(config.output, 'css'),
+          plugins: config.cssPlugins,
+          start
+        })
+
+        for (let i = 0; i < results.length; i++) {
+          const result = results[i]
+
+          if (options.verbose) {
+            process.stdout.write(toTime() + toMS(result.duration) + dash + result.output + '\n')
+          }
+        }
+      }
+
+      if (!options.verbose) {
+        spinner.succeed('Styles built')
+      }
+    }
+  } catch (error) {
+    if (spinner) {
+      spinner.fail('Build failed')
+    }
+    displayError('Build failed', error)
+    process.exit(1)
   }
 }

package/libs/build-utils.js

@@ -1,6 +1,7 @@
 import colours from 'kleur'
 import fs from 'node:fs'
 import path from 'node:path'
+import { cp } from 'node:fs/promises'
 
 /**
  * Creates current time in format [HH:MM:SS].mmm (milliseconds), colored with ANSI colors, and formatted as bold white string for better readability of logs or console output
@@ -53,26 +54,8 @@ export function toCode (code) {
  * @param {string} src - The source directory path to copy from
  * @param {string} dest - The destination directory path to copy to
  */
-export function copyDirectory (src, dest) {
-  // Create destination directory if it doesn't exist
-  if (!fs.existsSync(dest)) {
-    fs.mkdirSync(dest, { recursive: true })
-  }
-
-  // Read source directory contents
-  const entries = fs.readdirSync(src)
-
-  for (const entry of entries) {
-    const srcPath = path.join(src, entry)
-    const destPath = path.join(dest, entry)
-
-    // Check if it's a file or directory and copy accordingly
-    if (fs.statSync(srcPath).isDirectory()) {
-      copyDirectory(srcPath, destPath) // Recursive call for subdirectories
-    } else {
-      fs.copyFileSync(srcPath, destPath) // Copy files
-    }
-  }
+export async function copyDirectory (src, dest) {
+  await cp(src, dest, { recursive: true })
 }
 
 /**

package/libs/server.js

@@ -4,7 +4,7 @@ import localAccess from 'local-access'
 import chokidar from 'chokidar'
 import buildSass from './build-sass.js'
 import { displayError, displayInfo, displaySuccess, toCode, toMS, toTime } from './build-utils.js'
-import { extname, join, normalize } from 'path'
+import { extname, join, normalize, relative, sep } from 'path'
 import { readFile, access, constants } from 'fs/promises'
 import Coralite from 'coralite'
 import buildCSS from './build-css.js'
@@ -28,6 +28,8 @@ async function server (config, options) {
 
     // track active connections.
     const clients = new Set()
+    const pageCache = new Map()
+    const memoryPageSource = new Map()
 
     // start coralite
     displayInfo('Initializing Coralite...')
@@ -165,6 +167,13 @@ async function server (config, options) {
           }
         }
 
+        const cacheKey = path.startsWith('/') ? path.slice(1) : path
+
+        if (pageCache.has(cacheKey)) {
+          res.send(pageCache.get(cacheKey))
+          return
+        }
+
         try {
           // first attempt to read the file directly.
           await access(path)
@@ -175,7 +184,7 @@ async function server (config, options) {
           if (!path.endsWith('.html')) {
             res.sendStatus(404)
           } else {
-            const pathname = join(config.pages, path)
+            let pathname = join(config.pages, path)
 
             try {
               // if that fails, try reading from pages directory.
@@ -183,31 +192,79 @@ async function server (config, options) {
               // check if page source file exists and is readable
               await access(pathname, constants.R_OK)
             } catch {
-              res.sendStatus(404)
+              // check if it is a known in memory page source
+              const cacheKey = path.startsWith('/') ? path.slice(1) : path
+              if (memoryPageSource.has(cacheKey)) {
+                pathname = memoryPageSource.get(cacheKey)
+              } else {
+                res.sendStatus(404)
+                return
+              }
             }
 
-            const start = process.hrtime()
-            let duration, dash = colours.gray(' ─ ')
-
-            await coralite.pages.setItem(pathname)
-            // build the HTML for this page using the built-in compiler.
-            const documents = await coralite.compile(pathname)
-            // inject a script to enable live reload via Server-Sent Events
-            const injectedHtml = documents[0].html.replace(/<\/body>/i, `\n
-  <script>
-    const eventSource = new EventSource('/_/rebuild');
-    eventSource.onmessage = function(event) {
-      if (event.data === 'connected') return;
-      // Reload page when file changes
-      location.reload()
-    }
-  </script>
-</body>`)
-
-            // prints time and path to the file that has been changed or added.
-            duration = process.hrtime(start)
-            process.stdout.write(toTime() + colours.bgGreen(' Compiled HTML ') + dash + toMS(duration) + dash + path + '\n')
-            res.send(injectedHtml)
+            try {
+              const start = process.hrtime()
+              let duration, dash = colours.gray(' ─ ')
+
+              let rebuildScript = '\n<script>\n'
+              rebuildScript += "    const eventSource = new EventSource('/_/rebuild');\n"
+              rebuildScript += '    eventSource.onmessage = function(event) {\n'
+              rebuildScript += "      if (event.data === 'connected') return;\n"
+              rebuildScript += '      // Reload page when file changes\n'
+              rebuildScript += '      location.reload()\n'
+              rebuildScript += '    }\n'
+              rebuildScript += '  </script>\n'
+              rebuildScript += '</body>\n'
+
+              await coralite.pages.setItem(pathname)
+              // build the HTML for this page using the built-in compiler.
+              const documents = await coralite.build(pathname, (result) => {
+                // inject a script to enable live reload via Server-Sent Events
+                const injectedHtml = result.html.replace(/<\/body>/i, rebuildScript)
+
+                const relPath = relative(config.pages, result.path.pathname)
+                const normalizedKey = relPath.split(sep).join('/')
+
+                // map in memory page to source
+                if (normalizedKey !== pathname) {
+                  memoryPageSource.set(normalizedKey, pathname)
+                }
+
+                // only cache pages that were out of scope of the initial page request
+                if (normalizedKey !== cacheKey) {
+                  pageCache.set(normalizedKey, injectedHtml)
+                }
+
+                return {
+                  path: result.path,
+                  html: injectedHtml,
+                  duration: result.duration
+                }
+              })
+
+              // prints time and path to the file that has been changed or added.
+              duration = process.hrtime(start)
+              process.stdout.write(toTime() + colours.bgGreen(' Compiled HTML ') + dash + toMS(duration) + dash + path + '\n')
+
+              // find the document that matches the request path
+              const doc = documents.find(doc => {
+                const relPath = relative(config.pages, doc.path.pathname)
+                const normalizedKey = relPath.split(sep).join('/')
+                return normalizedKey === cacheKey
+              })
+
+              if (doc) {
+                res.send(doc.html)
+              } else {
+                res.sendStatus(404)
+              }
+            } catch (error) {
+              // If headers haven't been sent, send 500
+              if (!res.headersSent) {
+                res.status(500).send(error.message)
+              }
+              displayError('Request processing failed', error)
+            }
           }
         }
       })
@@ -235,6 +292,8 @@ async function server (config, options) {
       compileTimeout = setTimeout(async () => {
         if (isCompiling || pendingChanges.size === 0) return
 
+        pageCache.clear()
+
         isCompiling = true
         const start = process.hrtime()
         let dash = colours.gray(' ─ ')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coralite-scripts",
-  "version": "0.19.0",
+  "version": "0.21.0",
   "description": "Configuration and scripts for Create Coralite.",
   "type": "module",
   "bin": {
@@ -53,10 +53,11 @@
     "express": "^5.1.0",
     "kleur": "^4.1.5",
     "local-access": "^1.1.0",
+    "ora": "^9.1.0",
     "portfinder": "^1.0.38",
     "postcss": "^8.5.6",
     "sass": "^1.91.0",
-    "coralite": "0.19.0"
+    "coralite": "0.21.0"
   },
   "scripts": {
     "build": "premove dist && pnpm build-types",