feat(files): generate all files from categories

Author: fabianmoronzirfas

.bin/Notes.md

@@ -8,4 +8,8 @@ Search using lunr.js
 
 http://jekyll.tips/jekyll-casts/jekyll-search-using-lunr-js/
 
-http://matthewdaly.co.uk/blog/2015/04/18/how-i-added-search-to-my-site-with-lunr-dot-js/
+http://matthewdaly.co.uk/blog/2015/04/18/how-i-added-search-to-my-site-with-lunr-dot-js/
+
+Split by categories
+
+http://stackoverflow.com/questions/14696326/break-array-of-objects-into-separate-arrays-based-on-a-property

.bin/files-and-folders.js

@@ -0,0 +1,48 @@
+// 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 OVERWRITE = true; // if we want to recreate everyting
+// console.log(process.cwd());
+data.forEach((element, index, array)=>{
+  if(element.cat !== null && element.cat !== 'null') {
+    element.entries.forEach((e, i, arr)=>{
+      console.log(e);
+      let file = `./${element.cat.toLowerCase()}/${e.name}.md`;
+      let frontmatter = YAML.stringify({
+        layout: 'entry',
+        title: e.name + (e.kind === 'function' ? '()' : ''),
+        description: e.description,
+        category: e.category,
+        subcategory: e.subcategory,
+        returns: e.returns,
+        parameters: e.parameters
+      }, 2);
+      fs.outputFile(file, `---\n${frontmatter}\n---\n${e.description}`, (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,6 +2,9 @@ const fs = require('fs');
 const api = require('../_data/api.json');
 const Entry = require('./lib/entry');
 const Parameter = require('./lib/parameter');
+const Category = require('./lib/category');
+const _ = require('lodash');
+
 
 let data = [];
 
@@ -15,6 +18,9 @@ api.forEach((e, i, arr)=> {
     // console.log(`## Description:\n${des}`);
     entry.description = des;
   }
+  if(e.hasOwnProperty('kind') === true) {
+    entry.kind = e.kind;
+  }
 
   if(Array.isArray(e.params)) {
     // console.log('\n### Parameters:');
@@ -66,8 +72,38 @@ api.forEach((e, i, arr)=> {
 });
 
 // console.log(JSON.stringify(data, null, 2));
+// taken from here
+// http://stackoverflow.com/questions/23600897/using-lodash-groupby-how-to-add-your-own-keys-for-grouped-output
+let sortedByCategory = _.chain(data)
+ .groupBy('category')
+ .map((key, val)=>{
+   return {
+     entries: key,
+     cat: val
+   };
+ }).value();
+
+let sortedBySubCategory = _.chain(data)
+ .groupBy('subcategory')
+ .map((key, val)=>{
+   return {
+     entries: key,
+     subcat: val
+   };
+ }).value();
+
+
+// console.log(JSON.stringify(sortedBySubCategory, null, 2));
+
+
+fs.writeFile('./_data/categories.json', JSON.stringify(sortedByCategory, null, 2), (err)=>{
+  if(err) {
+    throw err;
+  }
+  // //console.log('saved');
+});
 
-fs.writeFile('./_data/data.json', JSON.stringify(data), (err)=>{
+fs.writeFile('./_data/sub-categories.json', JSON.stringify(sortedBySubCategory, null, 2), (err)=>{
   if(err) {
     throw err;
   }

.bin/lib/category.js

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

.bin/lib/entry.js

@@ -7,6 +7,7 @@ function Entry() {
   this.category = null;
   this.subcategory = null;
   this.parameters = [];
+  this.kind = null;
 }
 
 module.exports = Entry;