coralite 0.1.0

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "coralite"
+  ]
+}

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,9 @@
+# Coralite
+
+A simple static site generator based on `HTML modules`
+
+## Installation
+
+```
+npm install coralite --save-dev
+```

package/bin/coralite.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+
+import { getHTML, getComponentFromString, mergeComponentToDocument, getSubDirectory } from '../lib/index.js'
+import { Command } from 'commander'
+import { resolve, join } from 'node:path'
+import { existsSync, mkdirSync, writeFileSync, readFileSync } from 'node:fs'
+
+/** @import { CoraliteComponent } from '#types' */
+
+const pkg = JSON.parse(readFileSync(`./package.json`, 'utf-8'))
+const program = new Command()
+
+program
+  .name(pkg.name)
+  .description(pkg.description)
+  .version(pkg.version)
+  .requiredOption('-c, --components <path>', 'Path to components directory')
+  .requiredOption('-p, --pages <path>', 'Path to pages directory')
+  .requiredOption('-o, --output <path>', 'Output directory for the generated site')
+  .option('-d, --dry', 'Run in dry-run mode')
+
+program.parse()
+program.on('error', (err) => {
+  console.error(err)
+})
+
+const options = program.opts()
+const componentsPath = options.components
+const pagesPath = options.pages
+const outputDir = options.output
+const dryRun = options.dry
+
+const htmlComponents = await getHTML({
+  path: componentsPath,
+  recursive: true
+})
+const htmlPages = await getHTML({
+  path: pagesPath,
+  recursive: true
+})
+
+/** @type {Object.<string, CoraliteComponent>} */
+const components = {}
+
+for (let i = 0; i < htmlComponents.length; i++) {
+  const html = htmlComponents[i]
+  const component = getComponentFromString(html.content)
+  components[component.id] = component
+}
+
+for (let i = 0; i < htmlPages.length; i++) {
+  const html = htmlPages[i]
+
+  const content = await mergeComponentToDocument(html, components, {
+    pages: resolve(pagesPath),
+    components: resolve(componentsPath)
+  })
+
+  if (!dryRun) {
+    // get pages sub directory
+    const subDir = getSubDirectory(pagesPath, html.parentPath)
+    const dir = join(outputDir, subDir)
+
+    try {
+      if (!existsSync(dir)) {
+        // create directory
+        mkdirSync(dir)
+      }
+
+      writeFileSync(join(dir, html.name), content)
+      // file written successfully
+    } catch (err) {
+      console.error(err)
+    }
+  } else {
+    console.log('Document')
+    console.log('Path: ' + join(html.parentPath, html.name))
+    console.log('Content')
+    console.log(content)
+  }
+}

package/jsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "module": "NodeNext",
+    "target": "ES2020",
+    "moduleResolution": "nodenext",
+  }
+}

package/lib/component.js

