coralite-scripts 0.25.0 → 0.27.0

package/README.md

@@ -1,3 +1,5 @@
+> ⚠️ **NOTE: This is a read-only mirror.** Development happens on [Codeberg](https://codeberg.org/tjdavid/coralite).
+
 # Coralite Development Environment Guide
 
 Welcome to **Coralite starter script**, a lightweight Static Site Generator (SSG) built for rapid development and clean output. This guide walks you through setting up your local development environment using the provided `coralite-scripts` package and configuration files.
@@ -11,9 +13,9 @@ Coralite expects a standard folder layout:
 ```
 my-coralite-site/
 ├── src/
-│   ├── pages/        # Your page templates (e.g., `about.html`, `index.html`)
+│   ├── pages/        # Your page components (e.g., `about.html`, `index.html`)
 │   ├── scss/         # SCSS/Sass styles
-│   └── templates/    # Reusable template files
+│   └── components/    # Reusable component files
 ├── public/           # Static assets (CSS, JS, images)
 ├── dist/             # Output directory for built site (auto-generated)
 ├── coralite.config.js # Configuration file
@@ -33,7 +35,7 @@ export default defineConfig({
   output: 'dist',
   public: 'public',
   pages: 'src/pages',
-  templates: 'src/templates',
+  components: 'src/components',
   sass: {
     input: 'src/scss'
   }
@@ -74,7 +76,7 @@ Coralite provides real-time development workflows out of the box:
 |-------|-------------|
 | **Live Reload** | Automatically reloads browser when any `.html`, `.scss`, or `.sass` file changes. |
 | **Hot CSS Updates** | Sass/SCSS files are compiled instantly and injected into your page via Server-Sent Events (SSE). |
-| **File Watching** | Monitors `src/pages`, `src/scss`, `public`, and `src/templates`. |
+| **File Watching** | Monitors `src/pages`, `src/scss`, `public`, and `src/components`. |
 | **Dev Logs** | Shows real-time build times, file changes, and status codes in terminal. |
 
 ---

package/bin/index.js

@@ -59,7 +59,7 @@ if (mode === 'dev') {
   const start = process.hrtime()
   // start coralite
   const coralite = new Coralite({
-    templates: config.templates,
+    components: config.components,
     pages: config.pages,
     plugins: config.plugins
   })
@@ -80,7 +80,7 @@ if (mode === 'dev') {
       const outFile = join(outDir, result.path.filename)
 
       await mkdir(outDir, { recursive: true })
-      await writeFile(outFile, result.html)
+      await writeFile(outFile, result.content)
 
       if (options.verbose) {
         process.stdout.write(toTime() + toMS(result.duration) + dash + result.path.pathname + '\n')

package/dist/libs/config.d.ts

@@ -16,7 +16,7 @@
  *
  * export default defineConfig({
  *   output: './dist',
- *   templates: './src/templates',
+ *   components: './src/components',
  *   pages: './src/pages',
  *   public: './public',
  *   server: {

package/dist/libs/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../libs/config.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,sCArBW,oBAAoB,GAClB,oBAAoB,CAuEhC;0CAjFsC,mBAAmB"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../libs/config.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,sCArBW,oBAAoB,GAClB,oBAAoB,CAmHhC;0CA7HsC,mBAAmB"}

package/libs/build-css.js

@@ -21,8 +21,7 @@ import path from 'path'
 async function buildCSS ({
   input,
   output,
-  plugins = [],
-  start
+  plugins = []
 }) {
   try {
     // ensure output directory exists
@@ -31,9 +30,8 @@ async function buildCSS ({
     // read all files from src/scss directory
     const cssFiles = await fs.readdir(input)
     const filteredCssFiles = cssFiles.filter(file => file.endsWith('.css'))
-    const results = []
 
-    for (const file of filteredCssFiles) {
+    const results = await Promise.all(filteredCssFiles.map(async (file) => {
       const filePath = path.join(input, file)
       const outputFile = path.join(output, file)
       const css = await fs.readFile(filePath)
@@ -49,16 +47,16 @@ async function buildCSS ({
 
       await fs.writeFile(outputFile, result.css)
 
-      if ( result.map ) {
+      if (result.map) {
         await fs.writeFile(outputFile + '.map', result.map.toString())
       }
 
-      results.push({
+      return {
         input: filePath,
         output: outputFile,
         duration
-      })
-    }
+      }
+    }))
 
     return results
   } catch (error) {

package/libs/build-sass.js

@@ -31,10 +31,10 @@ async function buildSass ({
     silenceDeprecations: [
       'color-functions',
       'import',
-      'global-builtin'
+      'global-builtin',
+      'elseif'
     ]
-  },
-  start
+  }
 }) {
   try {
     // ensure output directory exists
@@ -43,33 +43,33 @@ async function buildSass ({
     // read all files from src/scss directory
     const scssFiles = await fs.readdir(input)
     const filteredScssFiles = scssFiles.filter(file => file.endsWith('.scss') && file[0] !== '_')
-    const results = []
 
-    for (const file of filteredScssFiles) {
+    const results = await Promise.all(filteredScssFiles.map(async (file) => {
       const filePath = path.join(input, file)
       const outputFile = path.join(output, file.replace('.scss', '.css'))
 
+      // start duration timer.
       const fileStart = process.hrtime()
 
+      // compile sass
       const result = await sass.compileAsync(filePath, options)
 
+      // record duration
       const duration = process.hrtime(fileStart)
 
-      // write the compiled CSS
       await fs.writeFile(outputFile, result.css)
 
-      // write source map if enabled
       if (result.sourceMap) {
         const sourceMapPath = outputFile + '.map'
         await fs.writeFile(sourceMapPath, JSON.stringify(result.sourceMap))
       }
 
-      results.push({
+      return {
         input: filePath,
         output: outputFile,
         duration
-      })
-    }
+      }
+    }))
 
     return results
   } catch (error) {

package/libs/config.js

@@ -17,7 +17,7 @@
  *
  * export default defineConfig({
  *   output: './dist',
- *   templates: './src/templates',
+ *   components: './src/components',
  *   pages: './src/pages',
  *   public: './public',
  *   server: {
@@ -39,8 +39,8 @@ export function defineConfig (options) {
     throw new Error('Configuration must contain a valid "output" property')
   }
 
-  if (!options.templates || typeof options.templates !== 'string') {
-    throw new Error('Configuration must contain a valid "templates" property')
+  if (!options.components || typeof options.components !== 'string') {
+    throw new Error('Configuration must contain a valid "components" property')
   }
 
   if (!options.pages || typeof options.pages !== 'string') {
@@ -79,5 +79,49 @@ export function defineConfig (options) {
     throw new Error('Configuration must contain a valid "public" property')
   }
 
+  if (options.ignoreByAttribute) {
+    if (!Array.isArray(options.ignoreByAttribute)) {
+      throw new Error('Configuration "ignoreByAttribute" must be an array')
+    }
+
+    for (let i = 0; i < options.ignoreByAttribute.length; i++) {
+      const item = options.ignoreByAttribute[i]
+      if (typeof item === 'string') {
+        continue
+      }
+      if (!item || typeof item !== 'object') {
+        throw new Error('Configuration "ignoreByAttribute" items must be strings or objects')
+      }
+      if (typeof item.name !== 'string') {
+        throw new Error('Configuration "ignoreByAttribute" items must have a string "name" property')
+      }
+      if (typeof item.value !== 'string') {
+        throw new Error('Configuration "ignoreByAttribute" items must have a string "value" property')
+      }
+    }
+  }
+
+  if (options.skipRenderByAttribute) {
+    if (!Array.isArray(options.skipRenderByAttribute)) {
+      throw new Error('Configuration "skipRenderByAttribute" must be an array')
+    }
+
+    for (let i = 0; i < options.skipRenderByAttribute.length; i++) {
+      const item = options.skipRenderByAttribute[i]
+      if (typeof item === 'string') {
+        continue
+      }
+      if (!item || typeof item !== 'object') {
+        throw new Error('Configuration "skipRenderByAttribute" items must be strings or objects')
+      }
+      if (typeof item.name !== 'string') {
+        throw new Error('Configuration "skipRenderByAttribute" items must have a string "name" property')
+      }
+      if (typeof item.value !== 'string') {
+        throw new Error('Configuration "skipRenderByAttribute" items must have a string "value" property')
+      }
+    }
+  }
+
   return options
 }

package/libs/server.js

@@ -34,9 +34,11 @@ async function server (config, options) {
     // start coralite
     displayInfo('Initializing Coralite...')
     const coralite = new Coralite({
-      templates: config.templates,
+      components: config.components,
       pages: config.pages,
       plugins: config.plugins,
+      ignoreByAttribute: config.ignoreByAttribute,
+      skipRenderByAttribute: config.skipRenderByAttribute,
       mode: 'development'
     })
     await coralite.initialise()
@@ -53,7 +55,7 @@ async function server (config, options) {
     const watchPath = [
       config.public,
       config.pages,
-      config.templates
+      config.components
     ]
 
     // no cache middleware
@@ -258,7 +260,7 @@ async function server (config, options) {
           // 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 injectedHtml = result.content.replace(/<\/body>/i, rebuildScript)
 
             const relPath = relative(config.pages, result.path.pathname)
             const normalizedKey = relPath.split(sep).join('/')
@@ -275,7 +277,7 @@ async function server (config, options) {
 
             return {
               path: result.path,
-              html: injectedHtml,
+              content: injectedHtml,
               duration: result.duration
             }
           })
@@ -292,7 +294,7 @@ async function server (config, options) {
           })
 
           if (doc) {
-            res.send(doc.html)
+            res.send(doc.content)
           } else {
             res.sendStatus(404)
           }
@@ -313,7 +315,7 @@ async function server (config, options) {
       ignoreInitial: true
     })
 
-    const templatePath = normalize(config.templates)
+    const componentPath = normalize(config.components)
     const pagesPath = normalize(config.pages)
 
     // Debouncing and compilation state management
@@ -341,14 +343,14 @@ async function server (config, options) {
 
         // Group changes by type
         const pagesChanges = changes.filter(p => p.startsWith(pagesPath))
-        const templateChanges = changes.filter(p => p.startsWith(templatePath))
+        const componentChanges = changes.filter(p => p.startsWith(componentPath))
         const sassChanges = changes.filter(p => p.endsWith('.scss') || p.endsWith('.sass'))
         const cssChanges = changes.filter(p => p.endsWith('.css'))
 
         try {
-          // Handle template changes
-          for (const path of templateChanges) {
-            await coralite.templates.setItem(path)
+          // Handle component changes
+          for (const path of componentChanges) {
+            await coralite.components.setItem(path)
           }
 
           // Handle SASS changes - rebuild all SASS files once
@@ -381,7 +383,7 @@ async function server (config, options) {
 
           // Notify clients to reload
           if (pagesChanges.length > 0
-            || templateChanges.length > 0
+            || componentChanges.length > 0
             || sassChanges.length > 0
             || cssChanges.length > 0) {
             clients.forEach(client => {
@@ -399,8 +401,8 @@ async function server (config, options) {
     watcher
       .on('unlink', async (path) => {
         try {
-          if (path.startsWith(templatePath)) {
-            await coralite.templates.deleteItem(path)
+          if (path.startsWith(componentPath)) {
+            await coralite.components.deleteItem(path)
           } else if (path.startsWith(pagesPath)) {
             await coralite.pages.deleteItem(path)
           }
@@ -415,9 +417,9 @@ async function server (config, options) {
       })
       .on('add', async (path) => {
         try {
-          if (path.startsWith(templatePath)) {
-            // set template item
-            coralite.templates.setItem(path)
+          if (path.startsWith(componentPath)) {
+            // set component item
+            coralite.components.setItem(path)
           } else if (path.endsWith('.scss') || path.endsWith('.sass')) {
             // Add to pending changes and trigger debounced compilation
             pendingChanges.add(path)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coralite-scripts",
-  "version": "0.25.0",
+  "version": "0.27.0",
   "description": "Configuration and scripts for Create Coralite.",
   "type": "module",
   "bin": {
@@ -58,7 +58,7 @@
     "portfinder": "^1.0.38",
     "postcss": "^8.5.6",
     "sass": "^1.91.0",
-    "coralite": "0.25.0"
+    "coralite": "0.27.0"
   },
   "scripts": {
     "build": "premove dist && pnpm build-types",