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;

lib/load/docs/metadata.js

@@ -0,0 +1,127 @@
+const fs = require('fs-extra');
+const path = require('path');
+const {getSubFolder, idx, parse} = require('../utils');
+
+function getLanguage(filepath, refDir, env) {
+  const translationEnabled = idx(env, ['translation', 'enabled']);
+  if (translationEnabled) {
+    const detectedLangTag = getSubFolder(filepath, refDir);
+    const defaultLanguage = idx(env, ['translation', 'defaultLanguage']);
+    if (!detectedLangTag && defaultLanguage && defaultLanguage.tag) {
+      return defaultLanguage.tag;
+    }
+    const enabledLanguages = idx(env, ['translation', 'enabledLanguages']);
+    const langTags =
+      (enabledLanguages && enabledLanguages.map(lang => lang.tag)) || [];
+    return langTags.find(langTag => langTag === detectedLangTag);
+  }
+  return undefined;
+}
+
+function getVersion(filepath, refDir, env) {
+  const versioningEnabled = idx(env, ['versioning', 'enabled']);
+  if (versioningEnabled) {
+    const subFolder = getSubFolder(filepath, refDir);
+    if (!subFolder) {
+      return 'next';
+    }
+    const detectedVersion = subFolder.replace(/^version-/, '');
+    const versions = idx(env, ['versioning', 'versions']) || [];
+    if (versions.includes(detectedVersion)) {
+      return detectedVersion;
+    }
+    return 'next';
+  }
+  return undefined;
+}
+
+module.exports = async function processMetadata(source, refDir, env, order) {
+  const filepath = path.resolve(refDir, source);
+  const fileString = await fs.readFile(filepath, 'utf-8');
+  const {metadata} = parse(fileString);
+
+  /* source (relative to refDir) */
+  metadata.source = source;
+
+  /* default id is the file name */
+  if (!metadata.id) {
+    metadata.id = path.basename(source, path.extname(source));
+  }
+  if (metadata.id.includes('/')) {
+    throw new Error('Document id cannot include "/".');
+  }
+
+  /* default title is the id */
+  if (!metadata.title) {
+    metadata.title = metadata.id;
+  }
+
+  /* language */
+  const language = getLanguage(filepath, refDir, env);
+  metadata.language = language;
+  const langPart = (language && `${language}/`) || '';
+
+  /* version */
+  const versionRefDir = language ? path.join(refDir, language) : refDir;
+  const version = getVersion(filepath, versionRefDir, env);
+  metadata.version = version;
+  const latestVersion = idx(env, ['versioning', 'latestVersion']);
+  const versionPart =
+    (version && version !== latestVersion && `${version}/`) || '';
+
+  /* 
+    Convert temporarily metadata.id to the form of dirname/id without version/lang prefix
+    ex: file `versioned_docs/version-1.0.0/en/foo/bar.md` with id `version-1.0.0-bar` => `foo/bar`
+  */
+
+  if (version) {
+    metadata.id = metadata.id.replace(new RegExp(`^version-${version}-`), '');
+  }
+
+  const dirName = path.dirname(source);
+  if (dirName !== '.') {
+    let prefix = dirName;
+    if (version) {
+      prefix = prefix.replace(new RegExp(`^version-${version}`), '');
+    }
+    if (language) {
+      prefix = prefix.replace(new RegExp(`^${language}`), '');
+    }
+    if (prefix) {
+      prefix = prefix.replace(/^\//, '');
+      metadata.id = `${prefix}/${metadata.id}`;
+    }
+  }
+
+  /* Build the permalink without baseUrl */
+  metadata.permalink = `docs/${langPart}${versionPart}${metadata.id}`;
+
+  /* if version */
+  if (version && version !== 'next') {
+    metadata.id = `version-${version}-${metadata.id}`;
+  }
+
+  /* if language */
+  if (language) {
+    metadata.id = `${language}-${metadata.id}`;
+  }
+
+  /* localize id */
+  metadata.localized_id = metadata.id;
+
+  /* Determine order */
+  const id = metadata.localized_id;
+  if (order[id]) {
+    metadata.sidebar = order[id].sidebar;
+    metadata.category = order[id].category;
+    if (order[id].next) {
+      metadata.next_id = order[id].next;
+      metadata.next = (language ? `${language}-` : '') + order[id].next;
+    }
+    if (order[id].previous) {
+      metadata.previous_id = order[id].previous;
+      metadata.previous = (language ? `${language}-` : '') + order[id].previous;
+    }
+  }
+  return metadata;
+};

lib/load/docs/order.js

@@ -11,11 +11,13 @@ module.exports = function createOrder(allSidebars = {}) {
     const categoryOrder = [];
     Object.keys(categories).forEach(category => {
       ids = ids.concat(categories[category]);
+      // eslint-disable-next-line
       for (let i = 0; i < categories[category].length; i++) {
         categoryOrder.push(category);
       }
     });
 
+    // eslint-disable-next-line
     for (let i = 0; i < ids.length; i++) {
       const id = ids[i];
       let previous;

lib/load/docs/sidebars.js

@@ -8,13 +8,13 @@ module.exports = function loadSidebars({siteDir, env}) {
   // current sidebars
   const sidebarsJSONFile = path.join(siteDir, 'sidebars.json');
   if (fs.existsSync(sidebarsJSONFile)) {
-    allSidebars = require(sidebarsJSONFile);
+    allSidebars = require(sidebarsJSONFile); // eslint-disable-line
   }
 
   // versioned sidebars
   if (idx(env, ['versioning', 'enabled'])) {
     const versions = idx(env, ['versioning', 'versions']);
-    versions &&
+    if (Array.isArray(versions)) {
       versions.forEach(version => {
         const versionedSidebarsJSONFile = path.join(
           siteDir,
@@ -22,7 +22,7 @@ module.exports = function loadSidebars({siteDir, env}) {
           `version-${version}-sidebars.json`
         );
         if (fs.existsSync(versionedSidebarsJSONFile)) {
-          const sidebar = require(versionedSidebarsJSONFile);
+          const sidebar = require(versionedSidebarsJSONFile); // eslint-disable-line
           Object.assign(allSidebars, sidebar);
         } else {
           const missingFile = path.relative(siteDir, versionedSidebarsJSONFile);
@@ -30,5 +30,6 @@ module.exports = function loadSidebars({siteDir, env}) {
         }
       });
     }
+  }
   return allSidebars;
 };

lib/load/env.js

@@ -1,5 +1,6 @@
 const fs = require('fs-extra');
 const path = require('path');
+const {idx} = require('./utils');
 
 module.exports = function loadEnv({siteDir, siteConfig}) {
   // Translation
@@ -11,7 +12,7 @@ module.exports = function loadEnv({siteDir, siteConfig}) {
 
   const languagesFile = path.join(siteDir, 'languages.js');
   if (fs.existsSync(languagesFile)) {
-    const languages = require(languagesFile);
+    const languages = require(languagesFile); // eslint-disable-line
 
     /* Enabled languages */
     const enabledLanguages = languages.filter(lang => lang.enabled);
@@ -47,7 +48,7 @@ module.exports = function loadEnv({siteDir, siteConfig}) {
   if (fs.existsSync(versionsJSONFile)) {
     versioning.enabled = true;
     versioning.versions = JSON.parse(fs.readFileSync(versionsJSONFile, 'utf8'));
-    versioning.latestVersion = versioning.versions[0];
+    versioning.latestVersion = idx(versioning, ['versions', 0]);
     const {defaultVersionShown} = siteConfig;
     versioning.defaultVersion = defaultVersionShown || versioning.latestVersion;
   }

lib/load/index.js

@@ -8,10 +8,10 @@ const {generate} = require('./utils');
 const genRoutesConfig = require('./routes');
 
 module.exports = async function load(siteDir) {
-  // siteConfig
+  // @tested - siteConfig
   const siteConfig = loadConfig(siteDir);
 
-  // env
+  // @tested - env
   const env = loadEnv({siteDir, siteConfig});
 
   // docs
@@ -20,7 +20,7 @@ module.exports = async function load(siteDir) {
     '..',
     siteConfig.customDocsPath || 'docs'
   );
-  const docsData = await loadDocs(docsDir);
+  const docsData = await loadDocs({siteDir, docsDir, env});
   await generate(
     'docsData.js',
     `export default ${JSON.stringify(docsData, null, 2)};`

lib/load/routes.js

@@ -1,15 +1,38 @@
-async function genRoutesConfig({docsData = [], pagesData = []}) {
-  function genDocsRoute({path: docsPath, source}) {
+const {idx} = require('./utils');
+
+async function genRoutesConfig({
+  docsData = {},
+  pagesData = [],
+  env,
+  siteConfig
+}) {
+  function genDocsRoute(metadata) {
+    const {permalink, source, version, language} = metadata;
+    const defaultLanguage = idx(env, ['translation', 'defaultLanguage']);
+    let importPath = `@docs/${source}`;
+    if (language && language !== defaultLanguage.tag) {
+      importPath = `@translated_docs/${source}`;
+    } else if (version && version !== 'next') {
+      importPath = `@versioned_docs/${source}`;
+    }
+
+    const {baseUrl} = siteConfig;
+    const docsPath = `${baseUrl}${permalink}`;
+
     return `
   {
     path: ${JSON.stringify(docsPath)},
     exact: true,
     component: Loadable({
-      loader: () => import('@docs/${source}'),
+      loader: () => import(${JSON.stringify(importPath)}),
       loading: Loading,
       render(loaded, props) {
         let Content = loaded.default;
-        return <Docs {...props}><Content /></Docs>;
+        return (
+          <Docs {...props} metadata={${JSON.stringify(metadata)}}>
+            <Content />
+          </Docs>
+        );
       }
     })
   }`;
@@ -33,13 +56,17 @@ async function genRoutesConfig({docsData = [], pagesData = []}) {
     component: NotFound
   }`;
 
+  const docsRoutes = Object.values(docsData)
+    .map(genDocsRoute)
+    .join(',');
+
   return (
     `import React from 'react';\n` +
     `import Loadable from 'react-loadable';\n` +
     `import Loading from '@theme/Loading';\n` +
     `import Docs from '@theme/Docs';\n` +
     `import NotFound from '@theme/NotFound';\n` +
-    `const routes = [${docsData.map(genDocsRoute).join(',')},${pagesData
+    `const routes = [${docsRoutes},${pagesData
       .map(genPagesRoute)
       .join(',')}${notFoundRoute}\n];\n` +
     `export default routes;\n`

lib/theme/Docs/index.js

@@ -6,13 +6,11 @@ import Layout from '@theme/Layout'; // eslint-disable-line
 
 export default class Docs extends React.Component {
   render() {
-    const {route, docsData, siteConfig} = this.props;
-    const currentDoc = docsData.find(data => data.path === route.path);
-
+    const {route, siteConfig, metadata} = this.props;
     return (
       <Layout {...this.props}>
         <Helmet>
-          <title>{(currentDoc && currentDoc.title) || siteConfig.title}</title>
+          <title>{(metadata && metadata.title) || siteConfig.title}</title>
         </Helmet>
         <div className={styles.mainContainer}>{this.props.children}</div>
       </Layout>

lib/theme/Layout/index.js

@@ -1,12 +1,16 @@
 import React from 'react';
 import {Link} from 'react-router-dom';
+import siteConfig from '@site/siteConfig';
 import styles from './styles.css';
 
 /* eslint-disable react/prefer-stateless-function */
 export default class Layout extends React.Component {
   render() {
-    const {children, pagesData, docsData, location} = this.props;
-    const routeLinks = [...pagesData, ...docsData].map(
+    const {children, pagesData, docsData = {}, location} = this.props;
+    const docsLinks = Object.values(docsData).map(data => ({
+      path: `${siteConfig.baseUrl}${data.permalink}`
+    }));
+    const routeLinks = [...pagesData, ...docsLinks].map(
       data =>
         data.path !== location.pathname && (
           <li key={data.path}>

lib/webpack/base.js

@@ -32,6 +32,8 @@ module.exports = function createBaseConfig(props, isServer) {
     .set('symlinks', true)
     .alias.set('@theme', themePath)
     .set('@site', siteDir)
+    .set('@versioned_docs', path.resolve(siteDir, 'versioned_docs'))
+    .set('@translated_docs', path.resolve(siteDir, 'translated_docs'))
     .set('@docs', docsDir)
     .set('@pages', pagesDir)
     .set('@build', outDir)

lib/webpack/loader/markdown.js

@@ -5,10 +5,11 @@ module.exports = function(fileString) {
   const options = getOptions(this);
 
   const {body} = fm(fileString);
-
   const content = JSON.stringify(body);
-  // TODO replace all the markdown linking to correct url depends on whether it's versioned/translated/normal docs
-  // e.g: [test](test.md) become [test](/docs/test)
+  /* 
+    TODO replace all the markdown linking to correct url depends on whether it's versioned/translated/normal docs
+    e.g: [test](test.md) become [test](/docs/test)
+  */
   const siteConfig = JSON.stringify(options.siteConfig);
 
   return (

test/load/__snapshots__/pages.test.js.snap

@@ -1,22 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`loadPages valid pages 1`] = `
-Array [
-  Object {
-    "path": "/foo",
-    "source": "foo.js",
-  },
-  Object {
-    "path": "/",
-    "source": "index.js",
-  },
-  Object {
-    "path": "/foo/",
-    "source": "foo/index.js",
-  },
-  Object {
-    "path": "/bar/baz",
-    "source": "bar/baz.js",
-  },
-]
-`;

test/load/__snapshots__/routes.test.js.snap

@@ -1,201 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`genRoutesConfig website with no docs/pages 1`] = `
-"import React from 'react';
-import Loadable from 'react-loadable';
-import Loading from '@theme/Loading';
-import Docs from '@theme/Docs';
-import NotFound from '@theme/NotFound';
-const routes = [,,
-  {
-    path: '*',
-    component: NotFound
-  }
-];
-export default routes;
-"
-`;
-
-exports[`genRoutesConfig website with only docs 1`] = `
-"import React from 'react';
-import Loadable from 'react-loadable';
-import Loading from '@theme/Loading';
-import Docs from '@theme/Docs';
-import NotFound from '@theme/NotFound';
-const routes = [
-  {
-    path: \\"/hello\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@docs/hello.md'),
-      loading: Loading,
-      render(loaded, props) {
-        let Content = loaded.default;
-        return <Docs {...props}><Content /></Docs>;
-      }
-    })
-  },
-  {
-    path: \\"/foo/baz\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@docs/foo/baz.md'),
-      loading: Loading,
-      render(loaded, props) {
-        let Content = loaded.default;
-        return <Docs {...props}><Content /></Docs>;
-      }
-    })
-  },
-  {
-    path: \\"/foo/bar\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@docs/foo/bar.md'),
-      loading: Loading,
-      render(loaded, props) {
-        let Content = loaded.default;
-        return <Docs {...props}><Content /></Docs>;
-      }
-    })
-  },,
-  {
-    path: '*',
-    component: NotFound
-  }
-];
-export default routes;
-"
-`;
-
-exports[`genRoutesConfig website with only pages 1`] = `
-"import React from 'react';
-import Loadable from 'react-loadable';
-import Loading from '@theme/Loading';
-import Docs from '@theme/Docs';
-import NotFound from '@theme/NotFound';
-const routes = [,
-  {
-    path: \\"/foo\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@pages/foo.js'),
-      loading: Loading
-    })
-  },
-  {
-    path: \\"/\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@pages/index.js'),
-      loading: Loading
-    })
-  },
-  {
-    path: \\"/bar/baz\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@pages/bar/baz.js'),
-      loading: Loading
-    })
-  },
-  {
-    path: \\"/foo/\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@pages/foo/index.js'),
-      loading: Loading
-    })
-  },
-  {
-    path: '*',
-    component: NotFound
-  }
-];
-export default routes;
-"
-`;
-
-exports[`genRoutesConfig website with pages and docs 1`] = `
-"import React from 'react';
-import Loadable from 'react-loadable';
-import Loading from '@theme/Loading';
-import Docs from '@theme/Docs';
-import NotFound from '@theme/NotFound';
-const routes = [
-  {
-    path: \\"/hello\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@docs/hello.md'),
-      loading: Loading,
-      render(loaded, props) {
-        let Content = loaded.default;
-        return <Docs {...props}><Content /></Docs>;
-      }
-    })
-  },
-  {
-    path: \\"/foo/bar\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@docs/foo/bar.md'),
-      loading: Loading,
-      render(loaded, props) {
-        let Content = loaded.default;
-        return <Docs {...props}><Content /></Docs>;
-      }
-    })
-  },
-  {
-    path: \\"/foo/baz\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@docs/foo/baz.md'),
-      loading: Loading,
-      render(loaded, props) {
-        let Content = loaded.default;
-        return <Docs {...props}><Content /></Docs>;
-      }
-    })
-  },
-  {
-    path: \\"/\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@pages/index.js'),
-      loading: Loading
-    })
-  },
-  {
-    path: \\"/foo\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@pages/foo.js'),
-      loading: Loading
-    })
-  },
-  {
-    path: \\"/foo/\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@pages/foo/index.js'),
-      loading: Loading
-    })
-  },
-  {
-    path: \\"/bar/baz\\",
-    exact: true,
-    component: Loadable({
-      loader: () => import('@pages/bar/baz.js'),
-      loading: Loading
-    })
-  },
-  {
-    path: '*',
-    component: NotFound
-  }
-];
-export default routes;
-"
-`;

test/load/docs.test.js

@@ -1,21 +0,0 @@
-import loadDocs from '@lib/load/docs';
-import path from 'path';
-
-describe('loadDocs', () => {
-  test('simple docs', async () => {
-    const docsDir = path.join(__dirname, '__fixtures__', 'simple-docs');
-    const docsData = await loadDocs(docsDir);
-    expect(docsData).toMatchSnapshot();
-    expect(docsData).not.toBeNull();
-  });
-
-  test('no docs', async () => {
-    const nonExistingDocsDir = path.join(
-      __dirname,
-      '__fixtures__',
-      'nonExistingDocs'
-    );
-    const docsData = await loadDocs(nonExistingDocsDir);
-    expect(docsData).toEqual([]);
-  });
-});

test/load/docs/__snapshots__/index.test.js.snap

@@ -0,0 +1,593 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`loadDocs simple website 1`] = `
+Object {
+  "baseUrl": "/",
+  "docsData": Object {
+    "foo/bar": Object {
+      "id": "foo/bar",
+      "language": undefined,
+      "localized_id": "foo/bar",
+      "permalink": "docs/foo/bar",
+      "source": "foo/bar.md",
+      "title": "Bar",
+      "version": undefined,
+    },
+    "foo/baz": Object {
+      "id": "foo/baz",
+      "language": undefined,
+      "localized_id": "foo/baz",
+      "permalink": "docs/foo/baz",
+      "source": "foo/baz.md",
+      "title": "baz",
+      "version": undefined,
+    },
+    "hello": Object {
+      "id": "hello",
+      "language": undefined,
+      "localized_id": "hello",
+      "permalink": "docs/hello",
+      "source": "hello.md",
+      "title": "Hello, World !",
+      "version": undefined,
+    },
+  },
+  "docsDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/docs",
+  "env": Object {
+    "translation": Object {
+      "defaultLanguage": Object {},
+      "enabled": false,
+      "enabledLanguages": Array [],
+    },
+    "versioning": Object {
+      "defaultVersion": null,
+      "enabled": false,
+      "latestVersion": null,
+      "versions": Array [],
+    },
+  },
+  "outDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/simple-site/build",
+  "pagesData": Array [
+    Object {
+      "path": "/",
+      "source": "index.js",
+    },
+    Object {
+      "path": "/hello/world",
+      "source": "hello/world.js",
+    },
+  ],
+  "pagesDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/simple-site/pages",
+  "siteConfig": Object {
+    "baseUrl": "/",
+    "organizationName": "endiliey",
+    "projectName": "hello",
+    "tagline": "Hello World",
+    "title": "Hello",
+  },
+  "siteDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/simple-site",
+  "themePath": "/mnt/c/Users/endij/Desktop/Linux/munseo/lib/theme",
+}
+`;
+
+exports[`loadDocs translated website 1`] = `
+Object {
+  "baseUrl": "/",
+  "docsData": Object {
+    "en-hello": Object {
+      "id": "en-hello",
+      "language": "en",
+      "localized_id": "en-hello",
+      "permalink": "docs/en/hello",
+      "source": "hello.md",
+      "title": "Hello, World !",
+      "version": undefined,
+    },
+    "foo/bar": Object {
+      "id": "foo/bar",
+      "language": undefined,
+      "localized_id": "foo/bar",
+      "permalink": "docs/foo/bar",
+      "source": "foo/bar.md",
+      "title": "Bar",
+      "version": undefined,
+    },
+    "foo/baz": Object {
+      "id": "foo/baz",
+      "language": undefined,
+      "localized_id": "foo/baz",
+      "permalink": "docs/foo/baz",
+      "source": "foo/baz.md",
+      "title": "baz",
+      "version": undefined,
+    },
+    "ko-docs/foo/bar": Object {
+      "id": "ko-docs/foo/bar",
+      "language": "ko",
+      "localized_id": "ko-docs/foo/bar",
+      "permalink": "docs/ko/docs/foo/bar",
+      "source": "ko/docs/foo/bar.md",
+      "title": "Bar",
+      "version": undefined,
+    },
+    "ko-docs/foo/baz": Object {
+      "id": "ko-docs/foo/baz",
+      "language": "ko",
+      "localized_id": "ko-docs/foo/baz",
+      "permalink": "docs/ko/docs/foo/baz",
+      "source": "ko/docs/foo/baz.md",
+      "title": "baz",
+      "version": undefined,
+    },
+    "ko-docs/hello": Object {
+      "id": "ko-docs/hello",
+      "language": "ko",
+      "localized_id": "ko-docs/hello",
+      "permalink": "docs/ko/docs/hello",
+      "source": "ko/docs/hello.md",
+      "title": "Hello, World !",
+      "version": undefined,
+    },
+  },
+  "docsDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/docs",
+  "env": Object {
+    "translation": Object {
+      "defaultLanguage": Object {
+        "enabled": true,
+        "name": "English",
+        "tag": "en",
+      },
+      "enabled": true,
+      "enabledLanguages": Array [
+        Object {
+          "enabled": true,
+          "name": "English",
+          "tag": "en",
+        },
+        Object {
+          "enabled": true,
+          "name": "한국어",
+          "tag": "ko",
+        },
+      ],
+    },
+    "versioning": Object {
+      "defaultVersion": null,
+      "enabled": false,
+      "latestVersion": null,
+      "versions": Array [],
+    },
+  },
+  "outDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/translated-site/build",
+  "pagesData": Array [
+    Object {
+      "path": "/",
+      "source": "index.js",
+    },
+    Object {
+      "path": "/hello/world",
+      "source": "hello/world.js",
+    },
+  ],
+  "pagesDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/translated-site/pages",
+  "siteConfig": Object {
+    "baseUrl": "/",
+    "defaultLanguage": "en",
+    "organizationName": "endiliey",
+    "projectName": "hello",
+    "tagline": "Hello World",
+    "title": "Hello",
+  },
+  "siteDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/translated-site",
+  "themePath": "/mnt/c/Users/endij/Desktop/Linux/munseo/lib/theme",
+}
+`;
+
+exports[`loadDocs versioned & translated website 1`] = `
+Object {
+  "baseUrl": "/",
+  "docsData": Object {
+    "en-hello": Object {
+      "id": "en-hello",
+      "language": "en",
+      "localized_id": "en-hello",
+      "permalink": "docs/en/next/hello",
+      "source": "hello.md",
+      "title": "Hello, World !",
+      "version": "next",
+    },
+    "foo/bar": Object {
+      "category": "Test",
+      "id": "foo/bar",
+      "language": undefined,
+      "localized_id": "foo/bar",
+      "next": "foo/baz",
+      "next_id": "foo/baz",
+      "next_title": "baz",
+      "permalink": "docs/next/foo/bar",
+      "sidebar": "docs",
+      "source": "foo/bar.md",
+      "title": "Bar",
+      "version": "next",
+    },
+    "foo/baz": Object {
+      "category": "Test",
+      "id": "foo/baz",
+      "language": undefined,
+      "localized_id": "foo/baz",
+      "next": "hello",
+      "next_id": "hello",
+      "next_title": "Next",
+      "permalink": "docs/next/foo/baz",
+      "previous": "foo/bar",
+      "previous_id": "foo/bar",
+      "previous_title": "Bar",
+      "sidebar": "docs",
+      "source": "foo/baz.md",
+      "title": "baz",
+      "version": "next",
+    },
+    "ko-version-1.0.0-version-1.0.0/foo/bar": Object {
+      "id": "ko-version-1.0.0-version-1.0.0/foo/bar",
+      "language": "ko",
+      "localized_id": "ko-version-1.0.0-version-1.0.0/foo/bar",
+      "permalink": "docs/ko/1.0.0/version-1.0.0/foo/bar",
+      "source": "ko/version-1.0.0/foo/bar.md",
+      "title": "Bar",
+      "version": "1.0.0",
+    },
+    "ko-version-1.0.0-version-1.0.0/foo/baz": Object {
+      "id": "ko-version-1.0.0-version-1.0.0/foo/baz",
+      "language": "ko",
+      "localized_id": "ko-version-1.0.0-version-1.0.0/foo/baz",
+      "permalink": "docs/ko/1.0.0/version-1.0.0/foo/baz",
+      "source": "ko/version-1.0.0/foo/baz.md",
+      "title": "baz",
+      "version": "1.0.0",
+    },
+    "ko-version-1.0.0-version-1.0.0/hello": Object {
+      "id": "ko-version-1.0.0-version-1.0.0/hello",
+      "language": "ko",
+      "localized_id": "ko-version-1.0.0-version-1.0.0/hello",
+      "permalink": "docs/ko/1.0.0/version-1.0.0/hello",
+      "source": "ko/version-1.0.0/hello.md",
+      "title": "Hello, World !",
+      "version": "1.0.0",
+    },
+    "ko-version-1.0.1-version-1.0.1/foo/bar": Object {
+      "id": "ko-version-1.0.1-version-1.0.1/foo/bar",
+      "language": "ko",
+      "localized_id": "ko-version-1.0.1-version-1.0.1/foo/bar",
+      "permalink": "docs/ko/version-1.0.1/foo/bar",
+      "source": "ko/version-1.0.1/foo/bar.md",
+      "title": "Bar",
+      "version": "1.0.1",
+    },
+    "ko-version-1.0.1-version-1.0.1/foo/baz": Object {
+      "id": "ko-version-1.0.1-version-1.0.1/foo/baz",
+      "language": "ko",
+      "localized_id": "ko-version-1.0.1-version-1.0.1/foo/baz",
+      "permalink": "docs/ko/version-1.0.1/foo/baz",
+      "source": "ko/version-1.0.1/foo/baz.md",
+      "title": "baz",
+      "version": "1.0.1",
+    },
+    "ko-version-1.0.1-version-1.0.1/hello": Object {
+      "id": "ko-version-1.0.1-version-1.0.1/hello",
+      "language": "ko",
+      "localized_id": "ko-version-1.0.1-version-1.0.1/hello",
+      "permalink": "docs/ko/version-1.0.1/hello",
+      "source": "ko/version-1.0.1/hello.md",
+      "title": "Hello, World !",
+      "version": "1.0.1",
+    },
+    "version-1.0.0-foo/bar": Object {
+      "category": "Test",
+      "id": "version-1.0.0-foo/bar",
+      "language": undefined,
+      "localized_id": "version-1.0.0-foo/bar",
+      "next": "version-1.0.0-foo/baz",
+      "next_id": "version-1.0.0-foo/baz",
+      "next_title": "Baz",
+      "permalink": "docs/1.0.0/foo/bar",
+      "sidebar": "version-1.0.0-docs",
+      "source": "version-1.0.0/foo/bar.md",
+      "title": "Bar",
+      "version": "1.0.0",
+    },
+    "version-1.0.0-foo/baz": Object {
+      "category": "Test",
+      "id": "version-1.0.0-foo/baz",
+      "language": undefined,
+      "localized_id": "version-1.0.0-foo/baz",
+      "next": "version-1.0.0-hello",
+      "next_id": "version-1.0.0-hello",
+      "next_title": "Hello, World !",
+      "permalink": "docs/1.0.0/foo/baz",
+      "previous": "version-1.0.0-foo/bar",
+      "previous_id": "version-1.0.0-foo/bar",
+      "previous_title": "Bar",
+      "sidebar": "version-1.0.0-docs",
+      "source": "version-1.0.0/foo/baz.md",
+      "title": "Baz",
+      "version": "1.0.0",
+    },
+    "version-1.0.0-hello": Object {
+      "category": "Guides",
+      "id": "version-1.0.0-hello",
+      "language": undefined,
+      "localized_id": "version-1.0.0-hello",
+      "permalink": "docs/1.0.0/hello",
+      "previous": "version-1.0.0-foo/baz",
+      "previous_id": "version-1.0.0-foo/baz",
+      "previous_title": "Baz",
+      "sidebar": "version-1.0.0-docs",
+      "source": "version-1.0.0/hello.md",
+      "title": "Hello, World !",
+      "version": "1.0.0",
+    },
+    "version-1.0.1-foo/bar": Object {
+      "category": "Test",
+      "id": "version-1.0.1-foo/bar",
+      "language": undefined,
+      "localized_id": "version-1.0.1-foo/bar",
+      "next": "version-1.0.1-foo/baz",
+      "next_id": "version-1.0.1-foo/baz",
+      "next_title": "Baz",
+      "permalink": "docs/foo/bar",
+      "sidebar": "version-1.0.1-docs",
+      "source": "version-1.0.1/foo/bar.md",
+      "title": "Bar",
+      "version": "1.0.1",
+    },
+    "version-1.0.1-foo/baz": Object {
+      "category": "Test",
+      "id": "version-1.0.1-foo/baz",
+      "language": undefined,
+      "localized_id": "version-1.0.1-foo/baz",
+      "next": "version-1.0.1-hello",
+      "next_id": "version-1.0.1-hello",
+      "next_title": "Hello, World !",
+      "permalink": "docs/foo/baz",
+      "previous": "version-1.0.1-foo/bar",
+      "previous_id": "version-1.0.1-foo/bar",
+      "previous_title": "Bar",
+      "sidebar": "version-1.0.1-docs",
+      "source": "version-1.0.1/foo/baz.md",
+      "title": "Baz",
+      "version": "1.0.1",
+    },
+    "version-1.0.1-hello": Object {
+      "category": "Guides",
+      "id": "version-1.0.1-hello",
+      "language": undefined,
+      "localized_id": "version-1.0.1-hello",
+      "permalink": "docs/hello",
+      "previous": "version-1.0.1-foo/baz",
+      "previous_id": "version-1.0.1-foo/baz",
+      "previous_title": "Baz",
+      "sidebar": "version-1.0.1-docs",
+      "source": "version-1.0.1/hello.md",
+      "title": "Hello, World !",
+      "version": "1.0.1",
+    },
+  },
+  "docsDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/docs",
+  "env": Object {
+    "translation": Object {
+      "defaultLanguage": Object {
+        "enabled": true,
+        "name": "English",
+        "tag": "en",
+      },
+      "enabled": true,
+      "enabledLanguages": Array [
+        Object {
+          "enabled": true,
+          "name": "English",
+          "tag": "en",
+        },
+        Object {
+          "enabled": true,
+          "name": "한국어",
+          "tag": "ko",
+        },
+      ],
+    },
+    "versioning": Object {
+      "defaultVersion": "1.0.1",
+      "enabled": true,
+      "latestVersion": "1.0.1",
+      "versions": Array [
+        "1.0.1",
+        "1.0.0",
+      ],
+    },
+  },
+  "outDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/transversioned-site/build",
+  "pagesData": Array [
+    Object {
+      "path": "/",
+      "source": "index.js",
+    },
+    Object {
+      "path": "/hello/world",
+      "source": "hello/world.js",
+    },
+  ],
+  "pagesDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/transversioned-site/pages",
+  "siteConfig": Object {
+    "baseUrl": "/",
+    "defaultLanguage": "en",
+    "organizationName": "endiliey",
+    "projectName": "hello",
+    "tagline": "Hello World",
+    "title": "Hello",
+  },
+  "siteDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/transversioned-site",
+  "themePath": "/mnt/c/Users/endij/Desktop/Linux/munseo/lib/theme",
+}
+`;
+
+exports[`loadDocs versioned website 1`] = `
+Object {
+  "baseUrl": "/",
+  "docsData": Object {
+    "foo/bar": Object {
+      "id": "foo/bar",
+      "language": undefined,
+      "localized_id": "foo/bar",
+      "permalink": "docs/next/foo/bar",
+      "source": "foo/bar.md",
+      "title": "Bar",
+      "version": "next",
+    },
+    "foo/baz": Object {
+      "id": "foo/baz",
+      "language": undefined,
+      "localized_id": "foo/baz",
+      "permalink": "docs/next/foo/baz",
+      "source": "foo/baz.md",
+      "title": "baz",
+      "version": "next",
+    },
+    "hello": Object {
+      "id": "hello",
+      "language": undefined,
+      "localized_id": "hello",
+      "permalink": "docs/next/hello",
+      "source": "hello.md",
+      "title": "Hello, World !",
+      "version": "next",
+    },
+    "version-1.0.0-foo/bar": Object {
+      "category": "Test",
+      "id": "version-1.0.0-foo/bar",
+      "language": undefined,
+      "localized_id": "version-1.0.0-foo/bar",
+      "next": "version-1.0.0-foo/baz",
+      "next_id": "version-1.0.0-foo/baz",
+      "next_title": "Baz",
+      "permalink": "docs/1.0.0/foo/bar",
+      "sidebar": "version-1.0.0-docs",
+      "source": "version-1.0.0/foo/bar.md",
+      "title": "Bar",
+      "version": "1.0.0",
+    },
+    "version-1.0.0-foo/baz": Object {
+      "category": "Test",
+      "id": "version-1.0.0-foo/baz",
+      "language": undefined,
+      "localized_id": "version-1.0.0-foo/baz",
+      "next": "version-1.0.0-hello",
+      "next_id": "version-1.0.0-hello",
+      "next_title": "Hello, World !",
+      "permalink": "docs/1.0.0/foo/baz",
+      "previous": "version-1.0.0-foo/bar",
+      "previous_id": "version-1.0.0-foo/bar",
+      "previous_title": "Bar",
+      "sidebar": "version-1.0.0-docs",
+      "source": "version-1.0.0/foo/baz.md",
+      "title": "Baz",
+      "version": "1.0.0",
+    },
+    "version-1.0.0-hello": Object {
+      "category": "Guides",
+      "id": "version-1.0.0-hello",
+      "language": undefined,
+      "localized_id": "version-1.0.0-hello",
+      "permalink": "docs/1.0.0/hello",
+      "previous": "version-1.0.0-foo/baz",
+      "previous_id": "version-1.0.0-foo/baz",
+      "previous_title": "Baz",
+      "sidebar": "version-1.0.0-docs",
+      "source": "version-1.0.0/hello.md",
+      "title": "Hello, World !",
+      "version": "1.0.0",
+    },
+    "version-1.0.1-foo/bar": Object {
+      "category": "Test",
+      "id": "version-1.0.1-foo/bar",
+      "language": undefined,
+      "localized_id": "version-1.0.1-foo/bar",
+      "next": "version-1.0.1-foo/baz",
+      "next_id": "version-1.0.1-foo/baz",
+      "next_title": "Baz",
+      "permalink": "docs/foo/bar",
+      "sidebar": "version-1.0.1-docs",
+      "source": "version-1.0.1/foo/bar.md",
+      "title": "Bar",
+      "version": "1.0.1",
+    },
+    "version-1.0.1-foo/baz": Object {
+      "category": "Test",
+      "id": "version-1.0.1-foo/baz",
+      "language": undefined,
+      "localized_id": "version-1.0.1-foo/baz",
+      "next": "version-1.0.1-hello",
+      "next_id": "version-1.0.1-hello",
+      "next_title": "Hello, World !",
+      "permalink": "docs/foo/baz",
+      "previous": "version-1.0.1-foo/bar",
+      "previous_id": "version-1.0.1-foo/bar",
+      "previous_title": "Bar",
+      "sidebar": "version-1.0.1-docs",
+      "source": "version-1.0.1/foo/baz.md",
+      "title": "Baz",
+      "version": "1.0.1",
+    },
+    "version-1.0.1-hello": Object {
+      "category": "Guides",
+      "id": "version-1.0.1-hello",
+      "language": undefined,
+      "localized_id": "version-1.0.1-hello",
+      "permalink": "docs/hello",
+      "previous": "version-1.0.1-foo/baz",
+      "previous_id": "version-1.0.1-foo/baz",
+      "previous_title": "Baz",
+      "sidebar": "version-1.0.1-docs",
+      "source": "version-1.0.1/hello.md",
+      "title": "Hello, World !",
+      "version": "1.0.1",
+    },
+  },
+  "docsDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/docs",
+  "env": Object {
+    "translation": Object {
+      "defaultLanguage": Object {},
+      "enabled": false,
+      "enabledLanguages": Array [],
+    },
+    "versioning": Object {
+      "defaultVersion": "1.0.1",
+      "enabled": true,
+      "latestVersion": "1.0.1",
+      "versions": Array [
+        "1.0.1",
+        "1.0.0",
+      ],
+    },
+  },
+  "outDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/versioned-site/build",
+  "pagesData": Array [
+    Object {
+      "path": "/",
+      "source": "index.js",
+    },
+    Object {
+      "path": "/hello/world",
+      "source": "hello/world.js",
+    },
+  ],
+  "pagesDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/versioned-site/pages",
+  "siteConfig": Object {
+    "baseUrl": "/",
+    "organizationName": "endiliey",
+    "projectName": "hello",
+    "tagline": "Hello World",
+    "title": "Hello",
+  },
+  "siteDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/versioned-site",
+  "themePath": "/mnt/c/Users/endij/Desktop/Linux/munseo/lib/theme",
+}
+`;

test/load/docs/index.test.js

@@ -0,0 +1,23 @@
+import loadSetup from '../../loadSetup';
+
+describe('loadDocs', () => {
+  test('simple website', async () => {
+    const props = await loadSetup('simple');
+    expect(props).toMatchSnapshot();
+  });
+
+  test('versioned website', async () => {
+    const props = await loadSetup('versioned');
+    expect(props).toMatchSnapshot();
+  });
+
+  test('versioned & translated website', async () => {
+    const props = await loadSetup('transversioned');
+    expect(props).toMatchSnapshot();
+  });
+
+  test('translated website', async () => {
+    const props = await loadSetup('translated');
+    expect(props).toMatchSnapshot();
+  });
+});

test/load/pages.test.js

@@ -5,7 +5,24 @@ describe('loadPages', () => {
   test('valid pages', async () => {
     const pagesDir = path.join(__dirname, '__fixtures__', 'simple-pages');
     const pagesData = await loadPages(pagesDir);
-    expect(pagesData).toMatchSnapshot();
+    expect(pagesData).toEqual([
+      {
+        path: '/',
+        source: 'index.js'
+      },
+      {
+        path: '/foo',
+        source: 'foo.js'
+      },
+      {
+        path: '/foo/',
+        source: 'foo/index.js'
+      },
+      {
+        path: '/bar/baz',
+        source: 'bar/baz.js'
+      }
+    ]);
     expect(pagesData).not.toBeNull();
   });
 

test/load/routes.test.js

@@ -1,39 +1,24 @@
 import genRoutesConfig from '@lib/load/routes';
-import loadDocs from '@lib/load/docs';
-import loadPages from '@lib/load/pages';
-import path from 'path';
+import loadSetup from '../loadSetup';
 
 describe('genRoutesConfig', () => {
-  const pagesDir = path.join(__dirname, '__fixtures__', 'simple-pages');
-  const docsDir = path.join(__dirname, '__fixtures__', 'simple-docs');
-
-  test('website with pages and docs', async () => {
-    const props = {
-      docsData: await loadDocs(docsDir),
-      pagesData: await loadPages(pagesDir)
-    };
-    const routes = await genRoutesConfig(props);
-    expect(routes).toMatchSnapshot();
+  test('simple website', async () => {
+    const props = await loadSetup('simple');
+    await genRoutesConfig(props);
   });
 
-  test('website with only pages', async () => {
-    const props = {
-      pagesData: await loadPages(pagesDir)
-    };
-    const routes = await genRoutesConfig(props);
-    expect(routes).toMatchSnapshot();
+  test('versioned website', async () => {
+    const props = await loadSetup('versioned');
+    await genRoutesConfig(props);
   });
 
-  test('website with only docs', async () => {
-    const props = {
-      docsData: await loadDocs(docsDir)
-    };
-    const routes = await genRoutesConfig(props);
-    expect(routes).toMatchSnapshot();
+  test('versioned & translated website', async () => {
+    const props = await loadSetup('transversioned');
+    await genRoutesConfig(props);
   });
 
-  test('website with no docs/pages', async () => {
-    const routes = await genRoutesConfig({});
-    expect(routes).toMatchSnapshot();
+  test('translated website', async () => {
+    const props = await loadSetup('translated');
+    await genRoutesConfig(props);
   });
 });