@@ -0,0 +1,185 @@
+import { join } from 'node:path'
+
+/**
+ * @import { CoralitePath, HTMLData, CoraliteComponent, CoraliteTokenOptions } from '#types'
+ */
+
+import getHTML from './get-html.js'
+import getMetadataFromDocument from './get-metadata-from-document.js'
+import replaceAttributeTokenValue from './replace-attribute-token-value.js'
+
+/**
+ * @param {Object.<string, Function>} tokens
+ */
+export async function computedTokens (tokens) {
+  const result = {}
+
+  for (const key in tokens) {
+    if (Object.prototype.hasOwnProperty.call(tokens, key)) {
+      result[key] = await tokens[key].call(this)
+    }
+  }
+
+  return result
+}
+
+/**
+ * @param {Object.<string, CoraliteComponent>} components
+ * @param {CoralitePath} path
+ * @param {Object.<string, string>} values
+ * @param {HTMLData} document
+ */
+function createContext (components, path, values, document) {
+  return {
+    /**
+     * @param {Object} options
+     * @param {string} options.path
+     * @param {string} options.componentId
+     * @param {boolean} [options.recursive]
+     * @param {CoraliteTokenOptions} [options.tokens]
+     */
+    async aggregate (options) {
+      const component = components[options.componentId]
+
+      if (!component) {
+        throw new Error('Aggregate: no component found by the id: ' + options.componentId)
+      }
+
+      const pages = await getHTML({
+        path: join(path.pages, options.path),
+        recursive: options.recursive,
+        exclude: [document.name]
+      })
+
+      let result = ''
+      for (let i = 0; i < pages.length; i++) {
+        const page = pages[i]
+        const metadata = getMetadataFromDocument(page.content)
+        const pageValues = Object.assign({}, values)
+
+        for (let i = 0; i < metadata.length; i++) {
+          const item = metadata[i]
+
+          pageValues[item.name] = item.content
+        }
+
+        result += await render(component, {
+          values: pageValues,
+          tokens: options.tokens,
+          path,
+          components,
+          document: page
+        })
+      }
+
+      return result
+    },
+    tokens: values
+  }
+}
+
+/**
+ * @param {CoraliteComponent} component
+ * @param {Object} context
+ * @param {Object} context.values
+ * @param {CoralitePath} context.path
+ * @param {CoraliteTokenOptions} [context.tokens={ default: {}, aliases: {}}]
+ * @param {Object.<string, CoraliteComponent>} [context.components]
+ * @param {HTMLData} [context.document]
+ */
+export async function render (component, {
+  values,
+  path,
+  tokens = {
+    default: {},
+    aliases: {}
+  },
+  components,
+  document
+}) {
+  // set alias values
+  for (const name in tokens.aliases) {
+    if (Object.prototype.hasOwnProperty.call(tokens.aliases, name)) {
+      const aliases = tokens.aliases[name]
+
+      if (!values[name]) {
+        for (let i = 0; i < aliases.length; i++) {
+          const alias = aliases[i]
+
+          if (values[alias]) {
+            values[name] = values[alias]
+            break
+          }
+        }
+      }
+    }
+  }
+
+  // set default values
+  for (const name in tokens.default) {
+    if (Object.prototype.hasOwnProperty.call(tokens.default, name)) {
+      if (!values[name]) {
+        values[name] = tokens.default[name]
+      }
+    }
+  }
+
+  const context = createContext(components, path, values, document)
+  const computedValues = await component.computedTokens(context)
+
+  if (computedValues) {
+    values = Object.assign(values, computedValues)
+  }
+
+  // render nested components
+  for (let index = 0; index < component.customElements.length; index++) {
+    const element = component.customElements[index]
+    const nestedComponent = components[element.id]
+
+    if (!nestedComponent) {
+      throw new Error('No component found by the id: ' + element.id)
+    }
+
+    // add values from attributes
+    for (let i = 0; i < element.attributes.length; i++) {
+      const attribute = element.attributes[i]
+
+      values[attribute.name] = replaceAttributeTokenValue(attribute, values)
+    }
+  }
+
+  let result = component.content
+
+  // render nested components
+  for (let index = 0; index < component.customElements.length; index++) {
+    const element = component.customElements[index]
+    const nestedComponent = components[element.id]
+    const renderedComponent = await render(nestedComponent, {
+      values,
+      path,
+      components,
+      document
+    })
+
+    result = result.replace(element.content, renderedComponent)
+  }
+
+
+  // replace tokens with values
+  for (let i = 0; i < component.tokens.length; i++) {
+    const token = component.tokens[i]
+    const name = token.name
+    let value = values[name]
+
+    if (value == null) {
+      console.error('Token "' + name +'" was empty used on "' + component.id + '" component within the document:' + document.parentPath + '/' + document.name)
+
+      value = ''
+    }
+
+    result = result.replace(token.content, value)
+  }
+
+  return result
+}
+

