feat(core): add new plugin allContentLoaded lifecycle (#9931)

facebook · Mar 8, 2024 · 8d115a9 · 8d115a9
1 parent d02b96f
commit 8d115a9
Show file tree

Hide file tree

Showing 7 changed files with 787 additions and 224 deletions.
diff --git a/packages/docusaurus-plugin-debug/src/index.ts b/packages/docusaurus-plugin-debug/src/index.ts
@@ -30,7 +30,7 @@ export default function pluginDebug({
       return '../src/theme';
     },
 
-    async contentLoaded({actions: {createData, addRoute}, allContent}) {
+    async allContentLoaded({actions: {createData, addRoute}, allContent}) {
       const allContentPath = await createData(
         // Note that this created data path must be in sync with
         // metadataPath provided to mdx-loader.

diff --git a/packages/docusaurus-types/src/plugin.d.ts b/packages/docusaurus-types/src/plugin.d.ts
@@ -18,11 +18,11 @@ import type {RouteConfig} from './routing';
 
 export type PluginOptions = {id?: string} & {[key: string]: unknown};
 
-export type PluginConfig =
+export type PluginConfig<Content = unknown> =
   | string
   | [string, PluginOptions]
-  | [PluginModule, PluginOptions]
-  | PluginModule
+  | [PluginModule<Content>, PluginOptions]
+  | PluginModule<Content>
   | false
   | null;
 
@@ -110,7 +110,9 @@ export type Plugin<Content = unknown> = {
   contentLoaded?: (args: {
     /** The content loaded by this plugin instance */
     content: Content; //
-    /** Content loaded by ALL the plugins */
+    actions: PluginContentLoadedActions;
+  }) => Promise<void> | void;
+  allContentLoaded?: (args: {
     allContent: AllContent;
     actions: PluginContentLoadedActions;
   }) => Promise<void> | void;
@@ -183,8 +185,10 @@ export type LoadedPlugin = InitializedPlugin & {
   readonly content: unknown;
 };
 
-export type PluginModule = {
-  (context: LoadContext, options: unknown): Plugin | Promise<Plugin>;
+export type PluginModule<Content = unknown> = {
+  (context: LoadContext, options: unknown):
+    | Plugin<Content>
+    | Promise<Plugin<Content>>;
   validateOptions?: <T, U>(data: OptionValidationContext<T, U>) => U;
   validateThemeConfig?: <T>(data: ThemeConfigValidationContext<T>) => T;
 

diff --git a/packages/docusaurus/package.json b/packages/docusaurus/package.json
@@ -107,6 +107,7 @@
   "devDependencies": {
     "@docusaurus/module-type-aliases": "3.0.0",
     "@docusaurus/types": "3.0.0",
+    "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
     "@types/react-router-config": "^5.0.7",

diff --git a/packages/docusaurus/src/server/plugins/__tests__/__snapshots__/plugins.test.ts.snap b/packages/docusaurus/src/server/plugins/__tests__/__snapshots__/plugins.test.ts.snap