feat(added pages and index as include):

Author: fabianmoronzirfas

.bin/files-and-folders.js

@@ -17,32 +17,20 @@ data.forEach((element, index, array)=>{
       let file = `./${element.cat.toLowerCase()}/${e.name}.md`;
       let frontmatter = YAML.stringify({
         layout: 'entry',
-        title: e.name + (e.kind === 'function' ? '()' : ''),
+        title: e.name,
+        codetitle: e.codetitle,
         description: e.description,
         category: e.category,
         subcategory: e.subcategory,
         returns: e.returns,
-        parameters: e.parameters
+        parameters: e.parameters,
+        kind: e.kind
       }, 2);
-      fs.outputFile(file, `---\n${frontmatter}\n---\n${e.description}`, (error)=>{
+      fs.outputFile(file, `---\n${frontmatter}\n---\n`, (error)=>{
         if(error) {
           console.log(error);
         }
       });
     });
-    // test if the folder exists
-    // try{
-    //   fs.accessSync(dir);
-    //   console.log(`folder ${dir} exists`);
-    // }catch(error) {
-    //   if (error && error.code === 'ENOENT') {
-    //     console.log(`folder '${dir}' does not exist`);
-    //     try{
-
-    //     fs.mkdirSync(dir);
-    //   }catch(e)
-    //   }
-
-    // }
   }
 });

.bin/json-transform.js

@@ -2,9 +2,11 @@ const fs = require('fs');
 const api = require('../_data/api.json');
 const Entry = require('./lib/entry');
 const Parameter = require('./lib/parameter');
+const Return = require('./lib/returns');
 const Tag = require('./lib/tag');
 const Category = require('./lib/category');
 const _ = require('lodash');
+const generator = require('./lib/generator');
 
 
 let data = [];
@@ -18,15 +20,15 @@ api.forEach((e, i, arr)=> {
   if(e.hasOwnProperty('kind') === true) {
     entry.kind = e.kind;
   }
-  if(Array.isArray(e.params)) {
-    e.params.forEach((ele, ndx, array)=> {
-      let param = new Parameter();
-      param.name = ele.name;
-      let descr = (ele.description instanceof Object) ? ele.description.children[0].children[0].value : '';
-      param.description = descr;
-      entry.parameters.push(param);
-    });
-  }
+  // if(Array.isArray(e.params)) {
+  //   e.params.forEach((ele, ndx, array)=> {
+  //     let param = new Parameter();
+  //     param.name = ele.name;
+  //     let descr = (ele.description instanceof Object) ? ele.description.children[0].children[0].value : '';
+  //     param.description = descr;
+  //     entry.parameters.push(param);
+  //   });
+  // }
   if(Array.isArray(e.returns)) {
     if(e.returns[0].description.children.length > 0) {
       let ret = e.returns[0].description.children[0].children[0].value;
@@ -39,7 +41,61 @@ api.forEach((e, i, arr)=> {
         entry.category = ele.description;
       } else if(ele.title === 'subcat') {
         entry.subcategory = ele.description;
-      } else {
+      } else if (ele.title === 'param') {
+        var param = new Parameter();
+        param.name = ele.name;
+        param.description = ele.description;
+        // console.log(ele);
+        if (ele.hasOwnProperty('type')) {
+          if (ele.type !== null) {
+            if (ele.type.hasOwnProperty('type')) {
+              if(ele.type.type === 'NameExpression') {
+                // argument not otional
+                // no multiples
+                param.type.push(ele.type.name);
+              }else if(ele.type.type === 'OptionalType') {
+                param.optional = true;
+                if(ele.type.expression.name === 'UnionType') {
+                  ele.type.expression.elements.forEach((element, index)=>{
+                    param.type.push(element.name);
+                  });
+                }else{
+                  param.type.push(ele.type.expression.name);
+
+                }
+              }else if (ele.type.type === 'UnionType') {
+                ele.type.elements.forEach((element, index)=>{
+                  param.type.push(element.name);
+
+                });
+              }
+            }
+          }
+        }
+        entry.parameters.push(param);
+      } else if (ele.title === 'method') {
+        entry.kind = 'function';
+      }else if (ele.title === 'constant' || ele.title === 'property') {
+        entry.kind = 'constant';
+
+      } else if (ele.title === 'return' || ele.title === 'returns') {
+        let returnValue = new Return();
+        returnValue.description = ele.description;
+        if(ele.hasOwnProperty('type')) {
+          if (ele.type !== null) {
+            if (ele.type.hasOwnProperty('type')) {
+              if(ele.type.type === 'NameExpression') {
+                returnValue.type.push(ele.type.name);
+              }else if(ele.type.type === 'UnionType') {
+                ele.type.elements.forEach((element)=>{
+                  returnValue.type.push(element.name);
+                });
+              }
+            }
+          }
+        }
+        entry.returns = returnValue;
+      }else {
         var tag = new Tag();
         tag.name = ele.name;
         tag.title = ele.title;
@@ -51,6 +107,8 @@ api.forEach((e, i, arr)=> {
   }
   data.push(entry);
 });
+
+data = generator(data);
 // taken from here
 // http://stackoverflow.com/questions/23600897/using-lodash-groupby-how-to-add-your-own-keys-for-grouped-output
 let sortedByCategory = _.chain(data)
@@ -76,12 +134,10 @@ fs.writeFile('./_data/categories.json', JSON.stringify(sortedByCategory, null, 2
   if(err) {
     throw err;
   }
-
 });
 
 fs.writeFile('./_data/sub-categories.json', JSON.stringify(sortedBySubCategory, null, 2), (err)=>{
   if(err) {
     throw err;
   }
-
 });

.bin/lib/generator.js

@@ -0,0 +1,31 @@
+/**
+ * Generates data from existing one
+ *
+ */
+var exports = module.exports = {};
+
+
+function generator(data) {
+  data.forEach((element)=>{
+    element.codetitle = null;
+    if(element.kind.toString() === 'function') {
+      let params = '';
+      element.parameters.forEach((ele, ndx, arr)=>{
+        let name = (ele.optional === true) ? `[${ele.name}]` : ele.name;
+        let sep = (ndx + 1 !== arr.length) ? ', ' : '';
+        params += name + sep;
+      });
+
+      element.codetitle = `b.${element.name}(${params})`;
+      console.log(element);
+
+    }else if (element.kind.toString() === 'constant') {
+      element.codetitle = `b.${element.name}`;
+    } else if(element.kind.toString() === 'class') {
+      element.codetitle = `${element.name}`;
+    }
+  });
+  return data;
+}
+
+module.exports = generator;

.bin/lib/parameter.js

@@ -3,7 +3,8 @@ var exports = module.exports = {};
 function Paramter() {
   this.name = null;
   this.description = null;
-  this.optional = null;
+  this.optional = false;
+  this.type = [];
 }
 
 module.exports = Paramter;

.bin/lib/returns.js

@@ -0,0 +1,9 @@
+var exports = module.exports = {};
+
+function Return() {
+  this.name = null;
+  this.description = null;
+  this.type = [];
+}
+
+module.exports = Return;