123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
import { compile } from "../deps/pug.ts";import { join } from "../deps/path.ts";import loader from "../core/loaders/text.ts";import { merge } from "../core/utils/object.ts";
import type Site from "../core/site.ts";import type { Engine, Helper, HelperOptions } from "../core/renderer.ts";import type { Options as PugOptions } from "../deps/pug.ts";
export interface Options {  /** The list of extensions this plugin applies to */  extensions?: string[];
  /** Optional sub-extension for page files */  pageSubExtension?: string;
  /**   * Custom includes path   * @default `site.options.includes`   */  includes?: string;
  /**   * Options passed to Pug   * @see https://pugjs.org/api/reference.html#options   */  options?: PugOptions;}
// Default optionsexport const defaults: Options = {  extensions: [".pug"],  options: {},};
type Compiler = typeof compile;
/** Template engine to render Pug files */export class PugEngine implements Engine {  options: PugOptions;  compiler: Compiler;  filters: Record<string, Helper> = {};  cache = new Map<string, (data?: Record<string, unknown>) => string>();  basePath: string;  includes: string;
  constructor(    compiler: Compiler,    basePath: string,    includes: string,    options: PugOptions = {},  ) {    this.compiler = compiler;    this.options = options;    this.basePath = basePath;    this.includes = includes;  }
  deleteCache(): void {    this.cache.clear();  }
  render(    content: string,    data?: Record<string, unknown>,    filename?: string,  ): string {    return this.renderComponent(content, data, filename);  }
  renderComponent(    content: string,    data?: Record<string, unknown>,    filename?: string,  ): string {    const dataWithFilters = {      ...data,      filters: {        ...data?.filters || {},        ...this.filters,      },    };
    if (!filename) {      return this.compiler(content, this.options)(dataWithFilters);    }    if (!this.cache.has(filename)) {      this.cache.set(        filename,        this.compiler(content, {          ...this.options,          filename: join(this.basePath, filename),        }),      );    }
    return this.cache.get(filename)!(dataWithFilters);  }
  addHelper(name: string, fn: Helper, options: HelperOptions) {    switch (options.type) {      case "filter": {        this.options.filters ||= {};
        const filter: Helper = function (          text: string,          opt: Record<string, unknown>,        ) {          delete opt.filename;          const args = Object.values(opt);          return fn(text, ...args);        };
        this.filters[name] = fn;        this.options.filters[name] = filter;        return;      }    }  }}
/** Register the plugin to use Pug as a template engine */export default function (userOptions?: Options) {  return (site: Site) => {    const options = merge(      { ...defaults, includes: site.options.includes },      userOptions,    );    options.options.basedir = site.src(options.includes);
    const engine = new PugEngine(      compile,      site.src(),      options.includes,      options.options,    );
    // Ignore includes folder    if (options.includes) {      site.ignore(options.includes);    }
    // Load the pages and register the engine    site.loadPages(options.extensions, {      loader,      engine,    });
    // Register the pug filter    site.filter("pug", filter);
    function filter(string: string, data?: Record<string, unknown>): string {      return engine.render(string, { ...site.scopedData.get("/"), ...data });    }  };}
/** Extends Helpers interface */declare global {  namespace Lume {    export interface Helpers {      /** @see https://lume.land/plugins/pug/ */      pug: (string: string, data?: Record<string, unknown>) => string;    }  }}