Merge pull request #5 from facebook/docs-a

[website] Extract platform metadata from components
expo · Jul 24, 2015 · 62a5584 · 62a5584
2 parents d15b077 + f88ec5f
commit 62a5584
Showing 1 changed file with 29 additions and 4 deletions.
diff --git a/website/server/extractDocs.js b/website/server/extractDocs.js
@@ -14,6 +14,14 @@ var path = require('path');
 var slugify = require('../core/slugify');
 var jsDocs = require('../jsdocs/jsdocs.js');
 
+var ANDROID_SUFFIX = 'android';
+var CROSS_SUFFIX = 'cross';
+var IOS_SUFFIX = 'ios';
+
+function endsWith(str, suffix) {
+  return str.indexOf(suffix, str.length - suffix.length) !== -1;
+}
+
 function getNameFromPath(filepath) {
   var ext = null;
   while (ext = path.extname(filepath)) {
@@ -30,10 +38,24 @@ function getNameFromPath(filepath) {
   return filepath;
 }
 
-function getExample(componentName) {
+function getPlatformFromPath(filepath) {
+  var ext = null;
+  while (ext = path.extname(filepath)) {
+    filepath = path.basename(filepath, ext);
+  }
+
+  if (endsWith(filepath, 'Android')) {
+    return ANDROID_SUFFIX;
+  } else if (endsWith(filepath, 'IOS')) {
+    return IOS_SUFFIX;
+  }
+  return CROSS_SUFFIX;
+}
+
+function getExample(componentName, componentPlatform) {
   var path = '../Examples/UIExplorer/' + componentName + 'Example.js';
   if (!fs.existsSync(path)) {
-    path = '../Examples/UIExplorer/' + componentName + 'Example.ios.js';
+    path = '../Examples/UIExplorer/' + componentName + 'Example.'+ componentPlatform +'.js';
     if (!fs.existsSync(path)) {
       return;
     }
@@ -83,18 +105,20 @@ function getNextComponent(i) {
 
 function componentsToMarkdown(type, json, filepath, i, styles) {
   var componentName = getNameFromPath(filepath);
-
+  var componentPlatform = getPlatformFromPath(filepath);
   var docFilePath = '../docs/' + componentName + '.md';
+
   if (fs.existsSync(docFilePath)) {
     json.fullDescription = fs.readFileSync(docFilePath).toString();
   }
   json.type = type;
   json.filepath = filepath.replace(/^\.\.\//, '');
   json.componentName = componentName;
+  json.componentPlatform = componentPlatform;
   if (styles) {
     json.styles = styles;
   }
-  json.example = getExample(componentName);
+  json.example = getExample(componentName, componentPlatform);
 
   // Put Flexbox into the Polyfills category
   var category = (type === 'style' ? 'Polyfills' : type + 's');
@@ -107,6 +131,7 @@ function componentsToMarkdown(type, json, filepath, i, styles) {
     'layout: autodocs',
     'category: ' + category,
     'permalink: docs/' + slugify(componentName) + '.html',
+    'platform: ' + componentPlatform,
     'next: ' + next,
     'sidebar: ' + shouldDisplayInSidebar(componentName),
     'runnable:' + isRunnable(componentName),