package/lib/eval-computed-tokens.js

@@ -0,0 +1,7 @@
+import { computedTokens } from './component.js'
+
+async function evalComputedTokens (args, thisArgs) {
+  return new Function(computedTokens + ' return computedTokens.call(this,' + args + ')').call(thisArgs)
+}
+
+export default evalComputedTokens

package/lib/get-component-from-string.js

@@ -0,0 +1,39 @@
+import getCustomElementsFromString from './get-custom-elements-from-string.js'
+import getScriptFromString from './get-script-from-string.js'
+import getTokensFromString from './get-tokens-from-string.js'
+
+/**
+ * @import { CoraliteComponent } from '#types'
+ */
+
+/**
+ * Extract component from string
+ * @param {string} string
+ * @returns {CoraliteComponent}
+ */
+function getComponentFromString (string) {
+  const matches = string.matchAll(/<template\s*id\s*=\s*["']\s*(?<id>[\w+\-]*)\s*['"]>(?<content>[\s*\S*]*?)<\/template>/g)
+  const match = matches.next()
+  const template = match.value
+
+  if (!template) {
+    throw new Error('No template found')
+  }
+
+  const content = template.groups.content
+  const customElements = getCustomElementsFromString(content)
+  const tokens = getTokensFromString(content)
+  const computedTokens = getScriptFromString(string.replace(content, ''))
+  const component = {
+    id: template.groups.id,
+    content: content,
+    tokens,
+    customElements,
+    computedTokens
+  }
+
+  // @ts-ignore
+  return component
+}
+
+export default getComponentFromString

package/lib/get-custom-elements-from-string.js

@@ -0,0 +1,48 @@
+import getTokensFromString from './get-tokens-from-string.js'
+
+/**
+ * @import { CoraliteToken, CoraliteCustomElementResult, CoraliteCustomElementAttribute, CoraliteCustomElement } from '#types'
+ */
+
+/**
+ * Extract web component from string
+ * @param {string} string
+ */
+function getCustomElementsFromString (string) {
+  const matches = string.matchAll(/<(?<id>[\w]+-[\w|\-]+)\s*(?<attributes>[\s\S]*?)>(?<content>[\s\S]*?)<\/\1>/g)
+  /** @type {CoraliteCustomElement[]} */
+  const customElements = []
+
+  for (const match of matches) {
+    if (!match) {
+      return customElements
+    }
+
+    const attributesString = match.groups.attributes
+    const customElement = {
+      id: match.groups.id,
+      attributes: [],
+      content: match[0]
+    }
+
+    customElements.push(customElement)
+
+    if (attributesString) {
+      const attributeMatches = attributesString.matchAll(/(?<name>[a-zA-Z-]+)\s*=\s*["'](?<value>[^"']+)["']/g)
+
+      for (const attributeMatch of attributeMatches) {
+        const attribute = {
+          name: attributeMatch.groups.name,
+          value: attributeMatch.groups.value,
+          tokens: getTokensFromString(attributeMatch.groups.value)
+        }
+
+        customElement.attributes.push(attribute)
+      }
+    }
+  }
+
+  return customElements
+}
+
+export default getCustomElementsFromString

package/lib/get-html.js

