Add tests for issue #2024

Author: citkane

src/test/converter2/issues/gh2024.ts

@@ -0,0 +1 @@
+() => null;

src/test/issueTests.ts

@@ -1,9 +1,11 @@
 import {
+    deepStrictEqual,
     deepStrictEqual as equal,
     notDeepStrictEqual as notEqual,
     ok,
 } from "assert";
-import type { Application } from "../lib/application";
+import { Application } from "../lib/application";
+import { ApplicationEvents } from "../lib/application-events";
 import {
     DeclarationReflection,
     ProjectReflection,
@@ -18,6 +20,7 @@ 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";
 
@@ -725,6 +728,40 @@ 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/utils/options/declaration.test.ts

@@ -7,6 +7,7 @@ import {
     getDefaultValue,
     MapDeclarationOption,
     MixedDeclarationOption,
+    ObjectDeclarationOption,
     NumberDeclarationOption,
     ParameterType,
     StringDeclarationOption,
@@ -321,6 +322,29 @@ describe("Options - conversions", () => {
             new Error("test must not be a number")
         );
     });
+    it("Passes through object", () => {
+        const data = {};
+        equal(convert(data, optionWithType(ParameterType.Object), ""), data);
+    });
+
+    it("Validates object options", () => {
+        const declaration: ObjectDeclarationOption = {
+            name: "test",
+            help: "",
+            type: ParameterType.Object,
+            defaultValue: "default",
+            validate: (value: unknown) => {
+                if (typeof value !== "object" || Array.isArray(value)) {
+                    throw new Error("test must be an object");
+                }
+            },
+        };
+        equal(convert({}, declaration, ""), {});
+        throws(
+            () => convert(1, declaration, ""),
+            new Error("test must be an object")
+        );
+    });
 });
 
 describe("Options - default values", () => {