Update changelog for bootstrap event, tweaks

Author: Gerrit0

CHANGELOG.md

@@ -1,11 +1,20 @@
 # Unreleased
 
+### Features
+
+-   Added a new `ParameterType.Object` for declaring object options which will be shallowly merged when read from user configuration.
+-   Added a new `Application.EVENT_BOOTSTRAP_END` event emitted when `Application.bootstrap` is called.
+
 ### Bug Fixes
 
 -   TypeDoc will now work properly in packages mode when converting packages outside the current working directory, #2043.
 -   Fixed deprecation warning for `isIdentifierOrPrivateIdentifier`.
 -   Fixed centering of title bar on wide displays, #2046.
 
+### Thanks!
+
+-   @citkane
+
 ## v0.23.11 (2022-08-26)
 
 ### Features

package-lock.json

@@ -35,15 +35,15 @@
   "devDependencies": {
     "@types/lunr": "^2.3.4",
     "@types/marked": "^4.0.6",
-    "@types/minimatch": "5.1.0",
+    "@types/minimatch": "5.1.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "14",
-    "@typescript-eslint/eslint-plugin": "^5.35.1",
-    "@typescript-eslint/parser": "^5.35.1",
+    "@typescript-eslint/eslint-plugin": "^5.36.1",
+    "@typescript-eslint/parser": "^5.36.1",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#b88cd06fe814614a0d924af9d10d04ff95a551de",
     "c8": "^7.12.0",
-    "esbuild": "^0.15.5",
-    "eslint": "^8.22.0",
+    "esbuild": "^0.15.6",
+    "eslint": "^8.23.0",
     "mocha": "^10.0.0",
     "prettier": "2.7.1",
     "puppeteer": "^13.5.2",

package.json

@@ -100,6 +100,13 @@ export class Application extends ChildableComponent<
      */
     static 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`.
+     */
+    static readonly EVENT_BOOTSTRAP_END = ApplicationEvents.BOOTSTRAP_END;
+
     /**
      * Create a new TypeDoc application instance.
      *

src/lib/application.ts

@@ -166,9 +166,8 @@ export function glob(
                 if (
                     mini.set.some((row) =>
                         mini.matchOne(
-                            // @ts-expect-error childPath really should be an array of strings, not a string.
-                            // https://github.com/DefinitelyTyped/DefinitelyTyped/pull/61956
                             childPath,
+                            // @ts-expect-error https://github.com/DefinitelyTyped/DefinitelyTyped/pull/62049
                             row,
                             /* partial */ true
                         )

src/lib/utils/fs.ts

@@ -1,11 +1,9 @@
 import {
-    deepStrictEqual,
     deepStrictEqual as equal,
     notDeepStrictEqual as notEqual,
     ok,
 } from "assert";
-import { Application } from "../lib/application";
-import { ApplicationEvents } from "../lib/application-events";
+import type { Application } from "../lib/application";
 import {
     DeclarationReflection,
     ProjectReflection,
@@ -20,7 +18,6 @@ import {
     IntrinsicType,
 } from "../lib/models";
 import type { InlineTagDisplayPart } from "../lib/models/comments/comment";
-import { ParameterType, TypeDocOptionMap } from "../lib/utils";
 import { getConverter2App } from "./programs";
 import type { TestLogger } from "./TestLogger";
 
@@ -728,40 +725,6 @@ export const issueTests: {
         );
     },
 
-    gh2024() {
-        const name = "objectOptions" as keyof TypeDocOptionMap;
-        const defaultValue = {
-            neverChange: "ok",
-            foo: "foo",
-        };
-        const app = new Application();
-        app.options.addDeclaration({
-            help: "Test option parsing with default values from plugins",
-            name,
-            type: ParameterType.Object,
-            defaultValue,
-        });
-        deepStrictEqual(app.options.getValue(name), defaultValue);
-        app.options.setValue(name, { foo: "bar" });
-        const newVal = app.options.getValue(name) as typeof defaultValue;
-        equal(newVal.foo, "bar");
-        equal(newVal.neverChange, "ok");
-        app.options.setValue("out", "testOutString");
-        app.on(ApplicationEvents.BOOTSTRAP_END, () => {
-            equal(app.options.getValue("out"), "");
-            app.options.setValue("out", "testOutString");
-            app.options.setValue(name, { foo: "foo" });
-        });
-        app.bootstrap();
-        app.options.setValue(name, {});
-        app.convert();
-        deepStrictEqual(app.options.getValue(name), defaultValue);
-        equal(
-            app.options.getValue("out").trim().endsWith("testOutString"),
-            true
-        );
-    },
-
     gh2031(project, logger) {
         const sig = query(project, "MyClass.aMethod").signatures![0];
         const summaryLink = sig.comment?.summary[0];

src/test/converter2/issues/gh2024.ts

@@ -345,6 +345,19 @@ describe("Options - conversions", () => {
             new Error("test must be an object")
         );
     });
+
+    it("Converts object options", () => {
+        const declaration: ObjectDeclarationOption = {
+            name: "test",
+            help: "",
+            type: ParameterType.Object,
+            defaultValue: { a: 1, b: 2 },
+        };
+        equal(convert({ b: 3 }, declaration, "", declaration.defaultValue), {
+            a: 1,
+            b: 3,
+        });
+    });
 });
 
 describe("Options - default values", () => {