feat: added cname options for CNAME file

Author: matteobruni

.vscode/settings.json

@@ -1,7 +1,7 @@
 {
     "typescript.tsdk": "./node_modules/typescript/lib",
     "[typescript]": {
-        "editor.defaultFormatter": "esbenp.prettier-vscode"
+        "editor.defaultFormatter": "vscode.typescript-language-features"
     },
     "[typescriptreact]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"

src/lib/output/renderer.ts

@@ -82,8 +82,8 @@ export interface RendererHooks {
  */
 @Component({ name: "renderer", internal: true, childClass: RendererComponent })
 export class Renderer extends ChildableComponent<
-    Application,
-    RendererComponent
+Application,
+RendererComponent
 > {
     private themes = new Map<string, new (renderer: Renderer) => Theme>([
         ["default", DefaultTheme],
@@ -126,6 +126,10 @@ export class Renderer extends ChildableComponent<
     @BindOption("cleanOutputDir")
     cleanOutputDir!: boolean;
 
+    /** @internal */
+    @BindOption("cname")
+    cname!: string;
+
     /** @internal */
     @BindOption("gaID")
     gaID!: string;
@@ -317,8 +321,7 @@ export class Renderer extends ChildableComponent<
             const ctor = this.themes.get(this.themeName);
             if (!ctor) {
                 this.application.logger.error(
-                    `The theme '${
-                        this.themeName
+                    `The theme '${this.themeName
                     }' is not defined. The available themes are: ${[
                         ...this.themes.keys(),
                     ].join(", ")}`
@@ -376,6 +379,10 @@ export class Renderer extends ChildableComponent<
             }
         }
 
+        if (this.cname) {
+            fs.writeFileSync(path.join(directory, "CNAME"), this.cname);
+        }
+
         return true;
     }
 }

src/lib/utils/options/declaration.ts

@@ -91,6 +91,7 @@ export interface TypeDocOptionMap {
     defaultCategory: string;
     categoryOrder: string[];
     categorizeByGroup: boolean;
+    cname: string;
     sort: SortStrategy[];
     gitRevision: string;
     gitRemote: string;

src/lib/utils/options/sources/typedoc.ts

@@ -208,6 +208,10 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         type: ParameterType.Boolean,
         defaultValue: true,
     });
+    options.addDeclaration({
+        name: "cname",
+        help: "Set the CNAME file text, it's useful for custom domains on GitHub Pages.",
+    });
     options.addDeclaration({
         name: "sort",
         help: "Specify the sort strategy for documented values.",