coralite 0.0.0-development

package/lib/path-utils.js

@@ -0,0 +1,26 @@
+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
+ */
+export 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)
+}

package/lib/tags.js

@@ -0,0 +1,145 @@
+export const validTags = {
+  a: true,
+  abbr: true,
+  acronym: true, // Deprecated
+  address: true,
+  area: true,
+  article: true,
+  aside: true,
+  audio: true,
+  b: true,
+  base: true,
+  bdi: true,
+  bdo: true,
+  big: true, // Deprecated
+  blockquote: true,
+  body: true,
+  br: true,
+  button: true,
+  canvas: true,
+  caption: true,
+  center: true, // Deprecated
+  cite: true,
+  code: true,
+  col: true,
+  colgroup: true,
+  data: true,
+  datalist: true,
+  dd: true,
+  del: true,
+  details: true,
+  dfn: true,
+  dialog: true,
+  dir: true, // Deprecated
+  div: true,
+  dl: true,
+  dt: true,
+  em: true,
+  embed: true,
+  fencedframe: true, // Experimental
+  fieldset: true,
+  figcaption: true,
+  figure: true,
+  font: true, // Deprecated
+  footer: true,
+  form: true,
+  frame: true, // Deprecated
+  frameset: true, // Deprecated
+  h1: true,
+  h2: true,
+  h3: true,
+  h4: true,
+  h5: true,
+  h6: true,
+  head: true,
+  header: true,
+  hgroup: true,
+  hr: true,
+  html: true,
+  i: true,
+  iframe: true,
+  img: true,
+  input: true,
+  ins: true,
+  kbd: true,
+  label: true,
+  legend: true,
+  li: true,
+  link: true,
+  main: true,
+  map: true,
+  mark: true,
+  marquee: true, // Deprecated
+  menu: true,
+  meta: true,
+  meter: true,
+  nav: true,
+  nobr: true, // Deprecated
+  noembed: true, // Deprecated
+  noframes: true, // Deprecated
+  noscript: true,
+  object: true,
+  ol: true,
+  optgroup: true,
+  option: true,
+  output: true,
+  p: true,
+  param: true, // Deprecated
+  picture: true,
+  plaintext: true, // Deprecated
+  portal: true, // Experimental
+  pre: true,
+  progress: true,
+  q: true,
+  rb: true, // Deprecated
+  rp: true,
+  rt: true,
+  rtc: true, // Deprecated
+  ruby: true,
+  s: true,
+  samp: true,
+  script: true,
+  search: true,
+  section: true,
+  select: true,
+  slot: true,
+  small: true,
+  source: true,
+  span: true,
+  strike: true, // Deprecated
+  strong: true,
+  style: true,
+  sub: true,
+  summary: true,
+  sup: true,
+  table: true,
+  tbody: true,
+  td: true,
+  template: true,
+  textarea: true,
+  tfoot: true,
+  th: true,
+  thead: true,
+  time: true,
+  title: true,
+  tr: true,
+  track: true,
+  tt: true, // Deprecated
+  u: true,
+  ul: true,
+  var: true,
+  video: true,
+  wbr: true,
+  xmp: true
+}
+
+export const invalidCustomTags = {
+  'annotation-xml': true,
+  'color-profile': true,
+  'font-face': true,
+  'font-face-src': true,
+  'font-face-uri': true,
+  'font-face-format': true,
+  'font-face-name': true,
+  'missing-glyph': true
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "coralite",
+  "version": "0.0.0-development",
+  "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://coralite.io",
+  "author": {
+    "name": "Thomas David",
+    "url": "https://thomasjackdavid.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tjdav/coralite.git"
+  },
+  "license": "MPL-2.0",
+  "scripts": {
+    "commitmsg": "commitlint -e",
+    "format": "eslint --cache --fix .",
+    "lint": "eslint --cache .",
+    "test-unit": "node --test test/lib/*",
+    "semantic-release": "semantic-release"
+  },
+  "bin": "bin/coralite.js",
+  "imports": {
+    "#lib": "./lib/index.js",
+    "#types": "./types/index.js"
+  },
+  "exports": {
+    "default": "./lib/coralite.js",
+    "types": "./types/index.js"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^11.0.1",
+    "@stylistic/eslint-plugin-js": "^2.12.1",
+    "@stylistic/eslint-plugin-plus": "^2.12.1",
+    "@types/node": "^22.10.5",
+    "semantic-release": "^24.2.1"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "acorn": "^8.14.0",
+    "commander": "^13.0.0",
+    "dom-serializer": "^2.0.0",
+    "eval-estree-expression": "^2.0.3",
+    "htmlparser2": "^10.0.0"
+  }
+}

package/release.config.js

