coralite-scripts 0.23.0 → 0.25.0

package/bin/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --experimental-vm-modules --experimental-import-meta-resolve
 
 import loadConfig from '../libs/load-config.js'
 import { Command, Argument } from 'commander'
@@ -34,6 +34,10 @@ const options = program.opts()
 const mode = program.args[0]
 const config = await loadConfig()
 
+if (!config) {
+  process.exit(1)
+}
+
 if (mode === 'dev') {
   await server(config, options)
 } else if (mode === 'build') {

package/dist/types/index.d.ts

@@ -23,6 +23,10 @@ export type CoraliteScriptBaseConfig = {
      * - Postcss plugins.
      */
     cssPlugins?: import("postcss").AcceptedPlugin[];
+    /**
+     * - Set build mode for the coralite instance.
+     */
+    mode?: "production" | "development";
 };
 export type CoraliteScriptConfig = CoraliteScriptBaseConfig & CoraliteConfig;
 export type CoraliteScriptOptions = {

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../types/index.js"],"names":[],"mappings":";;;;;;YAOc,MAAM;;;;aAEjB;QAA0B,IAAI,EAAnB,MAAM;KACjB;aACA;QAA2C,IAAI,EAApC,KAAK,GAAG,MAAM,GAAG,MAAM;QACR,KAAK,EAApB,MAAM;KACjB;;;;kBAAW,QAAQ,OAAO,CAAC;;;;iBAChB,OAAO,SAAS,EAAE,cAAc,EAAE;;mCAInC,wBAAwB,GAAG,cAAc;;;;;UAKxC,OAAO;;;;YACP,OAAO;;;;cACP,OAAO;;6BAvBK,MAAM;oCADC,gBAAgB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../types/index.js"],"names":[],"mappings":";;;;;;YAOc,MAAM;;;;aAEjB;QAA0B,IAAI,EAAnB,MAAM;KACjB;aACA;QAA2C,IAAI,EAApC,KAAK,GAAG,MAAM,GAAG,MAAM;QACR,KAAK,EAApB,MAAM;KACjB;;;;kBAAW,QAAQ,OAAO,CAAC;;;;iBAChB,OAAO,SAAS,EAAE,cAAc,EAAE;;;;WAClC,YAAY,GAAG,aAAa;;mCAI7B,wBAAwB,GAAG,cAAc;;;;;UAKxC,OAAO;;;;YACP,OAAO;;;;cACP,OAAO;;6BAxBK,MAAM;oCADC,gBAAgB"}

package/libs/load-config.js

@@ -1,6 +1,8 @@
 import { join } from 'path'
 import { access } from 'fs/promises'
 import { pathToFileURL } from 'url'
+import { displayError } from './build-utils.js'
+import { defineConfig } from './config.js'
 
 /**
  * @import {CoraliteScriptConfig} from '../types/index.js'
@@ -9,7 +11,7 @@ import { pathToFileURL } from 'url'
 /**
  * Loads the configuration for the Coralite project.
  *
- * @returns {Promise<CoraliteScriptConfig>} The configuration object containing path settings or an empty promise if no config found
+ * @returns {Promise<CoraliteScriptConfig|null>} The configuration object containing path settings or null if no config found or invalid
  *
  * @example
  * ```js
@@ -23,18 +25,33 @@ async function loadConfig () {
 
   try {
     await access(configPath)
+  } catch (error) {
+    if (error.code === 'ENOENT') {
+      displayError('Configuration file not found', `Could not find coralite.config.js at ${configPath}`)
+      return null
+    }
+    displayError('Failed to access configuration file', error)
+    return null
+  }
 
+  try {
     const config = await import(configPath.toString())
 
-    if (config.default) {
-      return config.default
+    if (!config.default) {
+      displayError('Config file must export a default object')
+      return null
+    }
+
+    try {
+      return defineConfig(config.default)
+    } catch (err) {
+      displayError('Invalid configuration', err.message)
+      return null
     }
   } catch (error) {
-    console.error('Failed to load configuration file:', configPath)
-    console.error(error)
+    displayError('Failed to load configuration file', error)
+    return null
   }
-
-  return null
 }
 
 export default loadConfig

package/libs/server.js

@@ -36,7 +36,8 @@ async function server (config, options) {
     const coralite = new Coralite({
       templates: config.templates,
       pages: config.pages,
-      plugins: config.plugins
+      plugins: config.plugins,
+      mode: 'development'
     })
     await coralite.initialise()
     displaySuccess('Coralite initialized successfully')
@@ -156,21 +157,83 @@ async function server (config, options) {
       })
       .get(/(.*)/, async (req, res) => {
         // extract the requested path and its extension.
-        let path = req.path
-        const extension = extname(path)
-
-        // if no extension is present, assume it's a HTML file and append '.html'.
-        if (!extension) {
-          if ('/' === path) {
-            path = 'index.html'
-          } else if (path.endsWith('/')) {
-            path = path.slice(0, path.length - 1) + '.html'
+        const reqPath = req.path
+        const extension = extname(reqPath)
+
+        // Only handle HTML requests or extension-less requests (assumed to be pages)
+        if (extension && extension !== '.html') {
+          return res.sendStatus(404)
+        }
+
+        const resolveSource = async () => {
+          const candidates = []
+
+          // Ensure relative path doesn't start with / for joining
+          const relPath = reqPath.startsWith('/') ? reqPath.slice(1) : reqPath
+
+          if (reqPath.endsWith('/')) {
+            const key = join(relPath, 'index.html')
+            candidates.push({
+              path: join(config.pages, key),
+              key
+            })
+          } else if (extension === '.html') {
+            const key = relPath
+            candidates.push({
+              path: join(config.pages, key),
+              key
+            })
           } else {
-            path += '.html'
+            // No extension, no trailing slash
+            const key1 = relPath + '.html'
+            candidates.push({
+              path: join(config.pages, key1),
+              key: key1
+            })
+
+            const key2 = join(relPath, 'index.html')
+            candidates.push({
+              path: join(config.pages, key2),
+              key: key2
+            })
           }
+
+          for (const candidate of candidates) {
+            try {
+              await access(candidate.path, constants.R_OK)
+              // Normalize key for consistency (use forward slashes)
+              const normalizedKey = candidate.key.split(sep).join('/')
+              return {
+                pathname: candidate.path,
+                key: normalizedKey
+              }
+            } catch {
+              // continue
+            }
+          }
+
+          // Fallback check memoryPageSource
+          for (const candidate of candidates) {
+            const normalizedKey = candidate.key.split(sep).join('/')
+            if (memoryPageSource.has(normalizedKey)) {
+              return {
+                pathname: memoryPageSource.get(normalizedKey),
+                key: normalizedKey
+              }
+            }
+          }
+
+          return null
         }
 
-        const cacheKey = path.startsWith('/') ? path.slice(1) : path
+        const result = await resolveSource()
+
+        if (!result) {
+          res.sendStatus(404)
+          return
+        }
+
+        const { pathname, key: cacheKey } = result
 
         if (pageCache.has(cacheKey)) {
           res.send(pageCache.get(cacheKey))
@@ -178,99 +241,70 @@ async function server (config, options) {
         }
 
         try {
-          // first attempt to read the file directly.
-          await access(path)
-          const data = await readFile(path, 'utf8')
-
-          res.send(data)
-        } catch {
-          if (!path.endsWith('.html')) {
-            res.sendStatus(404)
-          } else {
-            let pathname = join(config.pages, path)
-
-            try {
-              // if that fails, try reading from pages directory.
+          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)
+            }
 
-              // check if page source file exists and is readable
-              await access(pathname, constants.R_OK)
-            } catch {
-              // 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
-              }
+            // only cache pages that were out of scope of the initial page request
+            if (normalizedKey !== cacheKey) {
+              pageCache.set(normalizedKey, 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)
+            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 + '/' + cacheKey + '\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)
         }
-      })
+      }
+      )
 
     // watch for file changes
     const watcher = chokidar.watch(watchPath, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coralite-scripts",
-  "version": "0.23.0",
+  "version": "0.25.0",
   "description": "Configuration and scripts for Create Coralite.",
   "type": "module",
   "bin": {
@@ -50,6 +50,7 @@
   "dependencies": {
     "chokidar": "^4.0.3",
     "commander": "^14.0.0",
+    "cross-env": "^10.1.0",
     "express": "^5.1.0",
     "kleur": "^4.1.5",
     "local-access": "^1.1.0",
@@ -57,7 +58,7 @@
     "portfinder": "^1.0.38",
     "postcss": "^8.5.6",
     "sass": "^1.91.0",
-    "coralite": "0.23.0"
+    "coralite": "0.25.0"
   },
   "scripts": {
     "build": "premove dist && pnpm build-types",

package/types/index.js

@@ -13,6 +13,7 @@
  * @property {string} styles.input - The path to the main stylesheet file to process.
  * @property {Options<'async'>} [sassOptions] - Additional options passed to the Sass compiler.
  * @property {import('postcss').AcceptedPlugin[]} [cssPlugins] - Postcss plugins.
+ * @property {'production' | 'development'} [mode='production'] - Set build mode for the coralite instance.
  */
 
 /**

package/libs/build-html.js

@@ -1,30 +0,0 @@
-import Coralite from 'coralite'
-
-/**
- * @import {CoraliteScriptConfig} from '../types/index.js'
- * @import {CoraliteResult} from 'coralite/types'
- */
-
-/**
- * @param {CoraliteScriptConfig} config
- * @returns {Promise<CoraliteResult[]>}
- */
-async function buildHTML (config) {
-  // start coralite
-  const coralite = new Coralite({
-    templates: config.templates,
-    pages: config.pages,
-    plugins: config.plugins
-  })
-  await coralite.initialise()
-
-  // compile website
-  const documents = await coralite.compile()
-
-  // save documents
-  await coralite.save(documents, config.output)
-
-  return documents
-}
-
-export default buildHTML