Skip to content

Commit a72a06e

Browse files
authored
fix(plugins): add missing validateOptions types (#10929)
Co-authored-by: slorber <[email protected]>
1 parent 04f7972 commit a72a06e

File tree

7 files changed

+237
-165
lines changed

7 files changed

+237
-165
lines changed

packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts

+10-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,12 @@ declare module '@docusaurus/plugin-content-blog' {
1616
FrontMatterLastUpdate,
1717
TagsPluginOptions,
1818
} from '@docusaurus/utils';
19-
import type {DocusaurusConfig, Plugin, LoadContext} from '@docusaurus/types';
19+
import type {
20+
DocusaurusConfig,
21+
Plugin,
22+
LoadContext,
23+
OptionValidationContext,
24+
} from '@docusaurus/types';
2025
import type {Item as FeedItem} from 'feed';
2126
import type {Overwrite} from 'utility-types';
2227

@@ -666,6 +671,10 @@ declare module '@docusaurus/plugin-content-blog' {
666671
context: LoadContext,
667672
options: PluginOptions,
668673
): Promise<Plugin<BlogContent>>;
674+
675+
export function validateOptions(
676+
args: OptionValidationContext<Options | undefined, PluginOptions>,
677+
): PluginOptions;
669678
}
670679

671680
declare module '@theme/BlogPostPage' {

packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts

+9-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,11 @@ declare module '@docusaurus/plugin-content-docs' {
2020
TagMetadata,
2121
TagsPluginOptions,
2222
} from '@docusaurus/utils';
23-
import type {Plugin, LoadContext} from '@docusaurus/types';
23+
import type {
24+
Plugin,
25+
LoadContext,
26+
OptionValidationContext,
27+
} from '@docusaurus/types';
2428
import type {Overwrite, Required} from 'utility-types';
2529

2630
export type Assets = {
@@ -559,6 +563,10 @@ declare module '@docusaurus/plugin-content-docs' {
559563
context: LoadContext,
560564
options: PluginOptions,
561565
): Promise<Plugin<LoadedContent>>;
566+
567+
export function validateOptions(
568+
args: OptionValidationContext<Options | undefined, PluginOptions>,
569+
): PluginOptions;
562570
}
563571

564572
declare module '@theme/DocItem' {

packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts

+9-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@
77

88
declare module '@docusaurus/plugin-content-pages' {
99
import type {MDXOptions} from '@docusaurus/mdx-loader';
10-
import type {LoadContext, Plugin} from '@docusaurus/types';
10+
import type {
11+
LoadContext,
12+
Plugin,
13+
OptionValidationContext,
14+
} from '@docusaurus/types';
1115
import type {FrontMatterLastUpdate, LastUpdateData} from '@docusaurus/utils';
1216

1317
export type Assets = {
@@ -82,6 +86,10 @@ declare module '@docusaurus/plugin-content-pages' {
8286
context: LoadContext,
8387
options: PluginOptions,
8488
): Promise<Plugin<LoadedContent | null>>;
89+
90+
export function validateOptions(
91+
args: OptionValidationContext<Options | undefined, PluginOptions>,
92+
): PluginOptions;
8593
}
8694

8795
declare module '@theme/MDXPage' {

project-words.txt

-1
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,6 @@ metastring
178178
metrica
179179
Metrika
180180
microdata
181-
Microdata
182181
Milnes
183182
mindmap
184183
Mindmap

website/docusaurus.config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ export default async function createConfigAsync() {
282282
},
283283
],
284284
[
285-
'./src/plugins/changelog/index.js',
285+
'./src/plugins/changelog/index.ts',
286286
{
287287
blogTitle: 'Docusaurus changelog',
288288
blogDescription:

website/src/plugins/changelog/index.js

-160
This file was deleted.

0 commit comments

Comments
 (0)