feat(filter): added filters to remove unwanted strings

Author: fabianmoronzirfas

.bin/json-transform.js

@@ -7,6 +7,7 @@ const Tag = require('./lib/tag');
 const Category = require('./lib/category');
 const _ = require('lodash');
 const generator = require('./lib/generator');
+const Filters = require('./lib/filters');
 
 
 let data = [];
@@ -108,6 +109,14 @@ api.forEach((e, i, arr)=> {
   data.push(entry);
 });
 
+// Some filtering
+let filter = new Filters();
+data.forEach((element)=>{
+
+  console.log(element);
+  element.name = filter.dotNull(element.name);
+});
+
 data = generator(data);
 // taken from here
 // http://stackoverflow.com/questions/23600897/using-lodash-groupby-how-to-add-your-own-keys-for-grouped-output

.bin/lib/filters.js

@@ -0,0 +1,13 @@
+var exports = module.exports = {};
+
+function Filters () {
+
+  this.dotNull = function(str) {
+    if(str.endsWith('.null') === true) {
+      str = str.split('.null')[0];
+    }
+    return str;
+  };
+}
+
+module.exports = Filters;

.bin/lib/generator.js

@@ -17,7 +17,7 @@ function generator(data) {
       });
 
       element.codetitle = `b.${element.name}(${params})`;
-      console.log(element);
+      // console.log(element);
 
     }else if (element.kind.toString() === 'constant') {
       element.codetitle = `b.${element.name}`;

_data/categories.json

@@ -4084,7 +4084,7 @@
         "codetitle": "b.noise(x, [y], [z])"
       },
       {
-        "name": "noiseDetail.null",
+        "name": "noiseDetail",
         "description": "Adjusts the character and level of detail produced by the Perlin noise function. Similar to harmonics in physics, noise is computed over several octaves. Lower octaves contribute more to the output signal and as such define the overal intensity of the noise, whereas higher octaves create finer grained details in the noise sequence. By default, noise is computed over 4 octaves with each octave contributing exactly half than its predecessor, starting at 50% strength for the 1st octave. This falloff amount can be changed by adding an additional function parameter. Eg. a falloff factor of 0.75 means each octave will now have 75% impact (25% less) of the previous lower octave. Any value between 0.0 and 1.0 is valid, however note that values greater than 0.5 might result in greater than 1.0 values returned by noise().",
         "returns": null,
         "category": "Math",
@@ -4109,7 +4109,7 @@
         ],
         "kind": "function",
         "tags": [],
-        "codetitle": "b.noiseDetail.null(octaves, fallout)"
+        "codetitle": "b.noiseDetail(octaves, fallout)"
       },
       {
         "name": "noiseSeed",

_data/sub-categories.json

@@ -5549,7 +5549,7 @@
         "codetitle": "b.noise(x, [y], [z])"
       },
       {
-        "name": "noiseDetail.null",
+        "name": "noiseDetail",
         "description": "Adjusts the character and level of detail produced by the Perlin noise function. Similar to harmonics in physics, noise is computed over several octaves. Lower octaves contribute more to the output signal and as such define the overal intensity of the noise, whereas higher octaves create finer grained details in the noise sequence. By default, noise is computed over 4 octaves with each octave contributing exactly half than its predecessor, starting at 50% strength for the 1st octave. This falloff amount can be changed by adding an additional function parameter. Eg. a falloff factor of 0.75 means each octave will now have 75% impact (25% less) of the previous lower octave. Any value between 0.0 and 1.0 is valid, however note that values greater than 0.5 might result in greater than 1.0 values returned by noise().",
         "returns": null,
         "category": "Math",
@@ -5574,7 +5574,7 @@
         ],
         "kind": "function",
         "tags": [],
-        "codetitle": "b.noiseDetail.null(octaves, fallout)"
+        "codetitle": "b.noiseDetail(octaves, fallout)"
       },
       {
         "name": "noiseSeed",

math/noiseDetail.md

@@ -7,8 +7,8 @@ category: Math
 subcategory: Random
 returns: null
 parameters:
-    - {name: octaves, description: 'number of octaves to be used by the noise() function', optional: false, type: [Number]}
-    - {name: fallout, description: 'falloff factor for each octave', optional: false, type: [Number]}
+    - {name: octaves, description: 'Number of octaves to be used by the noise() function.', optional: false, type: [Number]}
+    - {name: fallout, description: 'Falloff factor for each octave.', optional: false, type: [Number]}
 kind: function
 
 ---