feat:docs translation + versioning 💥

lib/load/docs/index.js

@@ -1,37 +1,113 @@
-const fs = require('fs-extra');
 const path = require('path');
-const fm = require('front-matter');
 const globby = require('globby');
-const {encodePath, fileToPath} = require('../utils');
+const createOrder = require('./order');
+const loadSidebars = require('./sidebars');
+const processMetadata = require('./metadata');
+const {getSubFolder, idx} = require('../utils');
 
-function parse(fileString) {
-  if (!fm.test(fileString)) {
-    return {metadata: null, content: fileString};
-  }
-  const {attributes: metadata, body: content} = fm(fileString);
+async function loadDocs({siteDir, docsDir, env}) {
+  // @tested - load all sidebars including versioned sidebars
+  const allSidebars = loadSidebars({siteDir, env});
 
-  return {metadata, content};
-}
+  // @tested - build the docs ordering such as next, previous, category and sidebar
+  const order = createOrder(allSidebars);
 
-async function loadDocs(docsDir) {
+  /* Settle versions & translations from environment */
+  const translationEnabled = idx(env, ['translation', 'enabled']);
+  const enabledLanguages =
+    translationEnabled && idx(env, ['translation', 'enabledLanguages']);
+  const enabledLangTags =
+    (enabledLanguages && enabledLanguages.map(lang => lang.tag)) || [];
+  const defaultLanguage = idx(env, ['translation', 'defaultLanguage']);
+  const defaultLangTag = defaultLanguage && defaultLanguage.tag;
+  const versioningEnabled = idx(env, ['versioning', 'enabled']);
+  const versions =
+    (versioningEnabled && idx(env, ['versioning', 'versions'])) || [];
+
+  /* Prepare metadata container */
+  const metadatas = {};
+
+  /* metadata for default docs files */
   const docsFiles = await globby(['**/*.md'], {
     cwd: docsDir
   });
-
-  const docsData = await Promise.all(
+  await Promise.all(
     docsFiles.map(async source => {
-      const filepath = path.resolve(docsDir, source);
-      const fileString = await fs.readFile(filepath, 'utf-8');
-      const {metadata} = parse(fileString);
+      /* 
+        Do not allow reserved version/ translated folder name in 'docs'
+        e.g: 'docs/version-1.0.0/' should not be allowed as it can cause unwanted bug
+      */
+      const subFolder = getSubFolder(path.resolve(docsDir, source), docsDir);
+      const versionsFolders = versions.map(version => `version-${version}`);
+      if ([...enabledLangTags, ...versionsFolders].includes(subFolder)) {
+        throw new Error(`You cannot have a folder named 'docs/${subFolder}/'`);
+      }
 
-      return {
-        path: encodePath(fileToPath(source)),
-        source,
-        ...metadata
-      };
+      const metadata = await processMetadata(source, docsDir, env, order);
+      metadatas[metadata.id] = metadata;
     })
   );
-  return docsData;
+
+  /* metadata for non-default-language docs */
+  const translatedDir = path.join(siteDir, 'translated_docs');
+  const translatedFiles = await globby(['**/*.md'], {
+    cwd: translatedDir
+  });
+  await Promise.all(
+    translatedFiles.map(async source => {
+      /* 
+        Do not process disabled & default languages folder in `translated_docs`
+        e.g: 'translated_docs/ja/**' should not be allowed if lang 'ja' is disabled
+      */
+      const translatedFilePath = path.resolve(translatedDir, source);
+      const detectedLangTag = getSubFolder(translatedFilePath, translatedDir);
+      if (
+        detectedLangTag === defaultLangTag ||
+        !enabledLangTags.includes(detectedLangTag)
+      ) {
+        return;
+      }
+
+      const metadata = await processMetadata(source, translatedDir, env, order);
+      metadatas[metadata.id] = metadata;
+    })
+  );
+
+  /* metadata for versioned docs */
+  const versionedDir = path.join(siteDir, 'versioned_docs');
+  const versionedFiles = await globby(['**/*.md'], {
+    cwd: versionedDir
+  });
+  await Promise.all(
+    versionedFiles.map(async source => {
+      const metadata = await processMetadata(source, versionedDir, env, order);
+      metadatas[metadata.id] = metadata;
+    })
+  );
+
+  /*
+   Get the titles of the previous and next ids so that we can use them
+  */
+  Object.keys(metadatas).forEach(metadata => {
+    if (metadatas[metadata].previous) {
+      if (metadatas[metadatas[metadata].previous]) {
+        metadatas[metadata].previous_title =
+          metadatas[metadatas[metadata].previous].title;
+      } else {
+        metadatas[metadata].previous_title = 'Previous';
+      }
+    }
+    if (metadatas[metadata].next) {
+      if (metadatas[metadatas[metadata].next]) {
+        metadatas[metadata].next_title =
+          metadatas[metadatas[metadata].next].title;
+      } else {
+        metadatas[metadata].next_title = 'Next';
+      }
+    }
+  });
+
+  return metadatas;
 }
 
 module.exports = loadDocs;