styling and added @examples logic

Author: fabianmoronzirfas

.bin/explore.js

@@ -1,2 +1,6 @@
-const data = require('../_data/cats-and-subcats.json');
-console.log(data);
+// const data = require('../_data/cats-and-subcats.json');
+const data = require('../_data/api.json');
+// console.log(data);
+data.forEach((e)=>{
+  console.log(e.members);
+});

.bin/files-and-folders.js

@@ -6,12 +6,14 @@ const Return = require('./lib/returns');
 const Tag = require('./lib/tag');
 const Category = require('./lib/category');
 const _ = require('lodash');
-const generator = require('./lib/generator');
+const generateData = require('./lib/data-generator');
 const Filters = require('./lib/filters');
+const generateFiles = require('./lib/files-and-folders');
 
 
 let data = [];
-api.forEach((e, i, arr)=> {
+
+function buildEntry(e) {
   let entry = new Entry();
   entry.name = e.name;
   if(e.description instanceof Object) {
@@ -76,9 +78,12 @@ api.forEach((e, i, arr)=> {
         entry.parameters.push(param);
       } else if (ele.title === 'method') {
         entry.kind = 'function';
-      }else if (ele.title === 'constant' || ele.title === 'property') {
+      }else if (ele.title === 'constant') {
         entry.kind = 'constant';
-
+      } else if (ele.title === 'property') {
+        entry.kind = 'property';
+      } else if (ele.title === 'constructor') {
+        entry.kind = 'constructor';
       } else if (ele.title === 'return' || ele.title === 'returns') {
         let returnValue = new Return();
         returnValue.description = ele.description;
@@ -107,6 +112,24 @@ api.forEach((e, i, arr)=> {
     });
   }
   data.push(entry);
+  if(e.members.instance.length > 0) {
+    e.members.instance.forEach((el)=>{
+      buildEntry(el);
+    });
+  }
+  if(e.members.static.length > 0) {
+    e.members.static.forEach((el)=>{
+      buildEntry(el);
+    });
+  }
+  // if(e.members.events.length > 0) {
+  //   e.members.events.forEach((el)=>{
+  //     buildEntry(el);
+  //   });
+  // }
+}
+api.forEach((el)=> {
+  buildEntry(el);
 });
 
 // Some filtering
@@ -118,7 +141,7 @@ data.forEach((element)=>{
   element.category = filter.nullToGlobal(element.category);
 });
 
-data = generator(data);
+data = generateData(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)
@@ -196,3 +219,4 @@ fs.writeFile('./_data/cats-and-subcats.json', JSON.stringify(catsAndSubcats, nul
   }
 });
 
+generateFiles(true);

.bin/json-transform.js renamed to .bin/index.js

@@ -3,23 +3,18 @@
  *
  */
 var exports = module.exports = {};
-
-
 function generator(data) {
   data.forEach((element)=>{
     element.codetitle = null;
-    if(element.kind.toString() === 'function') {
+    if(element.kind.toString() === 'function' || element.kind.toString() === 'constructor') {
       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') {
+    }else if (element.kind.toString() === 'constant' || element.kind.toString() === 'property') {
       element.codetitle = `b.${element.name}`;
     } else if(element.kind.toString() === 'class') {
       element.codetitle = `${element.name}`;

.bin/lib/generator.js renamed to .bin/lib/data-generator.js

@@ -0,0 +1,66 @@
+var exports = module.exports = {};
+
+// should take the data.json
+// and go through all the categories
+// creates
+// - a folder per category
+// - a file for each function/variable
+// only if they don't exist already
+// or a overwrite flag is set
+const fs = require('fs-extra');
+const YAML = require('yamljs');
+const data = require('../../_data/categories.json'); // load the cats
+const pathExists = require('path-exists');
+
+// console.log(process.cwd());
+
+function write(file, str) {
+  fs.outputFile(file, str, (error)=>{
+    if(error) {
+      console.log(error);
+    }
+  });
+}
+function process(ele, folder, ow) {
+  ele.entries.forEach((e, i, arr)=>{
+    // console.log(e);
+    let file = `${folder}${e.name}.md`;
+    let yamlstr = YAML.stringify({
+      layout: 'entry',
+      title: e.name,
+      codetitle: e.codetitle,
+      description: e.description,
+      category: e.category,
+      subcategory: e.subcategory,
+      returns: e.returns,
+      parameters: e.parameters,
+      kind: e.kind
+    }, 2);
+    let frontmatter = `---\n${yamlstr}\n---\n`;
+    if(ow === true) {
+      if(pathExists.sync(file) === true) {
+        console.log(`Overwriting file "${file}"`);
+      }else{
+        console.log(`Creating file "${file}"`);
+      }
+      write(file, frontmatter);
+    } else if(ow === false || pathExists.sync(file) === false) {
+      console.log(`Creating file "${file}"`);
+      write(file, frontmatter);
+    }else if(ow === false || pathExists.sync(file) === true) {
+      console.log(`The file "${file}" already exists`);
+    }
+  });
+}
+
+function generate(overwrite) {
+  data.forEach((element, index, array)=>{
+    if(element.cat !== 'null') {
+      process(element, `./${element.cat.toLowerCase()}/`, overwrite);
+    }else{
+      process(element, './global/', overwrite);
+    }
+  });
+}
+
+module.exports = generate;