typedoc 0.23.25 → 0.24.0-beta.1

package/bin/typedoc

@@ -2,133 +2,4 @@
 //@ts-check
 
 /* eslint-disable @typescript-eslint/no-var-requires */
-
-const ExitCodes = {
-    Ok: 0,
-    OptionError: 1,
-    NoEntryPoints: 2,
-    CompileError: 3,
-    ValidationError: 4,
-    OutputError: 5,
-    ExceptionThrown: 6,
-};
-
-const td = require("..");
-const { getOptionsHelp } = require("../dist/lib/utils/options/help");
-
-const app = new td.Application();
-
-app.options.addReader(new td.ArgumentsReader(0));
-app.options.addReader(new td.TypeDocReader());
-app.options.addReader(new td.TSConfigReader());
-app.options.addReader(new td.ArgumentsReader(300));
-
-app.bootstrap();
-
-run(app)
-    .catch((error) => {
-        console.error("TypeDoc exiting with unexpected error:");
-        console.error(error);
-        return ExitCodes.ExceptionThrown;
-    })
-    .then((exitCode) => (process.exitCode = exitCode));
-
-/** @param {td.Application} app */
-async function run(app) {
-    if (app.options.getValue("version")) {
-        console.log(app.toString());
-        return ExitCodes.Ok;
-    }
-
-    if (app.options.getValue("help")) {
-        console.log(getOptionsHelp(app.options));
-        return ExitCodes.Ok;
-    }
-
-    if (app.options.getValue("showConfig")) {
-        console.log(app.options.getRawValues());
-        return ExitCodes.Ok;
-    }
-
-    if (app.logger.hasErrors()) {
-        return ExitCodes.OptionError;
-    }
-    if (
-        app.options.getValue("treatWarningsAsErrors") &&
-        app.logger.hasWarnings()
-    ) {
-        return ExitCodes.OptionError;
-    }
-
-    if (app.options.getValue("entryPoints").length === 0) {
-        app.logger.error("No entry points provided");
-        return ExitCodes.NoEntryPoints;
-    }
-
-    if (app.options.getValue("watch")) {
-        app.convertAndWatch(async (project) => {
-            const out = app.options.getValue("out");
-            if (out) {
-                await app.generateDocs(project, out);
-            }
-            const json = app.options.getValue("json");
-            if (json) {
-                await app.generateJson(project, json);
-            }
-
-            if (!out && !json) {
-                await app.generateDocs(project, "./docs");
-            }
-        });
-        return ExitCodes.Ok;
-    }
-
-    const project = app.convert();
-    if (!project) {
-        return ExitCodes.CompileError;
-    }
-    if (
-        app.options.getValue("treatWarningsAsErrors") &&
-        app.logger.hasWarnings()
-    ) {
-        return ExitCodes.CompileError;
-    }
-
-    app.validate(project);
-    if (app.logger.hasErrors()) {
-        return ExitCodes.ValidationError;
-    }
-    if (
-        app.options.getValue("treatWarningsAsErrors") &&
-        app.logger.hasWarnings()
-    ) {
-        return ExitCodes.ValidationError;
-    }
-
-    if (app.options.getValue("emit") !== "none") {
-        const out = app.options.getValue("out");
-        if (out) {
-            await app.generateDocs(project, out);
-        }
-        const json = app.options.getValue("json");
-        if (json) {
-            await app.generateJson(project, json);
-        }
-
-        if (!out && !json) {
-            await app.generateDocs(project, "./docs");
-        }
-
-        if (app.logger.hasErrors()) {
-            return ExitCodes.OutputError;
-        }
-        if (
-            app.options.getValue("treatWarningsAsErrors") &&
-            app.logger.hasWarnings()
-        ) {
-            return ExitCodes.OutputError;
-        }
-    }
-
-    return ExitCodes.Ok;
-}
+require("../dist/lib/cli");

package/dist/index.d.ts

@@ -7,9 +7,8 @@ export { Converter, Context, type CommentParserConfig, type DeclarationReference
 export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
 export type { RenderTemplate, RendererHooks } from "./lib/output";
 export { ArgumentsReader, BindOption, CommentStyle, JSX, LogLevel, Logger, Options, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, } from "./lib/utils";
-export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, } from "./lib/utils";
+export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, EnumKeys, } from "./lib/utils";
 export type { EventMap, EventCallback } from "./lib/utils/events";
