coralite 0.11.2 → 0.11.3

package/README.md

@@ -7,11 +7,11 @@ coralite is a static site generator library built around the emerging [HTML modu
 </p>
 
 - Getting started
-  - [Basic templating](./docs/basic-templating.md)
+  - [Basic templating](https://codeberg.org/tjdavid/coralite/src/branch/main/docs/basic-templating.md)
 - Reference
-  - [Coralite CLI](./docs/coralite-cli.md)
-  - [Coralite](./docs/coralite.md)
-  - [Types](./docs/types.md)
+  - [Coralite CLI](https://codeberg.org/tjdavid/coralite/src/branch/main/docs/coralite-cli.md)
+  - [Coralite](https://codeberg.org/tjdavid/coralite/src/branch/main/docs/coralite.md)
+  - [Types](https://codeberg.org/tjdavid/coralite/src/branch/main/docs/types.md)
 
 ## Installation
 

package/bin/coralite.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node --experimental-vm-modules --experimental-import-meta-resolve
+#!/usr/bin/env -S node --experimental-vm-modules --experimental-import-meta-resolve
 
 import { getPkg, Coralite } from '#lib'
 import { Command } from 'commander'

package/lib/plugin.js

@@ -1,23 +1,37 @@
 /**
  * @import Coralite from './coralite.js'
- * @import { CoralitePlugin } from '#types'
+ * @import { CoralitePlugin, CoralitePluginInstance } from '#types'
  */
 
 import { basename, dirname } from 'path'
 import { getHtmlFile } from './html.js'
 
 /**
- * @param {CoralitePlugin & ThisType<Coralite>} options
+ * Creates a new Coralite plugin instance based on provided configuration options.
+ *
+ * @param {CoralitePlugin & ThisType<Coralite>} options - Plugin configuration object
+ * @returns {CoralitePluginInstance} A plugin instance with processed templates and method
+ *
+ * @example
+ * const myPlugin = createPlugin({
+ *   name: 'my-plugin',
+ *   method: (options, context) => {
+ *     // Plugin logic implementation
+ *   },
+ *   templates: ['src/components/header.html', 'src/components/footer.html']
+ * })
  */
 export function createPlugin ({
   name,
   method,
   templates = []
 }) {
+  // validate that the plugin method is a function
   if (typeof method !== 'function') {
     throw Error('Coralite plugins method expects a function')
   }
 
+  // process template files and store metadata
   const templateResults = []
   for (let i = 0; i < templates.length; i++) {
     const path = templates[i]
@@ -33,6 +47,7 @@ export function createPlugin ({
     })
   }
 
+  // return the plugin object with all configured properties
   return {
     name,
     method,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coralite",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "description": "HTML modules static site generator",
   "main": "./lib/coralite.js",
   "type": "module",

package/types/index.js

@@ -217,7 +217,7 @@
  * @property {CoraliteModule} module - The module context the plugin is operating within (contains template/script)
  * @property {CoraliteElement} element - The specific HTML element the plugin is applied to (if applicable)
  * @property {Object} path - File path information for the current document/module being processed
- * @property {[string, string][]} excludeByAttribute - List of attribute name-value pairs to ignore during processing by element type
+ * @property {IgnoreByAttribute[]} excludeByAttribute - List of attribute name-value pairs to ignore during processing by element type
  * @property {string} id - Unique identifier for the value context.
  */