@@ -0,0 +1,11 @@
+export default {
+  branches: ['main'],
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    ['@semantic-release/git', {
+      message: 'chore(release): ${nextRelease.version] [skip ci]\n\n${nextRelease.notes}'
+    }],
+    '@semantic-release/github'
+  ]
+}

package/types/index.js

@@ -0,0 +1,110 @@
+/**
+ * @typedef {Object} HTMLData
+ * @property {string} parentPath  - Path to the directory containing this file (e.g., '../my-component').
+ * @property {string} name - The file's name without extension (e.g., 'my-component').
+ * @property {string} content - The raw HTML string contents of the file.
+ */
+
+/**
+ * Represents the paths to Coralite pages and components within a project.
+ * @typedef {Object} CoralitePath
+ * @property {string} pages - The path to the root pages directory
+ * @property {string} components - The path to the root components directory
+ */
+
+/**
+ * @typedef {Object} CoraliteTokenOptions
+ * @property {Object.<string, string>} [default] - Default token values for properties not explicitly set
+ * @property {Object.<string, string[]>} [aliases] - Token aliases and their possible values
+ */
+
+
+/**
+ * @typedef {Object} CoraliteModule
+ * @property {string} id - Unique module identifier
+ * @property {CoraliteElement} template - Module's rendering template
+ * @property {string|undefined} script - Module's JavaScript raw code
+ * @property {CoraliteDocumentTokens} tokens - Tokens generated from the module's markup
+ * @property {CoraliteElement[]} customElements - Custom elements defined in the module
+ * @property {Object.<string, Object.<string,CoraliteModuleSlotElement>>} slotElements - Custom slot elements and their configurations
+ */
+
+/**
+ * @typedef {Object} CoraliteDocumentTokens
+ * @property {CoraliteAttributeToken[]} attributes - Array of attribute tokens from the document
+ * @property {CoraliteTextNodeToken[]} textNodes - Array of text node tokens from the document
+ */
+
+/**
+ * @typedef {Object} CoraliteToken
+ * @property {string} name - Token identifier
+ * @property {string} content - Token value or content
+ */
+
+/**
+ * @typedef {Object} CoraliteAttributeToken
+ * @property {string} name - Attribute token identifier
+ * @property {CoraliteElement} element - Corresponding HTML element for the attribute
+ * @property {CoraliteToken[]} tokens - Array of associated tokens
+ */
+
+/**
+ * @typedef {Object} CoraliteTextNodeToken
+ * @property {'text'} type - Type of text node ('text')
+ * @property {string} data - Text node raw data
+ * @property {CoraliteElement} parent - Parent element of the text node
+ */
+
+/**
+ * @typedef {Object} CoraliteModuleSlotElement
+ * @property {string} name - Slot element identifier
+ * @property {CoraliteElement} element - Corresponding HTML element for the slot
+ */
+
+/**
+ * @typedef {Object} CoraliteElement
+ * @property {'tag'} type - Element type
+ * @property {string} name - Tag name
+ * @property {Object.<string, string>} attribs - Element attributes
+ * @property {(CoraliteElement | CoraliteTextNode)[]} children - Child nodes of the element
+ * @property {CoraliteElement} parent - Parent element
+ * @property {number} [parentChildIndex] - Position in parent's child list
+ */
+
+
+/**
+ * @typedef {Object} CoraliteTextNode
+ * @property {'text'} type - Text node type
+ * @property {string} data - Additional attributes for the text node
+ * @property {CoraliteElement} parent - Parent element of the text node
+ */
+
+/**
+ * @typedef {Object} CoraliteSlotElement
+ * @property {string} name - Slot's unique identifier
+ * @property {CoraliteElement} customElement - Custom component for the slot
+ * @property {CoraliteElement} element - Corresponding HTML element for the slot
+ */
+
+/**
+ * @typedef {Object} CoraliteDirective
+ * @property {'directive'} type - Node type
+ * @property {string} data - Raw HTML Doctype
+ * @property {string} name - Doctype name
+ */
+
+/**
+ * @typedef {Object} CoraliteDocumentRoot
+ * @property {'root'} type - Node type
+ * @property {(CoraliteDirective | CoraliteElement | CoraliteTextNode)[]} children - Document list
+ */
+
+/**
+ * @typedef {Object} CoraliteDocument
+ * @property {string} name - Document file name
+ * @property {string} parentPath - Parent file path
+ * @property {CoraliteDocumentRoot} root - Array of elements and text nodes in the document
+ * @property {CoraliteElement[]} customElements - Custom elements defined in the document
+ * @property {Object.<string, CoraliteSlotElement[]>} customElementSlots - Slots with their respective elements
+ * @property {CoralitePath} path - Document's file path
+ */