@@ -0,0 +1,53 @@
+import { extname, join } from 'node:path'
+import { readdir, readFile } from 'node:fs/promises'
+
+/**
+ * @import { HTMLData } from '#types'
+ */
+
+/**
+ * Get HTML
+ * @param {Object} options - html directory
+ * @param {string} options.path - html directory
+ * @param {boolean} [options.recursive] - If true, reads the contents of a directory recursively. In recursive mode, it will list all files, sub files and directories. Default: false.
+ * @param {string[]} [options.exclude = []] - Exclude file by name
+ * @returns {Promise<HTMLData[]>}
+ */
+export default function getHTML ({ path, recursive, exclude = [] }) {
+  return new Promise((resolve, reject) => {
+    const html = []
+
+    readdir(path, {
+      recursive,
+      withFileTypes: true
+    })
+      .then(files => {
+        const promises = []
+        for (let i = 0; i < files.length; i++) {
+          const file = files[i]
+
+          if (file.isFile()
+            && extname(file.name).toLowerCase() === '.html'
+            && !exclude.includes(file.name)
+          ) {
+            html.push({
+              parentPath: file.parentPath,
+              name: file.name
+            })
+            promises.push(readFile(join(file.parentPath, file.name), { encoding: 'utf8' }))
+          }
+        }
+
+        Promise.all(promises)
+          .then(results => {
+            for (let i = 0; i < results.length; i++) {
+              html[i].content = results[i]
+            }
+
+            resolve(html)
+          })
+          .catch(error => reject(error))
+      })
+      .catch(error => reject(error))
+  })
+}

package/lib/get-metadata-from-document.js

@@ -0,0 +1,41 @@
+/**
+ * @typedef {Object} CoraliteMeta
+ * @property {string} name - Meta name
+ * @property {string} content - Meta content
+ */
+
+/**
+ * Extract metadata from document
+ * @param {string} string
+ * @returns {CoraliteMeta[]}
+ */
+function getMetadataFromDocument (string) {
+  const headMatches = string.matchAll(/<head>\s*([\s\S]*?)<\/head>/g)
+  /** @type {CoraliteMeta[]} */
+  const result = []
+
+  if (!headMatches) {
+    throw new Error('No head tag found in document')
+  }
+
+  const head = headMatches.next()
+  const metaInput = head.value[1]
+
+  if (!metaInput) {
+    throw new Error('No meta tags found in document')
+  }
+
+  const metaMatches = metaInput.matchAll(/<meta\s+(.*?)\/?>/g)
+
+  for (const metaMatch of metaMatches) {
+    const attributeMatches = metaMatch[1].matchAll(/(?:name\s*=\s*["'](?<name>[^"']*?)["'])\s+(?:[^>]*?\s)?(?:content\s*=\s*["'](?<content>[^"']*?)["'])/g)
+
+    for (const attributeMatch of attributeMatches) {
+      result.push(attributeMatch.groups)
+    }
+  }
+
+  return result
+}
+
+export default getMetadataFromDocument

package/lib/get-script-from-string.js

