Mark TypeDocOptions members as optional

Resolves #2901

Author: Gerrit0

CHANGELOG.md

@@ -4,6 +4,11 @@ title: Changelog
 
 ## Unreleased
 
+### Features
+
+- The `TypeDocOptions` interface now marks options as optional so it no longer has to be wrapped in `Partial`
+  for use in config files, #2901.
+
 ### Bug Fixes
 
 - `--watch` can now infer entry points from `package.json` as supported in non-watch mode, #2899.

src/lib/application.ts

@@ -219,7 +219,7 @@ export class Application extends AbstractComponent<
      * Initialize TypeDoc, loading plugins if applicable.
      */
     static async bootstrapWithPlugins(
-        options: Partial<TypeDocOptions> = {},
+        options: TypeDocOptions = {},
         readers: readonly OptionsReader[] = DEFAULT_READERS,
     ): Promise<Application> {
         const app = new Application(DETECTOR);
@@ -250,7 +250,7 @@ export class Application extends AbstractComponent<
      * @param readers Option readers to use to discover options from config files.
      */
     static async bootstrap(
-        options: Partial<TypeDocOptions> = {},
+        options: TypeDocOptions = {},
         readers: readonly OptionsReader[] = DEFAULT_READERS,
     ): Promise<Application> {
         const app = new Application(DETECTOR);
@@ -259,7 +259,7 @@ export class Application extends AbstractComponent<
         return app;
     }
 
-    private async _bootstrap(options: Partial<TypeDocOptions>) {
+    private async _bootstrap(options: TypeDocOptions) {
         this.options.reset();
         this.setOptions(options, /* reportErrors */ false);
         this.internationalization.setLocale(this.lang);
@@ -319,7 +319,7 @@ export class Application extends AbstractComponent<
     }
 
     /** @internal */
-    setOptions(options: Partial<TypeDocOptions>, reportErrors = true) {
+    setOptions(options: TypeDocOptions, reportErrors = true) {
         let success = true;
         for (const [key, val] of Object.entries(options)) {
             try {

src/lib/utils/options/declaration.ts

@@ -39,7 +39,7 @@ export type CommentStyle = (typeof CommentStyle)[keyof typeof CommentStyle];
 export type OutputSpecification = {
     name: string;
     path: string;
-    options?: Partial<TypeDocOptions>;
+    options?: TypeDocOptions;
 };
 
 /**
@@ -118,7 +118,7 @@ export const rootPackageOptions = [
  * @interface
  */
 export type TypeDocOptions = {
-    [K in keyof TypeDocOptionMap]: unknown extends TypeDocOptionMap[K] ? unknown :
+    [K in keyof TypeDocOptionMap]?: unknown extends TypeDocOptionMap[K] ? unknown :
         TypeDocOptionMap[K] extends ManuallyValidatedOption<
             infer ManuallyValidated
         > ? ManuallyValidated :
@@ -138,6 +138,7 @@ export type TypeDocOptions = {
  * Describes all TypeDoc specific options as returned by {@link Options.getValue}, this is
  * slightly more restrictive than the {@link TypeDocOptions} since it does not allow both
  * keys and values for mapped option types, and does not allow partials of flag values.
+ * It also does not mark keys as optional.
  * @interface
  */
 export type TypeDocOptionValues = {
@@ -186,7 +187,7 @@ export interface TypeDocOptionMap {
     lang: string;
     locales: ManuallyValidatedOption<Record<string, Record<string, string>>>;
     packageOptions: ManuallyValidatedOption<
-        Partial<TypeDocPackageOptions>
+        TypeDocPackageOptions
     >;
 
     // Input

src/lib/utils/options/options.ts

@@ -270,7 +270,7 @@ export class Options {
     /**
      * Gets all of the TypeDoc option values defined in this option container.
      */
-    getRawValues(): Readonly<Partial<TypeDocOptions>> {
+    getRawValues(): Readonly<Partial<TypeDocOptionValues>> {
         return this._values;
     }
 
@@ -303,7 +303,7 @@ export class Options {
      */
     setValue<K extends keyof TypeDocOptions>(
         name: K,
-        value: TypeDocOptions[K],
+        value: Exclude<TypeDocOptions[K], undefined>,
         configPath?: string,
     ): void;
     setValue(

src/test/programs.ts

@@ -42,7 +42,7 @@ export function getConverterApp() {
                     gitRevision: "fake",
                     readme: "none",
                     skipErrorChecking: true,
-                } satisfies Partial<TypeDocOptions>,
+                } satisfies TypeDocOptions,
             )
         ) {
             converterApp.options.setValue(name as never, value as never);
@@ -119,7 +119,7 @@ export function getConverter2App() {
                     tsconfig: join(getConverter2Base(), "tsconfig.json"),
                     validation: true,
                     skipErrorChecking: true,
-                } satisfies Partial<TypeDocOptions>,
+                } satisfies TypeDocOptions,
             )
         ) {
             converter2App.options.setValue(name as never, value as never);