add async handling for doc build when writing files

Author: 5d

packages/docusaurus-1.x/lib/server/generate.js

@@ -19,7 +19,7 @@ async function execute() {
   const fs = require('fs-extra');
   const readMetadata = require('./readMetadata.js');
   const path = require('path');
-  const {minifyCss, isSeparateCss, autoPrefixCss} = require('./utils');
+  const {minifyCss, isSeparateCss, autoPrefixCss, processPromisesBatch} = require('./utils');
   const React = require('react');
   const mkdirp = require('mkdirp');
   const glob = require('glob');
@@ -54,6 +54,18 @@ async function execute() {
     }
   }
 
+  async function writeFileAndCreateFolderAsync(file, content) {
+    await mkdirp.async(path.dirname(file));
+    await fs.writeFile(file, content);
+
+    // build extra file for extension-less url if "cleanUrl" siteConfig is true
+    if (siteConfig.cleanUrl && file.indexOf('index.html') === -1) {
+      const extraFile = file.replace(/\.html$/, '/index.html');
+      await mkdirp.async(path.dirname(extraFile));
+      await fs.writeFile(extraFile, content);
+    }
+  }
+
   console.log('generate.js triggered...');
 
   readMetadata.generateMetadataDocs();
@@ -115,10 +127,10 @@ async function execute() {
   const MetadataBlog = require('../core/MetadataBlog.js');
 
   let files = glob.sync(join(CWD, 'blog', '**', '*.*'));
-  files
+  const writeFiles = files
     .sort()
     .reverse()
-    .forEach((file) => {
+    .map(async (file) => {
       // Why normalize? In case we are on Windows.
       // Remember the nuance of glob: https://www.npmjs.com/package/glob#windows
       const normalizedFile = path.normalize(file);
@@ -132,9 +144,11 @@ async function execute() {
         return;
       }
       const targetFile = join(buildDir, 'blog', urlPath);
-      writeFileAndCreateFolder(targetFile, blogPost);
+      await writeFileAndCreateFolderAsync(targetFile, blogPost);
     });
 
+  await processPromiseprocessPromisesBatch(writeFiles)
+
   // create html files for all blog pages (collections of article previews)
   const blogPages = blog.getPagesMarkup(MetadataBlog.length, siteConfig);
   Object.keys(blogPages).forEach((pagePath) => {

packages/docusaurus-1.x/lib/server/utils.js

@@ -9,6 +9,7 @@ const autoprefixer = require('autoprefixer');
 const postcss = require('postcss');
 const path = require('path');
 const escapeStringRegexp = require('escape-string-regexp');
+const chunk = require('lodash.chunk')
 
 function getSubDir(file, refDir) {
   const subDir = path.dirname(path.relative(refDir, file)).replace(/\\/g, '/');
@@ -79,11 +80,19 @@ function replaceAssetsLink(oldContent, location) {
   return lines.join('\n');
 }
 
+async function processPromisesBatch(promises, batchSize = 6) {
+  const chunks = chunk(promises, batchSize)
+  for (let c of chunks) {
+    await Promise.all(c)
+  }
+}
+
 module.exports = {
   getSubDir,
   getLanguage,
   isSeparateCss,
   minifyCss,
   autoPrefixCss,
   replaceAssetsLink,
+  processPromisesBatch
 };

packages/docusaurus-1.x/package.json

@@ -76,7 +76,8 @@
     "tcp-port-used": "^1.0.1",
     "tiny-lr": "^1.1.1",
     "tree-node-cli": "^1.2.5",
-    "truncate-html": "^1.0.3"
+    "truncate-html": "^1.0.3",
+    "lodash.chunk": "^4.2.0"
   },
   "devDependencies": {
     "babel-eslint": "^10.1.0",