coralite-scripts 0.28.2 → 0.28.4

package/README.md

@@ -1,6 +1,6 @@
-# Coralite Development Environment Guide
+# Coralite Scripts
 
-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.
+Welcome to **Coralite Scripts**, a lightweight script toolset for building and serving Coralite applications. This guide walks you through setting up your local development environment using the provided `coralite-scripts` package and configuration files.
 
 ---
 
@@ -12,8 +12,8 @@ Coralite expects a standard folder layout:
 my-coralite-site/
 ├── src/
 │   ├── pages/        # Your page components (e.g., `about.html`, `index.html`)
-│   ├── scss/         # SCSS/Sass styles
-│   └── components/    # Reusable component files
+│   ├── scss/         # SCSS/Sass/CSS styles
+│   └── components/   # Reusable component files
 ├── public/           # Static assets (CSS, JS, images)
 ├── dist/             # Output directory for built site (auto-generated)
 ├── coralite.config.js # Configuration file
@@ -34,13 +34,26 @@ export default defineConfig({
   public: 'public',
   pages: 'src/pages',
   components: 'src/components',
-  sass: {
+  styles: {
+    type: 'scss', // can be 'scss', 'sass', or 'css'
     input: 'src/scss'
-  }
+  },
+  // Optional: copy static assets from other packages
+  assets: [
+    { pkg: 'some-package', path: 'dist/asset.js', dest: 'assets/asset.js' }
+  ],
+  // Optional: ignore processing elements with specific attributes
+  ignoreByAttribute: [
+    { name: 'data-ignore', value: 'true' }
+  ],
+  // Optional: skip rendering elements with specific attributes
+  skipRenderByAttribute: [
+    { name: 'data-skip', value: 'true' }
+  ]
 })
 ```
 
-> This tells Coralite where to find your source files, compile CSS from SCSS, and serve static assets.
+> This tells Coralite where to find your source files, compile CSS from SCSS/Sass/CSS, and serve static assets. It also sets up advanced features like copying static assets or ignoring/skipping rendering of specific elements based on attributes.
 
 ---
 
@@ -48,10 +61,11 @@ export default defineConfig({
 
 Update your `package.json` scripts to include:
 
-```json package.json
+```json
 {
   "scripts": {
-    "start": "coralite-script"
+    "start": "coralite-scripts start",
+    "build": "coralite-scripts build"
   }
 }
 ```
@@ -62,7 +76,7 @@ Then start the dev server:
 npm run start
 ```
 
-> ✅ The server runs on `http://localhost:3000` by default.
+> The server runs on `http://localhost:3000` by default.
 
 ---
 
@@ -72,7 +86,7 @@ Coralite provides real-time development workflows out of the box:
 
 | Feature | How It Works |
 |-------|-------------|
-| **Live Reload** | Automatically reloads browser when any `.html`, `.scss`, or `.sass` file changes. |
+| **Live Reload** | Automatically reloads browser when any `.html`, `.scss`, `.sass`, or `.css` 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/components`. |
 | **Dev Logs** | Shows real-time build times, file changes, and status codes in terminal. |
@@ -82,8 +96,8 @@ Coralite provides real-time development workflows out of the box:
 ## How it works under the hood
 
 - **Routing**: `/` → `index.html`, `/about` → `about.html`
-- **HTML Compilation**: Pages are compiled with embedded live reload scripts.
-- **Sass Support**: `.scss`/`.sass` files are auto-compiled to CSS in `dist/css`.
+- **HTML Compilation**: Pages are compiled with embedded live reload scripts during development.
+- **Sass/CSS Support**: `.scss`, `.sass`, or `.css` files are auto-compiled to CSS in `dist/css`.
 - **Server-Sent Events (SSE)**: Used for real-time updates without full page refresh.
 
 > No extra tooling needed — everything is built-in!
@@ -109,6 +123,6 @@ Coralite provides real-time development workflows out of the box:
 
 ---
 
-> **Feedback?** Found a bug or want a feature? Open an issue!
+> **Feedback?** Found a bug or want a feature? [Open an issue](https://codeberg.org/tjdavid/coralite/issues) on our Codeberg repository!
 
-Happy building with Coralite!
+Happy building with Coralite!

package/bin/index.js

@@ -64,7 +64,8 @@ if (mode === 'dev') {
   const coralite = new Coralite({
     components: config.components,
     pages: config.pages,
-    plugins: config.plugins
+    plugins: config.plugins,
+    output: config.output
   })
   await coralite.initialise()
 

package/dist/libs/config.d.ts

@@ -1,6 +1,3 @@
-/**
- * @import {CoraliteScriptConfig} from '../types/index.js'
- */
 /**
  * Defines the Coralite configuration for the project.
  *
@@ -22,9 +19,13 @@
  *   server: {
  *     port: 3000
  *   },
- *   sass: {
+ *   styles: {
+ *     type: 'scss',
  *     input: './src/styles/main.scss'
- *   }
+ *   },
+ *   assets: [
+ *     { pkg: 'some-package', path: 'dist/asset.js', dest: 'assets/asset.js' }
+ *   ]
  * })
  * ```
  */

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,CAmHhC;0CA7HsC,mBAAmB"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../libs/config.js"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,sCAzBW,oBAAoB,GAClB,oBAAoB,CA+HhC;0CA1IsC,mBAAmB"}

