Remove favicon option

Drarig29 · Drarig29 · commit 070ce1a298ac · 2025-01-07T18:25:24.000+01:00
Fixes #23
diff --git a/README.md b/README.md
@@ -8,7 +8,6 @@ A [TypeDoc](https://github.com/TypeStrong/typedoc) plugin to add extras to the o
 
 It allows you to:
 
-- Set a custom favicon.
 - Add the date/time of generation after "Generated using TypeDoc" in the footer. (cf. the [example](#example) below)
 - Set a custom top-most title name (without changing the package name, like `--name` would do).
   - For example, you could have `--customTitle "Go back" --titleLink <url-of-your-parent-documentation>`
@@ -20,6 +19,9 @@ All extras are disabled by default: they are opt-in.
 
 Feel free to ask for another extra or to make a PR 😉
 
+> [!IMPORTANT]  
+> TypeDoc [now natively supports specifying a favicon](https://typedoc.org/documents/Options.Output.html#favicon). Consequently, the `--favicon` option in this plugin has been removed to prevent conflicts.
+
 ## Example
 
 ![example](./public/example.png)
@@ -52,11 +54,6 @@ The following arguments can be used in addition to the default [TypeDoc argument
   Specify a custom `<meta name="description"` property.<br>
   Example: `An example description`
 
-- `--favicon`<br>
-  Specify the path or URL of the favicon file.<br>
-  Example: `public/favicon.ico`<br>
-  **Note:** If given a path, the favicon file is copied into the documentation's output directory (`--out`).
-
 - `--footerTypedocVersion`<br>
   Appends the TypeDoc version in the footer.<br>
   Default: `false`
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -1,36 +1,6 @@
 import type { Application } from "typedoc";
 import type { PluginOptions } from "./main.js";
 
-/**
- * Creates a relative path from a host file to a target file which is located in the root.
- * @example `modules/_index_.html` --> `../favicon.ico`
- * @param hostPath The path of the file which will contain the resulting relative path.
- * @param targetFilename The name of the target file.
- */
-export function makeRelativeToRoot(hostPath: string, targetFilename: string): string {
-    // Find separators.
-    const match = hostPath.match(/[/\\]/g);
-    if (!match) return targetFilename;
-
-    // Create path with one '../' per separator and targetFilename at the end.
-    const separatorCount = match.length;
-    const parts = [...Array(separatorCount).fill('..'), targetFilename];
-    return parts.join('/');
-}
-
-/**
- * Appends a favicon link at the end of `<head>` in the given html.
- * @param html HTML string to append to.
- * @param url URL of the favicon.
- */
-export function appendFavicon(html: string, url: string): string {
-    return html.replace('</head>',
-        `<link rel="icon" href="${url}" />` +
-        '\n' + // Push the end of <head> to the next line.
-        '</head>'
-    );
-}
-
 /**
  * Appends a string value after "Generated using TypeDoc".
  * @param html HTML string to append to.
@@ -56,14 +26,6 @@ export function setupNewlineInFooter(html: string): string {
     );
 }
 
-/**
- * Determines whether a string is a URL.
- * @param url The URL to check.
- */
-export function isUrl(url: string): boolean {
-    return /^https?:\/\//i.test(url);
-}
-
 /**
  * Replaces the top-most title text.
  * @param html HTML string to replace into.
diff --git a/src/main.ts b/src/main.ts
@@ -1,11 +1,6 @@
 import { Application, ParameterType, PageEvent, RendererEvent } from 'typedoc';
-import { join, basename } from 'path';
-import { copyFileSync } from 'fs';
 import {
-    appendFavicon,
     appendToFooter,
-    makeRelativeToRoot,
-    isUrl,
     replaceTopMostTitle,
     replaceDescription,
     setupNewlineInFooter,
@@ -24,7 +19,6 @@ export const pluginOptions = (app: Application) => ({
         return {
             outDir: app.options.getValue('out') as string | undefined,
             hideGenerator: app.options.getValue('hideGenerator') as boolean,
-            favicon: app.options.getValue('favicon') as string | undefined,
             footerDate: app.options.getValue('footerDate') as boolean,
             footerTime: app.options.getValue('footerTime') as boolean,
             footerLastModified: app.options.getValue('footerLastModified') as boolean,
@@ -39,13 +33,6 @@ export type PluginOptionsGetter = ReturnType<typeof pluginOptions>;
 export type PluginOptions = ReturnType<PluginOptionsGetter['options']>;
 
 export function load(app: Application) {
-    app.options.addDeclaration({
-        name: 'favicon',
-        help: 'Extras Plugin: Specify the name of the favicon file.',
-        type: ParameterType.String,
-        defaultValue: undefined
-    });
-
     app.options.addDeclaration({
         name: 'footerTypedocVersion',
         help: 'Extras Plugin: Appends the TypeDoc version in the footer.',
@@ -101,7 +88,6 @@ export function load(app: Application) {
     const options = pluginOptions(app);
 
     app.renderer.on(PageEvent.END, onPageRendered.bind(options));
-    app.renderer.on(RendererEvent.END, onRenderFinished.bind(options));
 }
 
 function onPageRendered(this: PluginOptionsGetter, page: PageEvent) {
@@ -110,15 +96,6 @@ function onPageRendered(this: PluginOptionsGetter, page: PageEvent) {
 
     const options = this.options();
 
-    // Add icon.
-    if (options.favicon) {
-        const favicon = isUrl(options.favicon)
-            ? options.favicon
-            : makeRelativeToRoot(page.url, basename(options.favicon));
-
-        page.contents = appendFavicon(page.contents, favicon);
-    }
-
     // Add TypeDoc version.
     if (options.footerTypedocVersion) {
         page.contents = appendToFooter(page.contents, ` v${TYPEDOC_VERSION}`);
@@ -159,20 +136,3 @@ function onPageRendered(this: PluginOptionsGetter, page: PageEvent) {
     }
 }
 
-function onRenderFinished(this: PluginOptionsGetter) {
-    const options = this.options()
-
-    // Copy favicon to output directory.
-    if (options.favicon && !isUrl(options.favicon)) {
-        const workingDir = process.cwd();
-        const outDir = options.outDir || './docs';
-
-        const inputFavicon = (options.favicon.indexOf(workingDir) === -1) ?
-            join(workingDir, options.favicon) : options.favicon;
-
-        const outputFavicon = (outDir.indexOf(workingDir) === -1) ?
-            join(workingDir, outDir, basename(options.favicon)) : join(outDir, basename(options.favicon));
-
-        copyFileSync(inputFavicon, outputFavicon);
-    }
-}
