@ts-for-gir/generator-html-doc/src/html-doc-generator.ts

HTML Documentation generator for ts-for-gir

import type { Generator } from "@ts-for-gir/generator-base";
import type { GirModule, NSRegistry, OptionsGeneration } from "@ts-for-gir/lib";
import { DANGER_HTML_DOC_GENERATOR_NOT_IMPLEMENTED, Logger } from "@ts-for-gir/lib";

/**
 * A template that can be used to implement an HTML Documentation Generator
 */
export class HtmlDocGenerator implements Generator {
	protected log: Logger;
	protected readonly config: OptionsGeneration;
	protected readonly registry: NSRegistry;
	constructor(config: OptionsGeneration, registry: NSRegistry) {
		this.config = config;
		this.registry = registry;
		this.log = new Logger(config.verbose, HtmlDocGenerator.name);
	}

	async start(): Promise<void> {
		return Promise.resolve(this.log.danger(DANGER_HTML_DOC_GENERATOR_NOT_IMPLEMENTED));
	}

	generate(_module: GirModule): Promise<void> {
		throw new Error("Method not implemented.");
	}

	finish(_girModules: GirModule[]): Promise<void> {
		throw new Error("Method not implemented.");
	}
}