| 1 | import type { OptionsReader } from "..";
|
| 2 | import type { Logger } from "../../loggers";
|
| 3 | import type { Options } from "../options";
|
| 4 | /**
|
| 5 | * Obtains option values from typedoc.json
|
| 6 | *
|
| 7 | * Changes need to happen here at some point. I think we should follow ESLint's new config
|
| 8 | * system eventually: https://eslint.org/blog/2022/08/new-config-system-part-1/
|
| 9 | */
|
| 10 | export declare class TypeDocReader implements OptionsReader {
|
| 11 | /**
|
| 12 | * Should run before the tsconfig reader so that it can specify a tsconfig file to read.
|
| 13 | */
|
| 14 | order: number;
|
| 15 | name: string;
|
| 16 | supportsPackages: boolean;
|
| 17 | /**
|
| 18 | * Read user configuration from a typedoc.json or typedoc.js configuration file.
|
| 19 | */
|
| 20 | read(container: Options, logger: Logger, cwd: string): Promise<void>;
|
| 21 | /**
|
| 22 | * Read the given options file + any extended files.
|
| 23 | * @param file
|
| 24 | * @param container
|
| 25 | * @param logger
|
| 26 | */
|
| 27 | private readFile;
|
| 28 | /**
|
| 29 | * Search for the configuration file given path
|
| 30 | *
|
| 31 | * @param path Path to the typedoc.(js|json) file. If path is a directory
|
| 32 | * typedoc file will be attempted to be found at the root of this path
|
| 33 | * @returns the typedoc.(js|json) file path or undefined
|
| 34 | */
|
| 35 | private findTypedocFile;
|
| 36 | }
|