package/dist/types/index.d.ts

@@ -1,10 +1,28 @@
 declare const _default: {};
 export default _default;
+export type CoraliteStaticAsset = {
+    /**
+     * - The package name to copy assets from.
+     */
+    pkg: string;
+    /**
+     * - The path to the asset within the package.
+     */
+    path: string;
+    /**
+     * - The destination path for the asset in the output directory.
+     */
+    dest: string;
+};
 export type CoraliteScriptBaseConfig = {
     /**
      * - The path to the directory containing static assets.
      */
     public: string;
+    /**
+     * - Static assets to copy during build.
+     */
+    assets?: CoraliteStaticAsset[];
     /**
      * - Server configuration options.
      */

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;;;;WAClC,YAAY,GAAG,aAAa;;mCAI7B,wBAAwB,GAAG,cAAc;;;;;UAKxC,OAAO;;;;YACP,OAAO;;;;cACP,OAAO;;6BAxBK,MAAM;oCADC,gBAAgB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../types/index.js"],"names":[],"mappings":";;;;;;SAOc,MAAM;;;;UACN,MAAM;;;;UACN,MAAM;;;;;;YAKN,MAAM;;;;aACN,mBAAmB,EAAE;;;;aAEhC;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;;6BAhCK,MAAM;oCADC,gBAAgB"}

package/libs/config.js

@@ -1,6 +1,7 @@
 /**
  * @import {CoraliteScriptConfig} from '../types/index.js'
  */
+import { staticAssetPlugin } from 'coralite/plugins'
 
 /**
  * Defines the Coralite configuration for the project.
@@ -23,9 +24,13 @@
  *   server: {
  *     port: 3000
  *   },
- *   sass: {
+ *   styles: {
+ *     type: 'scss',
  *     input: './src/styles/main.scss'
- *   }
+ *   },
+ *   assets: [
+ *     { pkg: 'some-package', path: 'dist/asset.js', dest: 'assets/asset.js' }
+ *   ]
  * })
  * ```
  */
@@ -123,5 +128,13 @@ export function defineConfig (options) {
     }
   }
 
+  if (options.assets) {
+    if (!Array.isArray(options.assets)) {
+      throw new Error('Configuration "assets" must be an array')
+    }
+    options.plugins = options.plugins || []
+    options.plugins.push(staticAssetPlugin(options.assets))
+  }
+
   return options
 }

package/libs/server.js

@@ -39,7 +39,8 @@ async function server (config, options) {
       plugins: config.plugins,
       ignoreByAttribute: config.ignoreByAttribute,
       skipRenderByAttribute: config.skipRenderByAttribute,
-      mode: 'development'
+      mode: 'development',
+      output: config.output
     })
     await coralite.initialise()
     displaySuccess('Coralite initialized successfully')
@@ -86,10 +87,17 @@ async function server (config, options) {
       next()
     })
 
+    const staticOptions = {
+      cacheControl: false,
+      setHeaders: (res, path) => {
+        if (path.endsWith('.wasm')) {
+          res.setHeader('Content-Type', 'application/wasm')
+        }
+      }
+    }
+
     // serve compiled components directory
-    app.use(express.static(config.output, {
-      cacheControl: false
-    }))
+    app.use(express.static(config.output, staticOptions))
 
     // check if Sass is configured and add its input directory to watchPath for file changes.
     if (config.styles) {
@@ -139,9 +147,7 @@ async function server (config, options) {
     }
 
     app
-      .use(express.static(config.public, {
-        cacheControl: false
-      }))
+      .use(express.static(config.public, staticOptions))
       .get('/_/rebuild', (req, res) => {
         // set headers for SSE
         res.writeHead(200, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coralite-scripts",
-  "version": "0.28.2",
+  "version": "0.28.4",
   "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.28.1"
+    "coralite": "0.28.2"
   },
   "scripts": {
     "build": "premove dist && pnpm build-types",

package/types/index.js

@@ -3,9 +3,17 @@
  * @import {Options} from 'sass'
  */
 
+/**
+ * @typedef {Object} CoraliteStaticAsset
+ * @property {string} pkg - The package name to copy assets from.
+ * @property {string} path - The path to the asset within the package.
+ * @property {string} dest - The destination path for the asset in the output directory.
+ */
+
 /**
  * @typedef {Object} CoraliteScriptBaseConfig
  * @property {string} public - The path to the directory containing static assets.
+ * @property {CoraliteStaticAsset[]} [assets] - Static assets to copy during build.
  * @property {Object} [server] - Server configuration options.
  * @property {number} server.port - The port number on which the development server will run.
  * @property {Object} [styles]