-export { JSONOutput, Serializer, type SerializerComponent, SerializeEvent, } from "./lib/serialization";
-export type { SerializeEventData } from "./lib/serialization";
-import TypeScript from "typescript";
+export { JSONOutput, Serializer, Deserializer, type Deserializable, type DeserializerComponent, type SerializerComponent, SerializeEvent, } from "./lib/serialization";
+import * as TypeScript from "typescript";
 export { TypeScript };

package/dist/index.js

@@ -10,14 +10,23 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.SerializeEvent = exports.Serializer = exports.JSONOutput = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.normalizePath = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
+exports.TypeScript = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.normalizePath = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
 var application_1 = require("./lib/application");
 Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });
 var events_1 = require("./lib/utils/events");
@@ -59,6 +68,7 @@ Object.defineProperty(exports, "MinimalSourceFile", { enumerable: true, get: fun
 var serialization_1 = require("./lib/serialization");
 Object.defineProperty(exports, "JSONOutput", { enumerable: true, get: function () { return serialization_1.JSONOutput; } });
 Object.defineProperty(exports, "Serializer", { enumerable: true, get: function () { return serialization_1.Serializer; } });
+Object.defineProperty(exports, "Deserializer", { enumerable: true, get: function () { return serialization_1.Deserializer; } });
 Object.defineProperty(exports, "SerializeEvent", { enumerable: true, get: function () { return serialization_1.SerializeEvent; } });
-const typescript_1 = __importDefault(require("typescript"));
-exports.TypeScript = typescript_1.default;
+const TypeScript = __importStar(require("typescript"));
+exports.TypeScript = TypeScript;

package/dist/lib/application-events.d.ts

@@ -1,3 +1,4 @@
 export declare const ApplicationEvents: {
     BOOTSTRAP_END: string;
+    REVIVE: string;
 };

package/dist/lib/application-events.js

@@ -3,4 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApplicationEvents = void 0;
 exports.ApplicationEvents = {
     BOOTSTRAP_END: "bootstrapEnd",
+    REVIVE: "reviveProject",
 };

package/dist/lib/application.d.ts

@@ -1,12 +1,12 @@
 import { Converter } from "./converter/index";
 import { Renderer } from "./output/renderer";
-import { Serializer } from "./serialization";
+import { Deserializer, Serializer } from "./serialization";
 import type { ProjectReflection } from "./models/index";
 import { Logger } from "./utils/index";
 import { AbstractComponent, ChildableComponent } from "./utils/component";
 import { Options } from "./utils";
 import type { TypeDocOptions } from "./utils/options/declaration";
-import { DocumentationEntryPoint } from "./utils/entry-point";
+import { DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-point";
 /**
  * The default TypeDoc main application class.
  *
@@ -33,35 +33,49 @@ export declare class Application extends ChildableComponent<Application, Abstrac
      * The serializer used to generate JSON output.
      */
     serializer: Serializer;
+    /**
+     * The deserializer used to restore previously serialized JSON output.
+     */
+    deserializer: Deserializer;
     /**
      * The logger that should be used to output messages.
      */
     logger: Logger;
     options: Options;
     /** @internal */
-    readonly loggerType: string | Function;
-    /** @internal */
     readonly skipErrorChecking: boolean;
+    /** @internal */
+    readonly entryPointStrategy: EntryPointStrategy;
+    /** @internal */
+    readonly entryPoints: string[];
     /**
      * The version number of TypeDoc.
      */
     static VERSION: string;
     /**
      * Emitted after plugins have been loaded and options have been read, but before they have been frozen.
-     * The listener will be given an instance of {@link Application} and the {@link TypeDocOptions | Partial<TypeDocOptions>}
-     * passed to `bootstrap`.
+     * The listener will be given an instance of {@link Application}.
      */
     static readonly EVENT_BOOTSTRAP_END: string;
+    /**
+     * Emitted after a project has been deserialized from JSON.
+     */
+    static readonly EVENT_PROJECT_REVIVE: string;
     /**
      * Create a new TypeDoc application instance.
+     *
+     * @param options An object containing the options that should be used.
      */
     constructor();
     /**
-     * Initialize TypeDoc with the given options object.
-     *
-     * @param options  The desired options to set.
+     * Initialize TypeDoc, loading plugins if applicable.
+     */
+    bootstrapWithPlugins(options?: Partial<TypeDocOptions>): Promise<void>;
+    /**
+     * Initialize TypeDoc without loading plugins.
      */
     bootstrap(options?: Partial<TypeDocOptions>): void;
+    private setOptions;
     /**
      * Return the path to the TypeScript compiler.
      */
@@ -85,7 +99,7 @@ export declare class Application extends ChildableComponent<Application, Abstrac
      */
     generateDocs(project: ProjectReflection, out: string): Promise<void>;
     /**
-     * Run the converter for the given set of files and write the reflections to a json file.
+     * Write the reflections to a json file.
      *
      * @param out The path and file name of the target file.
      * @returns Whether the JSON file could be written successfully.
@@ -95,4 +109,6 @@ export declare class Application extends ChildableComponent<Application, Abstrac
      * Print the version number.
      */
     toString(): string;
+    private _convertPackages;
+    private _merge;
 }

package/dist/lib/application.js

@@ -28,14 +28,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 var Application_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Application = void 0;
 const Path = __importStar(require("path"));
-const typescript_1 = __importDefault(require("typescript"));
+const ts = __importStar(require("typescript"));
 const index_1 = require("./converter/index");
 const renderer_1 = require("./output/renderer");
 const serialization_1 = require("./serialization");
@@ -51,6 +48,9 @@ const exports_1 = require("./validation/exports");
 const documentation_1 = require("./validation/documentation");
 const links_1 = require("./validation/links");
 const application_events_1 = require("./application-events");
+const tsconfig_1 = require("./utils/tsconfig");
+const fs_1 = require("./utils/fs");
+const abstract_1 = require("./models/reflections/abstract");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageInfo = require("../../package.json");
 const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
@@ -72,58 +72,61 @@ const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
 let Application = Application_1 = class Application extends component_1.ChildableComponent {
     /**
      * Create a new TypeDoc application instance.
+     *
+     * @param options An object containing the options that should be used.
      */
     constructor() {
         super(null); // We own ourselves
+        /**
+         * The serializer used to generate JSON output.
+         */
+        this.serializer = new serialization_1.Serializer();
+        /**
+         * The deserializer used to restore previously serialized JSON output.
+         */
+        this.deserializer = new serialization_1.Deserializer(this);
         this.logger = new index_2.ConsoleLogger();
         this.options = new utils_1.Options(this.logger);
-        this.options.addDefaultDeclarations();
-        this.serializer = new serialization_1.Serializer();
         this.converter = this.addComponent("converter", index_1.Converter);
         this.renderer = this.addComponent("renderer", renderer_1.Renderer);
     }
     /**
-     * Initialize TypeDoc with the given options object.
-     *
-     * @param options  The desired options to set.
+     * Initialize TypeDoc, loading plugins if applicable.
      */
-    bootstrap(options = {}) {
-        for (const [key, val] of Object.entries(options)) {
-            try {
-                this.options.setValue(key, val);
-            }
-            catch {
-                // Ignore errors, plugins haven't been loaded yet and may declare an option.
-            }
-        }
+    async bootstrapWithPlugins(options = {}) {
+        this.options.reset();
+        this.setOptions(options, /* reportErrors */ false);
         this.options.read(new index_2.Logger());
-        const logger = this.loggerType;
-        if (typeof logger === "function") {
-            this.logger = new index_2.CallbackLogger(logger);
-            this.options.setLogger(this.logger);
-        }
-        else if (logger === "none") {
-            this.logger = new index_2.Logger();
-            this.options.setLogger(this.logger);
-        }
         this.logger.level = this.options.getValue("logLevel");
-        const plugins = (0, index_2.discoverPlugins)(this);
-        (0, index_2.loadPlugins)(this, plugins);
+        await (0, index_2.loadPlugins)(this, this.options.getValue("plugin"));
+        this.bootstrap(options);
+    }
+    /**
+     * Initialize TypeDoc without loading plugins.
+     */
+    bootstrap(options = {}) {
         this.options.reset();
+        this.setOptions(options, /* reportErrors */ false);
+        this.options.read(this.logger);
+        this.setOptions(options);
+        this.logger.level = this.options.getValue("logLevel");
+        if ((0, general_1.hasBeenLoadedMultipleTimes)()) {
+            this.logger.warn(`TypeDoc has been loaded multiple times. This is commonly caused by plugins which have their own installation of TypeDoc. The loaded paths are:\n\t${(0, general_1.getLoadedPaths)().join("\n\t")}`);
+        }
+        this.trigger(application_events_1.ApplicationEvents.BOOTSTRAP_END, this);
+    }
+    setOptions(options, reportErrors = true) {
         for (const [key, val] of Object.entries(options)) {
             try {
                 this.options.setValue(key, val);
             }
             catch (error) {
                 (0, assert_1.ok)(error instanceof Error);
-                this.logger.error(error.message);
+                if (reportErrors) {
+                    this.logger.error(error.message);
+                }
             }
         }
-        this.options.read(this.logger);
-        if ((0, general_1.hasBeenLoadedMultipleTimes)()) {
-            this.logger.warn(`TypeDoc has been loaded multiple times. This is commonly caused by plugins which have their own installation of TypeDoc. The loaded paths are:\n\t${(0, general_1.getLoadedPaths)().join("\n\t")}`);
-        }
-        this.trigger(application_events_1.ApplicationEvents.BOOTSTRAP_END, this, options);
     }
     /**
      * Return the path to the TypeScript compiler.
@@ -132,7 +135,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         return (0, paths_1.nicePath)(Path.dirname(require.resolve("typescript")));
     }
     getTypeScriptVersion() {
-        return typescript_1.default.version;
+        return ts.version;
     }
     /**
      * Gets the entry points to be documented according to the current `entryPoints` and `entryPointStrategy` options.
@@ -148,11 +151,17 @@ let Application = Application_1 = class Application extends component_1.Childabl
      */
     convert() {
         const start = Date.now();
-        // We seal here rather than in the Converter class since TypeDoc's tests reuse the Application
+        // We freeze here rather than in the Converter class since TypeDoc's tests reuse the Application
         // with a few different settings.
         this.options.freeze();
         this.logger.verbose(`Using TypeScript ${this.getTypeScriptVersion()} from ${this.getTypeScriptPath()}`);
-        if (!supportedVersionMajorMinor.some((version) => version == typescript_1.default.versionMajorMinor)) {
+        if (this.entryPointStrategy === entry_point_1.EntryPointStrategy.Merge) {
+            return this._merge();
+        }
+        if (this.entryPointStrategy === entry_point_1.EntryPointStrategy.Packages) {
+            return this._convertPackages();
+        }
+        if (!supportedVersionMajorMinor.some((version) => version == ts.versionMajorMinor)) {
             this.logger.warn(`You are running with an unsupported TypeScript version! If TypeDoc crashes, this is why. TypeDoc supports ${supportedVersionMajorMinor.join(", ")}`);
         }
         const entryPoints = this.getEntryPoints();
@@ -163,7 +172,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         const programs = (0, array_1.unique)(entryPoints.map((e) => e.program));
         this.logger.verbose(`Converting with ${programs.length} programs ${entryPoints.length} entry points`);
         if (this.skipErrorChecking === false) {
-            const errors = programs.flatMap((program) => typescript_1.default.getPreEmitDiagnostics(program));
+            const errors = programs.flatMap((program) => ts.getPreEmitDiagnostics(program));
             if (errors.length) {
                 this.logger.diagnostics(errors);
                 return;
@@ -184,10 +193,10 @@ let Application = Application_1 = class Application extends component_1.Childabl
         this.options.freeze();
         if (!this.options.getValue("preserveWatchOutput") &&
             this.logger instanceof index_2.ConsoleLogger) {
-            typescript_1.default.sys.clearScreen?.();
+            ts.sys.clearScreen?.();
         }
         this.logger.verbose(`Using TypeScript ${this.getTypeScriptVersion()} from ${this.getTypeScriptPath()}`);
-        if (!supportedVersionMajorMinor.some((version) => version == typescript_1.default.versionMajorMinor)) {
+        if (!supportedVersionMajorMinor.some((version) => version == ts.versionMajorMinor)) {
             this.logger.warn(`You are running with an unsupported TypeScript version! TypeDoc supports ${supportedVersionMajorMinor.join(", ")}`);
         }
         if (Object.keys(this.options.getCompilerOptions()).length === 0) {
@@ -200,25 +209,25 @@ let Application = Application_1 = class Application extends component_1.Childabl
             return;
         }
         // Support for packages mode is currently unimplemented
-        if (this.options.getValue("entryPointStrategy") ===
-            entry_point_1.EntryPointStrategy.Packages) {
-            this.logger.error("The packages option of entryPointStrategy is not supported in watch mode.");
+        if (this.entryPointStrategy !== entry_point_1.EntryPointStrategy.Resolve &&
+            this.entryPointStrategy !== entry_point_1.EntryPointStrategy.Expand) {
+            this.logger.error("entryPointStrategy must be set to either resolve or expand for watch mode.");
             return;
         }
-        const tsconfigFile = index_2.TSConfigReader.findConfigFile(this.options.getValue("tsconfig")) ??
+        const tsconfigFile = (0, tsconfig_1.findTsConfigFile)(this.options.getValue("tsconfig")) ??
             "tsconfig.json";
         // We don't want to do it the first time to preserve initial debug status messages. They'll be lost
         // after the user saves a file, but better than nothing...
         let firstStatusReport = true;
-        const host = typescript_1.default.createWatchCompilerHost(tsconfigFile, {}, typescript_1.default.sys, typescript_1.default.createEmitAndSemanticDiagnosticsBuilderProgram, (diagnostic) => this.logger.diagnostic(diagnostic), (status, newLine, _options, errorCount) => {
+        const host = ts.createWatchCompilerHost(tsconfigFile, {}, ts.sys, ts.createEmitAndSemanticDiagnosticsBuilderProgram, (diagnostic) => this.logger.diagnostic(diagnostic), (status, newLine, _options, errorCount) => {
             if (!firstStatusReport &&
                 errorCount === void 0 &&
                 !this.options.getValue("preserveWatchOutput") &&
                 this.logger instanceof index_2.ConsoleLogger) {
-                typescript_1.default.sys.clearScreen?.();
+                ts.sys.clearScreen?.();
             }
             firstStatusReport = false;
-            this.logger.info(typescript_1.default.flattenDiagnosticMessageText(status.messageText, newLine));
+            this.logger.info(ts.flattenDiagnosticMessageText(status.messageText, newLine));
         });
         let successFinished = true;
         let currentProgram;
@@ -255,18 +264,21 @@ let Application = Application_1 = class Application extends component_1.Childabl
         };
         const origAfterProgramCreate = host.afterProgramCreate;
         host.afterProgramCreate = (program) => {
-            if (typescript_1.default.getPreEmitDiagnostics(program.getProgram()).length === 0) {
+            if (ts.getPreEmitDiagnostics(program.getProgram()).length === 0) {
                 currentProgram = program.getProgram();
                 runSuccess();
             }
             origAfterProgramCreate?.(program);
         };
-        typescript_1.default.createWatchProgram(host);
+        ts.createWatchProgram(host);
     }
     validate(project) {
         const checks = this.options.getValue("validation");
         const start = Date.now();
-        if (checks.notExported) {
+        // No point in validating exports when merging. Warnings will have already been emitted when
+        // creating the project jsons that this run merges together.
+        if (checks.notExported &&
+            this.entryPointStrategy !== entry_point_1.EntryPointStrategy.Merge) {
             (0, exports_1.validateExports)(project, this.logger, this.options.getValue("intentionallyNotExported"));
         }
         if (checks.notDocumented) {
@@ -293,7 +305,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         }
     }
     /**
-     * Run the converter for the given set of files and write the reflections to a json file.
+     * Write the reflections to a json file.
      *
      * @param out The path and file name of the target file.
      * @returns Whether the JSON file could be written successfully.
@@ -301,14 +313,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
     async generateJson(project, out) {
         const start = Date.now();
         out = Path.resolve(out);
-        const eventData = {
-            outputDirectory: Path.dirname(out),
-            outputFile: Path.basename(out),
-        };
-        const ser = this.serializer.projectToObject(project, {
-            begin: eventData,
-            end: eventData,
-        });
+        const ser = this.serializer.projectToObject(project, process.cwd());
         const space = this.options.getValue("pretty") ? "\t" : "";
         await (0, index_2.writeFile)(out, JSON.stringify(ser, null, space));
         this.logger.info(`JSON written to ${(0, paths_1.nicePath)(out)}`);
@@ -325,6 +330,68 @@ let Application = Application_1 = class Application extends component_1.Childabl
             "",
         ].join("\n");
     }
+    _convertPackages() {
+        const packageDirs = (0, entry_point_1.getPackageDirectories)(this.logger, this.options, this.options.getValue("entryPoints"));
+        if (packageDirs.length === 0) {
+            this.logger.error("Failed to find any packages, ensure you have provided at least one directory as an entry point containing package.json");
+            return;
+        }
+        const origOptions = this.options;
+        const projects = [];
+        // Generate a json file for each package
+        for (const dir of packageDirs) {
+            this.logger.info(`Converting project at ${(0, paths_1.nicePath)(dir)}`);
+            const opts = origOptions.copyForPackage();
+            // Invalid links should only be reported after everything has been merged.
+            opts.setValue("validation", { invalidLink: false });
+            opts.read(this.logger, dir);
+            if (opts.getValue("entryPointStrategy") ===
+                entry_point_1.EntryPointStrategy.Packages) {
+                this.logger.error(`Project at ${(0, paths_1.nicePath)(dir)} has entryPointStrategy set to packages, but nested packages are not supported.`);
+                continue;
+            }
+            this.options = opts;
+            const project = this.convert();
+            if (project) {
+                projects.push(this.serializer.projectToObject(project, process.cwd()));
+            }
+            (0, abstract_1.resetReflectionID)();
+        }
+        this.options = origOptions;
+        this.logger.info(`Merging converted projects`);
+        if (projects.length !== packageDirs.length) {
+            this.logger.error("Failed to convert one or more packages, result will not be merged together.");
+            return;
+        }
+        const result = this.deserializer.reviveProjects(this.options.getValue("name") || "Documentation", projects);
+        this.trigger(application_events_1.ApplicationEvents.REVIVE, result);
+        return result;
+    }
+    _merge() {
+        const start = Date.now();
+        const rootDir = (0, fs_1.getCommonDirectory)(this.entryPoints);
+        const entryPoints = this.entryPoints.flatMap((entry) => (0, fs_1.glob)(entry, rootDir));
+        this.logger.verbose(`Merging entry points:\n\t${entryPoints.map(paths_1.nicePath).join("\n\t")}`);
+        if (entryPoints.length < 1) {
+            this.logger.error("No entry points provided to merge.");
+            return;
+        }
+        const jsonProjects = entryPoints.map((path) => {
+            try {
+                return JSON.parse((0, fs_1.readFile)(path));
+            }
+            catch {
+                this.logger.error(`Failed to parse file at ${(0, paths_1.nicePath)(path)} as json.`);
+                return null;
+            }
+        });
+        if (this.logger.hasErrors())
+            return;
+        const result = this.deserializer.reviveProjects(this.options.getValue("name"), jsonProjects);
+        this.logger.verbose(`Reviving projects took ${Date.now() - start}ms`);
+        this.trigger(application_events_1.ApplicationEvents.REVIVE, result);
+        return result;
+    }
 };
 /**
  * The version number of TypeDoc.
@@ -332,16 +399,22 @@ let Application = Application_1 = class Application extends component_1.Childabl
 Application.VERSION = packageInfo.version;
 /**
  * Emitted after plugins have been loaded and options have been read, but before they have been frozen.
- * The listener will be given an instance of {@link Application} and the {@link TypeDocOptions | Partial<TypeDocOptions>}
- * passed to `bootstrap`.
+ * The listener will be given an instance of {@link Application}.
  */
 Application.EVENT_BOOTSTRAP_END = application_events_1.ApplicationEvents.BOOTSTRAP_END;
-__decorate([
-    (0, utils_1.BindOption)("logger")
-], Application.prototype, "loggerType", void 0);
+/**
+ * Emitted after a project has been deserialized from JSON.
+ */
+Application.EVENT_PROJECT_REVIVE = application_events_1.ApplicationEvents.REVIVE;
 __decorate([
     (0, utils_1.BindOption)("skipErrorChecking")
 ], Application.prototype, "skipErrorChecking", void 0);
+__decorate([
+    (0, utils_1.BindOption)("entryPointStrategy")
+], Application.prototype, "entryPointStrategy", void 0);
+__decorate([
+    (0, utils_1.BindOption)("entryPoints")
+], Application.prototype, "entryPoints", void 0);
 Application = Application_1 = __decorate([
     (0, component_1.Component)({ name: "application", internal: true })
 ], Application);

package/dist/lib/cli.d.ts

@@ -0,0 +1 @@
+export {};