treeify - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

package.json

 {
   "name": "treeify",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "author": "Luke Plaster <[e-mail]>",
@@ -5,0 +5,0 @@ "description": "converts a JS object into a nice, visible tree structure for the console",

README.md

@@ -46,2 +46,12 @@ node-treeify
 
+The methods exposed to you are as follows, in a strange kind of signature notation:
+### asLines()
+```js
+treeify.asLines(obj, showValues (boolean), lineCallback (function))
+```
+### asTree()
+```js
+treeify.asTree(obj, showValues (boolean), hideFunctions (boolean)): String
+```
+
 Running the tests
@@ -48,0 +58,0 @@ -----------------

test/tree-test.js

@@ -21,4 +21,4 @@ var treeify = require('../treeify'),
 function treeifyEntirely(obj) {
-   return function(showValues) {
-      return treeify.asTree(obj, showValues);
+   return function(showValues, hideFunctions) {
+      return treeify.asTree(obj, showValues, hideFunctions);
    };
@@ -28,5 +28,10 @@ }
 function withValuesShown(showValues) {
-   return function(func){ return func(showValues) };
+   return function(func){ return func(showValues, false) };
 }
 
+function withValuesShownFunctionsHidden() {
+  return function(func){ return func(true, true) };
+  
+}
+
 function is(content, arrayIndex) {
@@ -288,4 +293,29 @@ return function(lines) {
       }
+   },
+   'A tree with functions': {
+      topic: {
+        func:function(){},
+        Friendly:"stuff",
+        Another:"stuff"
+      },
+
+      'when returned as a whole tree': {
+         topic: treeifyEntirely,
+
+         'with values shown, but functions hidden': {
+            topic: withValuesShownFunctionsHidden(),
+
+            'and split into an array of lines': {
+               topic: function(tree) { 
+                 console.error(tree);
+                 return tree.split(/\n/g) },
+               'is a one liner output (with a following blank line)': function(lines) {
+                  assert.equal(lines.length, 3);
+               },
+               'has a correct first line': is('├─ Friendly: stuff', 0)
+            }
+         }
+      }
    }
 
 }).export(module);

treeify.js

@@ -25,3 +25,3 @@ //     treeify.js
 
-  function growBranch(key, root, last, lastStates, showValues, callback) {
+  function growBranch(key, root, last, lastStates, showValues, hideFunctions, callback) {
     var line = '', index = 0, lastKey, circular, lastStatesCopy = lastStates.slice(0);
@@ -56,8 +56,11 @@
         // always exclude anything in the object's prototype
-        if ( ! root.hasOwnProperty(branch)) {
+        if (!root.hasOwnProperty(branch)) {
           continue;
         }
+        if (hideFunctions&& ((typeof root[branch])==="function")) {
+                      continue;
+                    }
         // hold your breath for recursive action
         lastKey = ++index === Object.keys(root).length;
-        growBranch(branch, root[branch], lastKey, lastStatesCopy, showValues, callback);
+        growBranch(branch, root[branch], lastKey, lastStatesCopy, showValues, hideFunctions, callback);
       }
@@ -79,5 +82,5 @@ }
 
-  Treeify.asTree = function(obj, showValues) {
+  Treeify.asTree = function(obj, showValues, hideFunctions) {
     var tree = '';
-    growBranch('.', obj, false, [], showValues, function(line) {
+    growBranch('.', obj, false, [], showValues, hideFunctions, function(line) {
       tree += line + '\n';
@@ -87,3 +90,4 @@ });
   };
+  
 
 })();

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Non-existent author

Supply chain risk

The package was published by an npm account that no longer exists.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18043

increased by8.11%

Lines of code

429

increased by6.98%

Number of lines in readme file

64

increased by18.52%

Number of high supply chain risk alerts

0

decreased by-100%

No dependency changes