hikarujs/hikaru/compiler.js

A static site generator that generates routes based on directories naturally.

/**
 * @module compiler
 */

import * as path from "node:path";

import {checkType} from "./utils.js";

/**
 * @description Template compiler.
 */
class Compiler {
  /**
   * @param {Logger} logger
   * @return {Compiler}
   */
  constructor(logger) {
    this.logger = logger;
    this._ = new Map();
  }

  /**
   * @callback compileCallback
   * @description Typically you should configure your templating engines to load
   * template from your theme's layout dir.
   * @param {String} srcPath File path relative to your theme's layout dir.
   * @param {String} [content] If this is null, you need to manually load file.
   * @return {Function}
   */
  /**
   * @description Register a compile funtion.
   * @param {String} ext Template extname starts with `.`.
   * @param {compileCallback}
   */
  register(ext, fn) {
    checkType(ext, "ext", "String");
    checkType(fn, "fn", "Function");
    this._.set(ext, {ext, fn});
  }

  /**
   * @description Compile template into function.
   * @param {String} srcPath
   * @param {String} [content]
   * @return {Function}
   */
  async compile(srcPath, content) {
    const ext = path.extname(srcPath);
    if (!this._.has(ext)) {
      throw new Error(`No available compiler for \`${ext}\`.`);
    }
    const handler = this._.get(ext);
    return handler["fn"](srcPath, content);
  }
}

export default Compiler;