node-archy-1.0.0/000077500000000000000000000000001302573762100135475ustar00rootroot00000000000000node-archy-1.0.0/.travis.yml000066400000000000000000000000531302573762100156560ustar00rootroot00000000000000language: node_js node_js: - 0.6 - 0.8 node-archy-1.0.0/LICENSE000066400000000000000000000020611302573762100145530ustar00rootroot00000000000000This software is released under the MIT license: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. node-archy-1.0.0/examples/000077500000000000000000000000001302573762100153655ustar00rootroot00000000000000node-archy-1.0.0/examples/beep.js000066400000000000000000000006031302573762100166350ustar00rootroot00000000000000var archy = require('../'); var s = archy({ label : 'beep', nodes : [ 'ity', { label : 'boop', nodes : [ { label : 'o_O', nodes : [ { label : 'oh', nodes : [ 'hello', 'puny' ] }, 'human' ] }, 'party\ntime!' ] } ] }); console.log(s); node-archy-1.0.0/examples/multi_line.js000066400000000000000000000006361302573762100200710ustar00rootroot00000000000000var archy = require('../'); var s = archy({ label : 'beep\none\ntwo', nodes : [ 'ity', { label : 'boop', nodes : [ { label : 'o_O\nwheee', nodes : [ { label : 'oh', nodes : [ 'hello', 'puny\nmeat' ] }, 'creature' ] }, 'party\ntime!' ] } ] }); console.log(s); node-archy-1.0.0/index.js000066400000000000000000000021641302573762100152170ustar00rootroot00000000000000module.exports = function archy (obj, prefix, opts) { if (prefix === undefined) prefix = ''; if (!opts) opts = {}; var chr = function (s) { var chars = { '│' : '|', '└' : '`', '├' : '+', '─' : '-', '┬' : '-' }; return opts.unicode === false ? chars[s] : s; }; if (typeof obj === 'string') obj = { label : obj }; var nodes = obj.nodes || []; var lines = (obj.label || '').split('\n'); var splitter = '\n' + prefix + (nodes.length ? chr('│') : ' ') + ' '; return prefix + lines.join(splitter) + '\n' + nodes.map(function (node, ix) { var last = ix === nodes.length - 1; var more = node.nodes && node.nodes.length; var prefix_ = prefix + (last ? ' ' : chr('│')) + ' '; return prefix + (last ? chr('└') : chr('├')) + chr('─') + (more ? chr('┬') : chr('─')) + ' ' + archy(node, prefix_, opts).slice(prefix.length + 2) ; }).join('') ; }; node-archy-1.0.0/package.json000066400000000000000000000017221302573762100160370ustar00rootroot00000000000000{ "name" : "archy", "version" : "1.0.0", "description" : "render nested hierarchies `npm ls` style with unicode pipes", "main" : "index.js", "devDependencies" : { "tap" : "~0.3.3", "tape" : "~0.1.1" }, "scripts" : { "test" : "tap test" }, "testling" : { "files" : "test/*.js", "browsers" : { "iexplore" : [ "6.0", "7.0", "8.0", "9.0" ], "chrome" : [ "20.0" ], "firefox" : [ "10.0", "15.0" ], "safari" : [ "5.1" ], "opera" : [ "12.0" ] } }, "repository" : { "type" : "git", "url" : "http://github.com/substack/node-archy.git" }, "keywords" : [ "hierarchy", "npm ls", "unicode", "pretty", "print" ], "author" : { "name" : "James Halliday", "email" : "mail@substack.net", "url" : "http://substack.net" }, "license" : "MIT" } node-archy-1.0.0/readme.markdown000066400000000000000000000033411302573762100165510ustar00rootroot00000000000000# archy Render nested hierarchies `npm ls` style with unicode pipes. [![browser support](http://ci.testling.com/substack/node-archy.png)](http://ci.testling.com/substack/node-archy) [![build status](https://secure.travis-ci.org/substack/node-archy.png)](http://travis-ci.org/substack/node-archy) # example ``` js var archy = require('archy'); var s = archy({ label : 'beep', nodes : [ 'ity', { label : 'boop', nodes : [ { label : 'o_O', nodes : [ { label : 'oh', nodes : [ 'hello', 'puny' ] }, 'human' ] }, 'party\ntime!' ] } ] }); console.log(s); ``` output ``` beep ├── ity └─┬ boop ├─┬ o_O │ ├─┬ oh │ │ ├── hello │ │ └── puny │ └── human └── party time! ``` # methods var archy = require('archy') ## archy(obj, prefix='', opts={}) Return a string representation of `obj` with unicode pipe characters like how `npm ls` looks. `obj` should be a tree of nested objects with `'label'` and `'nodes'` fields. `'label'` is a string of text to display at a node level and `'nodes'` is an array of the descendents of the current node. If a node is a string, that string will be used as the `'label'` and an empty array of `'nodes'` will be used. `prefix` gets prepended to all the lines and is used by the algorithm to recursively update. If `'label'` has newlines they will be indented at the present indentation level with the current prefix. To disable unicode results in favor of all-ansi output set `opts.unicode` to `false`. # install With [npm](http://npmjs.org) do: ``` npm install archy ``` # license MIT node-archy-1.0.0/test/000077500000000000000000000000001302573762100145265ustar00rootroot00000000000000node-archy-1.0.0/test/beep.js000066400000000000000000000015021302573762100157750ustar00rootroot00000000000000var test = require('tape'); var archy = require('../'); test('beep', function (t) { var s = archy({ label : 'beep', nodes : [ 'ity', { label : 'boop', nodes : [ { label : 'o_O', nodes : [ { label : 'oh', nodes : [ 'hello', 'puny' ] }, 'human' ] }, 'party!' ] } ] }); t.equal(s, [ 'beep', '├── ity', '└─┬ boop', ' ├─┬ o_O', ' │ ├─┬ oh', ' │ │ ├── hello', ' │ │ └── puny', ' │ └── human', ' └── party!', '' ].join('\n')); t.end(); }); node-archy-1.0.0/test/multi_line.js000066400000000000000000000017401302573762100172270ustar00rootroot00000000000000var test = require('tape'); var archy = require('../'); test('multi-line', function (t) { var s = archy({ label : 'beep\none\ntwo', nodes : [ 'ity', { label : 'boop', nodes : [ { label : 'o_O\nwheee', nodes : [ { label : 'oh', nodes : [ 'hello', 'puny\nmeat' ] }, 'creature' ] }, 'party\ntime!' ] } ] }); t.equal(s, [ 'beep', '│ one', '│ two', '├── ity', '└─┬ boop', ' ├─┬ o_O', ' │ │ wheee', ' │ ├─┬ oh', ' │ │ ├── hello', ' │ │ └── puny', ' │ │ meat', ' │ └── creature', ' └── party', ' time!', '' ].join('\n')); t.end(); }); node-archy-1.0.0/test/non_unicode.js000066400000000000000000000014371302573762100173710ustar00rootroot00000000000000var test = require('tape'); var archy = require('../'); test('beep', function (t) { var s = archy({ label : 'beep', nodes : [ 'ity', { label : 'boop', nodes : [ { label : 'o_O', nodes : [ { label : 'oh', nodes : [ 'hello', 'puny' ] }, 'human' ] }, 'party!' ] } ] }, '', { unicode : false }); t.equal(s, [ 'beep', '+-- ity', '`-- boop', ' +-- o_O', ' | +-- oh', ' | | +-- hello', ' | | `-- puny', ' | `-- human', ' `-- party!', '' ].join('\n')); t.end(); });