[WIP] Implementaion of multiple directory static sourcing

facebook · Jan 24, 2021 · b4423b0 · b4423b0
1 parent 0a5d306
commit b4423b0
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 19 deletions.
diff --git a/packages/docusaurus-types/src/index.d.ts b/packages/docusaurus-types/src/index.d.ts
@@ -49,6 +49,7 @@ export interface DocusaurusConfig {
   )[];
   clientModules?: string[];
   ssrTemplate?: string;
+  staticDirectories?: string[];
   stylesheets?: (
     | string
     | {

diff --git a/packages/docusaurus/src/commands/build.ts b/packages/docusaurus/src/commands/build.ts
@@ -117,7 +117,7 @@ async function buildLocale({
     outDir,
     generatedFilesDir,
     plugins,
-    siteConfig: {baseUrl, onBrokenLinks},
+    siteConfig: {baseUrl, onBrokenLinks, staticDirectories = [STATIC_DIR_NAME]},
     routes,
   } = props;
 
@@ -150,21 +150,21 @@ async function buildLocale({
     },
   });
 
-  const staticDir = path.resolve(siteDir, STATIC_DIR_NAME);
-  if (fs.existsSync(staticDir)) {
-    serverConfig = merge(serverConfig, {
-      plugins: [
-        new CopyWebpackPlugin({
-          patterns: [
-            {
-              from: staticDir,
-              to: outDir,
-            },
-          ],
-        }),
-      ],
-    });
-  }
+  const staticDirectoryConfigurations = staticDirectories
+    .map((dir) => path.resolve(siteDir, dir))
+    .filter((dir) => fs.existsSync(dir))
+    .map((dir) => ({
+      from: dir,
+      to: outDir,
+    }));
+
+  serverConfig = merge(serverConfig, {
+    plugins: [
+      new CopyWebpackPlugin({
+        patterns: staticDirectoryConfigurations,
+      }),
+    ],
+  });
 
   // Plugin Lifecycle - configureWebpack.
   plugins.forEach((plugin) => {

diff --git a/packages/docusaurus/src/commands/start.ts b/packages/docusaurus/src/commands/start.ts
@@ -178,9 +178,12 @@ export default async function start(
       overlay: false,
       host,
       before: (app, server) => {
-        app.use(
-          baseUrl,
-          express.static(path.resolve(siteDir, STATIC_DIR_NAME)),
+        const staticDirectories = siteConfig.staticDirectories || [
+          STATIC_DIR_NAME,
+        ];
+
+        staticDirectories.forEach((dir) =>
+          app.use(baseUrl, express.static(path.resolve(siteDir, dir))),
         );
 
         // This lets us fetch source contents from webpack for the error overlay.

diff --git a/packages/docusaurus/src/server/configValidation.ts b/packages/docusaurus/src/server/configValidation.ts
@@ -104,6 +104,7 @@ const ConfigSchema = Joi.object({
     .equal('ignore', 'log', 'warn', 'error', 'throw')
     .default(DEFAULT_CONFIG.onDuplicateRoutes),
   organizationName: Joi.string().allow(''),
+  staticDirectories: Joi.array().items(Joi.string()),
   projectName: Joi.string().allow(''),
   customFields: Joi.object().unknown().default(DEFAULT_CONFIG.customFields),
   githubHost: Joi.string(),

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -46,6 +46,10 @@ module.exports = {
   tagline: 'Build optimized websites quickly, focus on your content',
   organizationName: 'facebook',
   projectName: 'docusaurus',
+  staticDirectories: [
+    path.resolve(__dirname, './static'),
+    path.resolve(__dirname, './test'),
+  ],
   baseUrl,
   baseUrlIssueBanner: true,
   url: 'https://v2.docusaurus.io',

diff --git a/website/test/hey.txt b/website/test/hey.txt
@@ -0,0 +1 @@
+hey hey hey!!!
diff --git a/website/test/img/test-image.png b/website/test/img/test-image.png