address code review & fix typo from prevs refactor

facebook · Jun 5, 2018 · fcd0180 · fcd0180
1 parent c519ea5
commit fcd0180
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 30 deletions.
diff --git a/lib/core/DocsLayout.js b/lib/core/DocsLayout.js
@@ -16,6 +16,15 @@ const path = require('path');
 
 // component used to generate whole webpage for docs, including sidebar/header/footer
 class DocsLayout extends React.Component {
+  getRelativeURL = (from, to) => {
+    return (
+      path
+        .relative(from, to)
+        .replace('\\', '/')
+        .replace(/^\.\.\//, '') + '.html'
+    );
+  };
+
   render() {
     const metadata = this.props.metadata;
     const content = this.props.children;
@@ -55,12 +64,10 @@ class DocsLayout extends React.Component {
               {metadata.previous_id && (
                 <a
                   className="docs-prev button"
-                  href={
-                    path
-                      .relative(metadata.localized_id, metadata.previous_id)
-                      .replace('\\', '/')
-                      .replace(/^\.\.\//, '') + '.html'
-                  }>
+                  href={this.getRelativeURL(
+                    metadata.localized_id,
+                    metadata.previous_id
+                  )}>
                   ←{' '}
                   {i18n
                     ? translation[this.props.metadata.language][
@@ -76,12 +83,10 @@ class DocsLayout extends React.Component {
               {metadata.next_id && (
                 <a
                   className="docs-next button"
-                  href={
-                    path
-                      .relative(metadata.localized_id, metadata.next_id)
-                      .replace('\\', '/')
-                      .replace(/^\.\.\//, '') + '.html'
-                  }>
+                  href={this.getRelativeURL(
+                    metadata.localized_id,
+                    metadata.next_id
+                  )}>
                   {i18n
                     ? translation[this.props.metadata.language][
                         'localized-strings'

diff --git a/lib/server/readMetadata.js b/lib/server/readMetadata.js
@@ -149,12 +149,12 @@ function processMetadata(file, refDir) {
   //  returns 'projectA/test'
   const subDir = utils.getSubDir(file, refDir);
   if (subDir) {
-    metadata.id = subDir + '/' + metadata.id;
+    metadata.id = `${subDir}/${metadata.id}`;
   }
 
   // Example: `docs/projectA/test.md` source is `projectA/test.md`
   metadata.source = subDir
-    ? subDir + '/' + path.basename(file)
+    ? `${subDir}/${path.basename(file)}`
     : path.basename(file);
 
   if (!metadata.title) {
@@ -216,14 +216,15 @@ function generateMetadataDocs() {
   const defaultMetadatas = {};
 
   // metadata for english files
+  const docsDir = path.join(CWD, '../', getDocsPath());
   let files = glob.sync(CWD + '/../' + getDocsPath() + '/**');
   files.forEach(file => {
     let language = 'en';
 
     const extension = path.extname(file);
 
     if (extension === '.md' || extension === '.markdown') {
-      const res = processMetadata(file, path.join(CWD, '../', getDocsPath()));
+      const res = processMetadata(file, docsDir);
 
       if (!res) {
         return;

diff --git a/lib/server/versionFallback.js b/lib/server/versionFallback.js
@@ -204,18 +204,16 @@ function processVersionMetadata(file, version, useVersion, language) {
     path.join(CWD, 'versioned_docs', `version-${useVersion}`)
   );
   if (subDir) {
-    metadata.original_id = subDir + '/' + metadata.original_id;
+    metadata.original_id = `${subDir}/${metadata.original_id}`;
     metadata.id = metadata.id.replace(
-      'version-' + useVersion + '-',
-      'version-' + useVersion + '-' + subDir + '/'
+      `version-${useVersion}-`,
+      `version-${useVersion}-${subDir}/`
     );
   }
 
-  metadata.source =
-    'version-' +
-    useVersion +
-    '/' +
-    (subDir ? subDir + '/' + path.basename(file) : path.basename(file));
+  metadata.source = subDir
+    ? `version-${useVersion}/${subDir}/${path.basename(file)}`
+    : `version-${useVersion}/${path.basename(file)}`;
 
   const latestVersion = versions[0];
 

diff --git a/lib/version.js b/lib/version.js
@@ -13,6 +13,7 @@ const path = require('path');
 const mkdirp = require('mkdirp');
 const chalk = require('chalk');
 const readMetadata = require('./server/readMetadata.js');
+const utils = require('./server/utils.js');
 const versionFallback = require('./server/versionFallback.js');
 const env = require('./server/env.js');
 
@@ -108,12 +109,11 @@ files.forEach(file => {
   metadata.original_id = metadata.id;
   metadata.id = 'version-' + version + '-' + metadata.id;
 
-  let filePath = path.basename(file);
-  const subDir = readMetadata.getSubDir(file);
-  if (subDir) {
-    filePath = subDir + '/' + filePath;
-  }
-  const targetFile = versionFolder + '/' + filePath;
+  const docsDir = path.join(CWD, '../', readMetadata.getDocsPath());
+  const subDir = utils.getSubDir(file, docsDir);
+  const targetFile = subDir
+    ? `${versionFolder}/${subDir}/${path.basename(file)}`
+    : `${versionFolder}/${path.basename(file)}`;
 
   writeFileAndCreateFolder(
     targetFile,

diff --git a/lib/write-translations.js b/lib/write-translations.js
@@ -46,13 +46,13 @@ function execute() {
   };
 
   // look through markdown headers of docs for titles and categories to translate
+  const docsDir = path.join(CWD, '../', readMetadata.getDocsPath());
   let files = glob.sync(CWD + '/../' + readMetadata.getDocsPath() + '/**');
   files.forEach(file => {
     const extension = path.extname(file);
     if (extension === '.md' || extension === '.markdown') {
       let res;
       try {
-        const docsDir = path.join(CWD, '../', readMetadata.getDocsPath());
         res = readMetadata.processMetadata(file, docsDir);
       } catch (e) {
         console.error(e);