default-options.test.ts

import { ok, throws, strictEqual, doesNotThrow } from "assert";
import { BUNDLED_THEMES } from "shiki";
import { Logger, Options } from "../../../lib/utils";

describe("Default Options", () => {
    const opts = new Options(new Logger());
    opts.addDefaultDeclarations();

    describe("Highlighting theme", () => {
        it("Errors if an invalid theme is provided", () => {
            throws(() =>
                opts.setValue("lightHighlightTheme", "randomTheme" as never)
            );
            opts.setValue("lightHighlightTheme", BUNDLED_THEMES[0]);
            strictEqual(
                opts.getValue("lightHighlightTheme"),
                BUNDLED_THEMES[0]
            );

            throws(() =>
                opts.setValue("darkHighlightTheme", "randomTheme" as never)
            );
            opts.setValue("darkHighlightTheme", BUNDLED_THEMES[0]);
            strictEqual(opts.getValue("darkHighlightTheme"), BUNDLED_THEMES[0]);
        });
    });

    describe("sort", () => {
        it("Errors if an invalid sort version is provided", () => {
            throws(() =>
                opts.setValue("sort", ["random", "alphabetical"] as never)
            );
        });

        it("Reports which sort option(s) was invalid", () => {
            try {
                opts.setValue("sort", [
                    "random",
                    "alphabetical",
                    "foo",
                ] as never);
            } catch (e) {
                ok(e instanceof Error);
                ok(e.message.includes("random"));
                ok(e.message.includes("foo"));
            }
        });
    });

    describe("markedOptions", () => {
        it("Errors if given a non-object", () => {
            throws(() => opts.setValue("markedOptions", null));
            throws(() => opts.setValue("markedOptions", "bad"));
            throws(() => opts.setValue("markedOptions", []));
        });
    });

    describe("compilerOptions", () => {
        it("Errors if given a non-object", () => {
            throws(() => opts.setValue("markedOptions", null));
            throws(() => opts.setValue("markedOptions", "bad"));
            throws(() => opts.setValue("markedOptions", []));
        });
    });

    describe("requiredToBeDocumented", () => {
        it("Works with valid values", () => {
            doesNotThrow(() =>
                opts.setValue("requiredToBeDocumented", ["Enum"])
            );
        });

        it("Throws on invalid values", () => {
            throws(() =>
                opts.setValue("requiredToBeDocumented", ["Enum2" as never])
            );
        });
    });

    describe("searchCategoryBoosts", () => {
        it("Should disallow non-objects", () => {
            throws(() => opts.setValue("searchCategoryBoosts", null as never));
        });

        it("Should disallow non-numbers", () => {
            throws(() =>
                opts.setValue("searchCategoryBoosts", {
                    cat: true as any as number,
                })
            );
        });
    });

    describe("searchGroupBoosts", () => {
        it("Should disallow non-objects", () => {
            throws(() => opts.setValue("searchGroupBoosts", null as never));
        });

        it("Should disallow non-numbers", () => {
            throws(() =>
                opts.setValue("searchGroupBoosts", {
                    Enum: true as any as number,
                })
            );
        });

        it("Should allow groups", () => {
            doesNotThrow(() => opts.setValue("searchGroupBoosts", { Enum: 5 }));
        });
    });

    describe("headerLinks", () => {
        it("Should disallow non-objects", () => {
            throws(() => opts.setValue("headerLinks", null as never));
        });

        it("Should disallow non-strings", () => {
            throws(() =>
                opts.setValue("headerLinks", {
                    "Home": true as any as string,
                })
            );
        });
    });

    describe("sidebarLinks", () => {
        it("Should disallow non-objects", () => {
            throws(() => opts.setValue("sidebarLinks", null as never));
        });

        it("Should disallow non-strings", () => {
            throws(() =>
                opts.setValue("sidebarLinks", {
                    "Home": true as any as string,
                })
            );
        });
    });
});