1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
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;}