import { CosmiconfigResult } from 'cosmiconfig'; import * as rt from 'runtypes'; export declare const CONFIG_NAME = "api-docs-generator"; /** * Helper for finding the config file using cosmiconfig. */ export declare function findConfig(): Promise; /** * Helper for type validating config file. */ export declare function checkConfig(config: Config): Config; export declare const PreexistingModuleReleasesRecord: rt.Dictionary, string>; export type PreexistingModuleReleases = rt.Static; export declare const IncludeModulesModeUnion: rt.Union<[rt.Literal<"all">, rt.Literal<"latest">]>; export type IncludeModulesMode = rt.Static; declare const PluginOptionsRecord: rt.Intersect<[rt.Record<{ path: rt.Optional; }, false>, rt.Dictionary]>; export type PluginOptions = rt.Static; declare const PluginConfigRecord: rt.Union<[rt.String, rt.Tuple<[rt.String, rt.Intersect<[rt.Record<{ path: rt.Optional; }, false>, rt.Dictionary]>]>, rt.Constraint, string[], unknown>]>; /** * The plugin config is a tuple of plugin module names and objects containing plugin-specific options. * * Plugins will be imported from node_modules by name or from a path if specified. * * Example: * ``` * [ * 'plugin-module', * ['plugin-with-options', { path: './path/to/plugin.js' }] * ] * ``` */ export type PluginConfig = rt.Static; declare const ConfigOptionsRecord: rt.Record<{ inputDirectory: rt.Optional; outputDirectory: rt.Optional; documentationDirectory: rt.Optional; generatorsToRun: rt.Optional>; changelogStrategy: rt.Optional; minecraftReleaseVersion: rt.Optional; preexistingModuleReleases: rt.Optional, string>>; includeModulesMode: rt.Optional, rt.Literal<"latest">]>>; includeBaseModules: rt.Optional; skipMerging: rt.Optional; plugins: rt.Optional; }, false>, rt.Dictionary]>]>, rt.Constraint, string[], unknown>]>, false>>; generators: rt.Optional, string>>; log: rt.Optional, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>>; allMessages: rt.Optional, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>]>>; undocumentedApis: rt.Optional, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>]>>; unusedDocumentation: rt.Optional, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>]>>; unresolvedDependencies: rt.Optional, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>]>>; unresolvedTypes: rt.Optional, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>]>>; }, false>>; }, false>; /** * Options used by generate() that can be invoked through CLI. */ export type GenerateOptions = rt.Static & { configPath?: string; ignoreConfig?: boolean; }; /** * 'api-generator.config.mjs' config schema. */ export type Config = rt.Static; /** * Options from config files and generate() arguments. */ export type ConfigOptions = GenerateOptions & Config; export {};