fix(core): mark option object properties optional

Author: tgreyuk

.changeset/fresh-cows-check.md

@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Mark object properties as optional in PluginOptions interface (#777).

devtools/packages/prebuild-options/tasks/generate-models.ts

@@ -214,7 +214,7 @@ function getType(
   }
   if (option.type === ParameterType.Flags && option.defaults) {
     return `{${Object.keys(option.defaults)
-      .map((key) => `'${key}': boolean`)
+      .map((key) => `'${key}'?: boolean`)
       .join(';')}}`;
   }
   if (option.type === ParameterType.Mixed && option.defaultValue) {

packages/typedoc-plugin-markdown/src/_typedoc.d.ts

@@ -32,9 +32,9 @@ declare module 'typedoc' {
     mergeReadme: boolean;
     modulesFileName: string;
     navigationModel: {
-      excludeGroups: boolean;
-      excludeCategories: boolean;
-      excludeFolders: boolean;
+      excludeGroups?: boolean;
+      excludeCategories?: boolean;
+      excludeFolders?: boolean;
     };
     outputFileStrategy: 'members' | 'modules';
     pageTitleTemplates: {
@@ -54,13 +54,13 @@ declare module 'typedoc' {
     publicPath: string;
     sanitizeComments: boolean;
     tableColumnSettings: {
-      hideDefaults: boolean;
-      hideInherited: boolean;
-      hideModifiers: boolean;
-      hideOverrides: boolean;
-      hideSources: boolean;
-      hideValues: boolean;
-      leftAlignHeaders: boolean;
+      hideDefaults?: boolean;
+      hideInherited?: boolean;
+      hideModifiers?: boolean;
+      hideOverrides?: boolean;
+      hideSources?: boolean;
+      hideValues?: boolean;
+      leftAlignHeaders?: boolean;
     };
     textContentMappings: ManuallyValidatedOption<{
       'header.title': string;

packages/typedoc-plugin-markdown/src/theme/navigation/navigation-builder.ts

@@ -20,9 +20,9 @@ export class NavigationBuilder {
   private options: Options;
   private packagesMeta: any;
   private navigationOptions: {
-    excludeCategories: boolean;
-    excludeGroups: boolean;
-    excludeFolders: boolean;
+    excludeCategories?: boolean;
+    excludeGroups?: boolean;
+    excludeFolders?: boolean;
   };
   private navigation: NavigationItem[] = [];
   private isPackages: boolean;

packages/typedoc-plugin-markdown/src/types/options.ts

@@ -127,9 +127,9 @@ export interface PluginOptions {
    * @deprecated This option has been deprecated in favour of TypeDoc `navigation` option.
    */
   navigationModel: {
-    excludeGroups: boolean;
-    excludeCategories: boolean;
-    excludeFolders: boolean;
+    excludeGroups?: boolean;
+    excludeCategories?: boolean;
+    excludeFolders?: boolean;
   };
 
   /**
@@ -189,13 +189,13 @@ export interface PluginOptions {
    * Control how table columns are configured and displayed.
    */
   tableColumnSettings: {
-    hideDefaults: boolean;
-    hideInherited: boolean;
-    hideModifiers: boolean;
-    hideOverrides: boolean;
-    hideSources: boolean;
-    hideValues: boolean;
-    leftAlignHeaders: boolean;
+    hideDefaults?: boolean;
+    hideInherited?: boolean;
+    hideModifiers?: boolean;
+    hideOverrides?: boolean;
+    hideSources?: boolean;
+    hideValues?: boolean;
+    leftAlignHeaders?: boolean;
   };
 
   /**

packages/typedoc-plugin-remark/src/_typedoc.d.ts

@@ -3,7 +3,11 @@ import { ManuallyValidatedOption } from 'typedoc';
 import { RemarkPlugin } from './types/options.js';
 declare module 'typedoc' {
   export interface TypeDocOptionMap {
-    defaultRemarkPlugins: { gfm: boolean; frontmatter: boolean; mdx: boolean };
+    defaultRemarkPlugins: {
+      gfm?: boolean;
+      frontmatter?: boolean;
+      mdx?: boolean;
+    };
     remarkPlugins: ManuallyValidatedOption<RemarkPlugin[]>;
     remarkStringifyOptions: ManuallyValidatedOption<Record<string, any>>;
   }

packages/typedoc-plugin-remark/src/types/options.ts

@@ -9,7 +9,7 @@ export interface PluginOptions {
   /**
    * A set of flags that control the enabling or disabling of remark plugins that are loaded by default.
    */
-  defaultRemarkPlugins: { gfm: boolean; frontmatter: boolean; mdx: boolean };
+  defaultRemarkPlugins: { gfm?: boolean; frontmatter?: boolean; mdx?: boolean };
 
   /**
    * An array of remark plugin names to be executed.