123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
import { merge } from "../core/utils/object.ts";import binLoader from "../core/loaders/binary.ts";import textLoader from "../core/loaders/text.ts";import { Page } from "../core/file.ts";import Cache from "../core/cache.ts";import sharp, { create, sharpsToIco } from "../deps/sharp.ts";
import type Site from "../core/site.ts";
export interface Options {  /**   * The input file to generate the favicons   * Accepted formats are SVG, PNG, JPG, GIF, BMP, TIFF, WEBP   */  input?: string;
  /** The cache folder */  cache?: string | boolean;
  /**   * The generated favicons   * By default it follows the recommendations from:   * https://evilmartians.com/chronicles/how-to-favicon-in-2021-six-files-that-fit-most-needs   */  favicons?: Favicon[];}
export const defaults: Options = {  input: "/favicon.svg",  cache: true,  favicons: [    {      url: "/favicon.ico",      size: [48],      rel: "icon",      format: "ico",    },    {      url: "/apple-touch-icon.png",      size: [180],      rel: "apple-touch-icon",      format: "png",    },  ],};
export interface Favicon {  url: string;  size: number[];  rel: string;  format: string;}
export default function (userOptions?: Options) {  const options = merge(defaults, userOptions);
  return (site: Site) => {    // Configure the cache folder    const cacheFolder = options.cache === true ? "_cache" : options.cache;    const cache = cacheFolder      ? new Cache({ folder: site.src(cacheFolder) })      : undefined;
    if (cacheFolder) {      site.ignore(cacheFolder);      site.options.watcher.ignore.push(cacheFolder);    }
    async function getContent(): Promise<Uint8Array | string> {      const content = options.input.endsWith(".svg")        ? await site.getContent(options.input, textLoader)        : await site.getContent(options.input, binLoader);
      if (!content) {        throw new Error(`File not found: ${options.input}`);      }
      return content;    }
    site.addEventListener("afterRender", async (event) => {      const content = await getContent();
      for (const favicon of options.favicons) {        event.pages?.push(          Page.create({            url: favicon.url,            content: await buildIco(              content,              favicon.format as keyof sharp.FormatEnum,              favicon.size,              cache,            ),          }),        );      }
      // Add the svg favicon      if (        options.input.endsWith(".svg") &&        !site.pages.find((page) => page.data.url === options.input) &&        !site.files.find((file) => file.outputPath === options.input)      ) {        event.pages?.push(          Page.create({            url: options.input,            content: await site.getContent(              options.input,              textLoader,            ) as string,          }),        );      }    });
    site.process([".html"], (pages) => {      for (const page of pages) {        const document = page.document!;
        for (const favicon of options.favicons) {          addIcon(document, {            rel: favicon.rel,            sizes: favicon.size.map((s) => `${s}x${s}`).join(" "),            href: site.url(favicon.url),          });        }
        if (options.input.endsWith(".svg")) {          addIcon(document, {            rel: "icon",            sizes: "any",            href: site.url(options.input),            type: "image/svg+xml",          });        }      }    });  };}
function addIcon(document: Document, attributes: Record<string, string>) {  const link = document.createElement("link");  for (const [key, value] of Object.entries(attributes)) {    link.setAttribute(key, value);  }  document.head.appendChild(link);  document.head.appendChild(document.createTextNode("\n"));}
async function buildIco(  content: Uint8Array | string,  format: keyof sharp.FormatEnum | "ico",  size: number[],  cache?: Cache,): Promise<Uint8Array> {  if (cache) {    const result = await cache.get(content, { format, size });
    if (result) {      return result;    }  }
  let image: Uint8Array;
  if (format === "ico") {    const resizeOptions = { background: { r: 0, g: 0, b: 0, alpha: 0 } };    const img = await create(content);    image = await sharpsToIco(      ...size.map((size) => img.clone().resize(size, size, resizeOptions)),    );  } else {    image = await (await create(content))      .resize(size[0], size[0])      .toFormat(format)      .toBuffer();  }
  if (cache) {    cache.set(content, { format, size }, image);  }
  return image;}