3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-21 21:16:59 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(v2): plugin lifecycle - add generateRoutes() API

Browse source
This commit is contained in:
Yangshun Tay 2019-03-03 18:46:09 -08:00
parent 70d185d862
commit 74d26d4f3d
3 changed files with 221 additions and 147 deletions
Download patch file Download diff file Expand all files Collapse all files

98
v2/lib/load/index.js
View file

@ -79,36 +79,69 @@ module.exports = async function load(siteDir) {
`export default ${JSON.stringify(pagesMetadatas, null, 2)};`,
);
const contentsStore = {};
// Process plugins.
if (siteConfig.plugins) {
const context = {env, siteDir, siteConfig};
// Currently runs all plugins in parallel and not order-dependent. We could change
// this in future if there's a need.
await Promise.all(
siteConfig.plugins.map(async ({name, options: opts}) => {
// TODO: Resolve using node_modules as well.
// eslint-disable-next-line
const Plugin = require(path.resolve(__dirname, '../../plugins', name));
const plugin = new Plugin(opts, context);
const {options} = plugin;
const contents = await plugin.load();
const pluginContents = {
options,
contents,
};
contentsStore[options.contentKey] = pluginContents;
const pluginCacheDir = path.join(generatedFilesDir, name);
fs.ensureDirSync(pluginCacheDir);
await generate(
pluginCacheDir,
options.cacheFileName,
JSON.stringify(contents, null, 2),
);
}),
);
}
const pluginConfigs = siteConfig.plugins || [];
const context = {env, siteDir, siteConfig};
// Initialize plugins.
const plugins = pluginConfigs.map(({name, options: opts}) => {
// TODO: Resolve using node_modules as well.
// eslint-disable-next-line
const Plugin = require(path.resolve(__dirname, '../../plugins', name));
const plugin = new Plugin(opts, context);
return {
name,
plugin,
};
});
// Plugin lifecycle - loadContents().
const contentsStore = {};
// Currently plugins run lifecycle in parallel and are not order-dependent. We could change
// this in future if there are plugins which need to run in certain order or depend on
// others for data.
const pluginsLoadedContents = await Promise.all(
plugins.map(async ({plugin, name}) => {
if (!plugin.loadContents) {
return null;
}
const {options} = plugin;
const contents = await plugin.loadContents();
const pluginContents = {
options,
contents,
};
contentsStore[options.contentKey] = pluginContents;
const pluginCacheDir = path.join(generatedFilesDir, name);
fs.ensureDirSync(pluginCacheDir);
await generate(
pluginCacheDir,
options.cacheFileName,
JSON.stringify(contents, null, 2),
);
return contents;
}),
);
// Plugin lifecycle - generateRoutes().
const pluginRouteConfigs = [];
const actions = {
addRoute: config => pluginRouteConfigs.push(config),
};
await Promise.all(
plugins.map(async ({plugin}, index) => {
if (!plugin.generateRoutes) {
return;
}
const contents = pluginsLoadedContents[index];
await plugin.generateRoutes({
contents,
actions,
});
}),
);
// Resolve outDir.
const outDir = path.resolve(siteDir, 'build');
@ -140,9 +173,10 @@ module.exports = async function load(siteDir) {
};
// Generate React Router Config.
const routesConfig = await genRoutesConfig(props);
await generate(generatedFilesDir, 'routes.js', routesConfig);
const routesConfig = await genRoutesConfig({
...props,
pluginRouteConfigs,
});
await generate(generatedFilesDir, 'routes.js', routesConfig);
return props;