3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-20 03:32:29 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor: move exported type definitions to declaration file (#6300)

Browse source 
* refactor: move exported type definitions to declaration file

* fix

* fix
This commit is contained in:
Joshua Chen 2022-01-09 22:02:31 +08:00 • committed by GitHub
parent 9c0e659a44
commit cf265c051e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
53 changed files with 482 additions and 452 deletions
Download patch file Download diff file Expand all files Collapse all files

2
packages/docusaurus-plugin-content-pages/src/__tests__/pluginOptionSchema.test.ts
View file

@ -6,7 +6,7 @@
*/
import {PluginOptionSchema, DEFAULT_OPTIONS} from '../pluginOptionSchema';
import type {PluginOptions} from '../types';
import type {PluginOptions} from '@docusaurus/plugin-content-pages';
export default function normalizePluginOptions(
options: Partial<PluginOptions>,

8
packages/docusaurus-plugin-content-pages/src/index.ts
View file

@ -31,12 +31,8 @@ import type {Configuration} from 'webpack';
import admonitions from 'remark-admonitions';
import {PluginOptionSchema} from './pluginOptionSchema';
import type {
PluginOptions,
LoadedContent,
Metadata,
PagesContentPaths,
} from './types';
import type {LoadedContent, Metadata, PagesContentPaths} from './types';
import type {PluginOptions} from '@docusaurus/plugin-content-pages';
export function getContentPathList(contentPaths: PagesContentPaths): string[] {
return [contentPaths.contentPathLocalized, contentPaths.contentPath];

14
packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts vendored
View file

@ -6,7 +6,19 @@
*/
declare module '@docusaurus/plugin-content-pages' {
export type Options = Partial<import('./types').PluginOptions>;
import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
export type PluginOptions = RemarkAndRehypePluginOptions & {
id?: string;
path: string;
routeBasePath: string;
include: string[];
exclude: string[];
mdxPageComponent: string;
admonitions: Record<string, unknown>;
};
export type Options = Partial<PluginOptions>;
}
declare module '@theme/MDXPage' {

2
packages/docusaurus-plugin-content-pages/src/pluginOptionSchema.ts
View file

@ -5,7 +5,7 @@
* LICENSE file in the root directory of this source tree.
*/
import type {PluginOptions} from './types';
import type {PluginOptions} from '@docusaurus/plugin-content-pages';
import {
Joi,
RemarkPluginsSchema,

12
packages/docusaurus-plugin-content-pages/src/types.ts
View file

@ -5,18 +5,6 @@
* LICENSE file in the root directory of this source tree.
*/
import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
export type PluginOptions = RemarkAndRehypePluginOptions & {
id?: string;
path: string;
routeBasePath: string;
include: string[];
exclude: string[];
mdxPageComponent: string;
admonitions: Record<string, unknown>;
};
export type JSXPageMetadata = {
type: 'jsx';
permalink: string;