@@ -0,0 +1,50 @@
+import evalComputedTokens from './eval-computed-tokens.js'
+
+/**
+ * @import { coraliteComputedTokens } from '#types'
+ */
+
+/**
+ * Extract script tag from HTML
+ * @param {string} string
+ * @returns {coraliteComputedTokens}
+ */
+function getScriptFromString (string) {
+  const matches = string.matchAll(/<script\s*(?<attribute>[\s\S]*?)>(?<content>[\s\S]*?)<\/script>/g)
+  const match = matches.next()
+  const script = match.value
+
+  if (!script) {
+    return async () => ({})
+  }
+
+  const attributeRegex = /type\s*=\s*["']module["']/
+
+  if (!attributeRegex.test(script.groups.attribute)) {
+    throw new Error('Script tag must contain `type="module"`')
+  }
+
+  const content = script.groups.content
+
+  if (!content) {
+    throw new Error('Script cannot be empty')
+  }
+
+  /**
+   * @TODO [HTML modules]{@link https://github.com/WICG/webcomponents/blob/gh-pages/proposals/html-modules-explainer.md}
+   * this regex is extremely limited and will be replaced by vm.Script
+   */
+  const computedTokensString = content.match(/computedTokens\s*\((?<args>(?:[^()]*|\((?:[^()]*|\([^()]*\))*\))*)\)/)
+
+  if (!computedTokensString) {
+    throw new Error('Script tag expects "computedTokens" but found none')
+  }
+
+  if (computedTokensString.length > 3) {
+    throw new Error('Duplicate "computedAttributes" found')
+  }
+
+  return async (thisArgs) => evalComputedTokens(computedTokensString[1], thisArgs)
+}
+
+export default getScriptFromString

package/lib/get-subdirectory.js

@@ -0,0 +1,28 @@
+import { normalize, sep } from 'path'
+
+/**
+ * Compare two path names and get the diff from base
+ * @param {string} base - Base directory
+ * @param {string} path - Path name
+ */
+function getSubDirectory (base, path) {
+  // normalize paths to handle different OS path separators
+  const normalizedPath1 = normalize(base)
+  const normalizedPath2 = normalize(path)
+
+  // split paths into segments
+  const segments1 = normalizedPath1.split(sep)
+  const segments2 = normalizedPath2.split(sep)
+
+  let i = 0
+  while (i < segments1.length
+    && i < segments2.length
+    && segments1[i] === segments2[i]
+  ) {
+    i++
+  }
+
+  return segments2.slice(i).join(sep)
+}
+
+export default getSubDirectory

package/lib/get-tokens-from-string.js

@@ -0,0 +1,26 @@
+/**
+ * @import {CoraliteToken} from '#types'
+ */
+
+/**
+ * Extract attributes from string
+ * @param {string} string
+ * @returns {CoraliteToken[]}
+ */
+function getTokensFromString (string) {
+  const matches = string.matchAll(/\{{[^}]*\}}/g)
+  const result = []
+
+  for (const match of matches) {
+    const token = match[0]
+
+    result.push({
+      name: token.slice(2, token.length -2).trim(),
+      content: token
+    })
+  }
+
+  return result
+}
+
+export default getTokensFromString

package/lib/index.js

@@ -0,0 +1,19 @@
+import getComponentFromString from './get-component-from-string.js'
+import getHTML from './get-html.js'
+import mergeComponentToDocument from './merge-component-to-document.js'
+import getTokensFromString from './get-tokens-from-string.js'
+import getScriptFromString from './get-script-from-string.js'
+import getMetadataFromDocument from './get-metadata-from-document.js'
+import getSubDirectory from './get-subdirectory.js'
+import evalComputedTokens from './eval-computed-tokens.js'
+
+export {
+  evalComputedTokens,
+  getSubDirectory,
+  getMetadataFromDocument,
+  getScriptFromString,
+  getTokensFromString,
+  getComponentFromString,
+  mergeComponentToDocument,
+  getHTML
+}

package/lib/merge-component-to-document.js

@@ -0,0 +1,54 @@
+import { render } from './component.js'
+import getCustomElementsFromString from './get-custom-elements-from-string.js'
+import replaceAttributeTokenValue from './replace-attribute-token-value.js'
+
+/**
+ * @import {CoraliteComponent, HTMLData, CoralitePath } from '#types'
+ */
+
+/**
+ * Merge components into a document
+ * @param {HTMLData} document
+ * @param {Object.<string, CoraliteComponent>} components
+ * @param {CoralitePath} path
+ * @returns {Promise<string>}
+ */
+async function mergeComponentToDocument (document, components, path) {
+  const customElements = getCustomElementsFromString(document.content)
+
+  if (!customElements.length) {
+    // Could not find any custom elements
+    return document.content
+  }
+
+  let result = document.content
+
+  for (let i = 0; i < customElements.length; i++) {
+    const customElement = customElements[i]
+    const component = components[customElement.id]
+
+    if (component) {
+      /** @type {Object.<string, string>} */
+      const values = {}
+
+      for (let i = 0; i < customElement.attributes.length; i++) {
+        const attribute = customElement.attributes[i]
+
+        values[attribute.name] = replaceAttributeTokenValue(attribute, values)
+      }
+
+      const renderedComponent = await render(component, {
+        values,
+        path,
+        components,
+        document
+      })
+
+      result = result.replace(customElement.content, renderedComponent)
+    }
+  }
+
+  return result
+}
+
+export default mergeComponentToDocument

