Skip to content

Commit

Permalink
fix(plugins): add missing validateOptions types (#10929)
Browse files Browse the repository at this point in the history
Co-authored-by: slorber <[email protected]>
  • Loading branch information
slorber and slorber authored Feb 13, 2025
1 parent 04f7972 commit a72a06e
Show file tree
Hide file tree
Showing 7 changed files with 237 additions and 165 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,12 @@ declare module '@docusaurus/plugin-content-blog' {
FrontMatterLastUpdate,
TagsPluginOptions,
} from '@docusaurus/utils';
import type {DocusaurusConfig, Plugin, LoadContext} from '@docusaurus/types';
import type {
DocusaurusConfig,
Plugin,
LoadContext,
OptionValidationContext,
} from '@docusaurus/types';
import type {Item as FeedItem} from 'feed';
import type {Overwrite} from 'utility-types';

Expand Down Expand Up @@ -666,6 +671,10 @@ declare module '@docusaurus/plugin-content-blog' {
context: LoadContext,
options: PluginOptions,
): Promise<Plugin<BlogContent>>;

export function validateOptions(
args: OptionValidationContext<Options | undefined, PluginOptions>,
): PluginOptions;
}

declare module '@theme/BlogPostPage' {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ declare module '@docusaurus/plugin-content-docs' {
TagMetadata,
TagsPluginOptions,
} from '@docusaurus/utils';
import type {Plugin, LoadContext} from '@docusaurus/types';
import type {
Plugin,
LoadContext,
OptionValidationContext,
} from '@docusaurus/types';
import type {Overwrite, Required} from 'utility-types';

export type Assets = {
Expand Down Expand Up @@ -559,6 +563,10 @@ declare module '@docusaurus/plugin-content-docs' {
context: LoadContext,
options: PluginOptions,
): Promise<Plugin<LoadedContent>>;

export function validateOptions(
args: OptionValidationContext<Options | undefined, PluginOptions>,
): PluginOptions;
}

declare module '@theme/DocItem' {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@

declare module '@docusaurus/plugin-content-pages' {
import type {MDXOptions} from '@docusaurus/mdx-loader';
import type {LoadContext, Plugin} from '@docusaurus/types';
import type {
LoadContext,
Plugin,
OptionValidationContext,
} from '@docusaurus/types';
import type {FrontMatterLastUpdate, LastUpdateData} from '@docusaurus/utils';

export type Assets = {
Expand Down Expand Up @@ -82,6 +86,10 @@ declare module '@docusaurus/plugin-content-pages' {
context: LoadContext,
options: PluginOptions,
): Promise<Plugin<LoadedContent | null>>;

export function validateOptions(
args: OptionValidationContext<Options | undefined, PluginOptions>,
): PluginOptions;
}

declare module '@theme/MDXPage' {
Expand Down
1 change: 0 additions & 1 deletion project-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,6 @@ metastring
metrica
Metrika
microdata
Microdata
Milnes
mindmap
Mindmap
Expand Down
2 changes: 1 addition & 1 deletion website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ export default async function createConfigAsync() {
},
],
[
'./src/plugins/changelog/index.js',
'./src/plugins/changelog/index.ts',
{
blogTitle: 'Docusaurus changelog',
blogDescription:
Expand Down
160 changes: 0 additions & 160 deletions website/src/plugins/changelog/index.js

This file was deleted.

Loading

0 comments on commit a72a06e

Please sign in to comment.