package/lib/replace-attribute-token-value.js

@@ -0,0 +1,23 @@
+/**
+ * @import { CoraliteCustomElementAttribute } from '#types'
+ */
+
+/**
+ * @param {CoraliteCustomElementAttribute} attribute
+ * @param {Object.<string, string>} values
+ */
+function replaceAttributeTokenValue (attribute, values) {
+  let result = attribute.value
+
+  for (let i = 0; i < attribute.tokens.length; i++) {
+    const token = attribute.tokens[i]
+    const value = values[token.name] || ''
+
+    result = result.replace(token.content, value)
+  }
+
+
+  return result
+}
+
+export default replaceAttributeTokenValue

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "coralite",
+  "version": "0.1.0",
+  "description": "HTML modules static site generator",
+  "main": "./lib/coralite.js",
+  "type": "module",
+  "keywords": [
+    "static-site-generator",
+    "components",
+    "templates",
+    "coralite",
+    "blog",
+    "site-engine",
+    "documentation-tool"
+  ],
+  "homepage": "https://coraltie.io",
+  "author": {
+    "name": "Thomas David",
+    "url": "https://thomasjackdavid.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tjdav/coralite.git"
+  },
+  "license": "MPL-2.0",
+  "scripts": {
+    "format": "eslint --cache --fix .",
+    "lint": "eslint --cache ."
+  },
+  "bin": {
+    "coralite": "./bin/coralite.js"
+  },
+  "imports": {
+    "#lib": "./lib/index.js",
+    "#types": "./types/index.js"
+  },
+  "exports": {
+    "default": "./lib/component.js",
+    "types": "./types/index.js"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin-js": "^2.12.1",
+    "@stylistic/eslint-plugin-plus": "^2.12.1",
+    "@types/node": "^22.10.5"
+  },
+  "dependencies": {
+    "commander": "^13.0.0"
+  }
+}

package/types/index.js

@@ -0,0 +1,59 @@
+/**
+ * @callback coraliteComputedTokens
+ * @param {Object} thisArgs
+ * @returns {Promise<Object<string, string>>}
+ */
+
+/**
+ * @typedef {Object} CoraliteToken
+ * @property {string} name - Token name
+ * @property {string} content - End position of token
+ */
+
+/**
+ * @typedef {Object} CoraliteTokenOptions
+ * @property {Object.<string, string>} [default] - Token defaults
+ * @property {Object.<string, string[]>} [aliases] - Token aliases
+ */
+
+/**
+ * @typedef {Object} CoraliteComponent
+ * @property {string} id
+ * @property {string} content
+ * @property {CoraliteToken[]} tokens
+ * @property {coraliteComputedTokens} computedTokens
+ * @property {CoraliteCustomElement[]} customElements
+ */
+
+/**
+ * @typedef {Object} CoraliteCustomElementResult
+ * @property {string} content - Content body
+ * @property {CoraliteCustomElement[]} customElements - Custom elements found in content body
+ */
+
+/**
+ * @typedef {Object} CoraliteCustomElementAttribute
+ * @property {string} name - Attribute name
+ * @property {string} value - Attribute value
+ * @property {CoraliteToken[]} tokens - List of tokens used in attribute value
+ */
+
+/**
+ * @typedef {Object} CoraliteCustomElement
+ * @property {string} id - Custom element ID
+ * @property {CoraliteCustomElementAttribute[]} attributes - Custom element attributes
+ * @property {string} content
+ */
+
+/**
+ * @typedef {Object} HTMLData
+ * @property {string} parentPath - The path to the parent directory of the file.
+ * @property {string} name - The file name.
+ * @property {string} content - HTML string
+ */
+
+/**
+ * @typedef {Object} CoralitePath
+ * @property {string} pages
+ * @property {string} components
+ */