UNPKG

bower

Version:

The browser package manager

65 lines (64 loc) 3.15 kB
{ "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": "git+ssh://git@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", "readme": "# archy\n\nRender nested hierarchies `npm ls` style with unicode pipes.\n\n[![browser support](http://ci.testling.com/substack/node-archy.png)](http://ci.testling.com/substack/node-archy)\n\n[![build status](https://secure.travis-ci.org/substack/node-archy.png)](http://travis-ci.org/substack/node-archy)\n\n# example\n\n``` js\nvar archy = require('archy');\nvar s = archy({\n label : 'beep',\n nodes : [\n 'ity',\n {\n label : 'boop',\n nodes : [\n {\n label : 'o_O',\n nodes : [\n {\n label : 'oh',\n nodes : [ 'hello', 'puny' ]\n },\n 'human'\n ]\n },\n 'party\\ntime!'\n ]\n }\n ]\n});\nconsole.log(s);\n```\n\noutput\n\n```\nbeep\n├── ity\n└─┬ boop\n ├─┬ o_O\n │ ├─┬ oh\n │ │ ├── hello\n │ │ └── puny\n │ └── human\n └── party\n time!\n```\n\n# methods\n\nvar archy = require('archy')\n\n## archy(obj, prefix='', opts={})\n\nReturn a string representation of `obj` with unicode pipe characters like how\n`npm ls` looks.\n\n`obj` should be a tree of nested objects with `'label'` and `'nodes'` fields.\n`'label'` is a string of text to display at a node level and `'nodes'` is an\narray of the descendents of the current node.\n\nIf a node is a string, that string will be used as the `'label'` and an empty\narray of `'nodes'` will be used.\n\n`prefix` gets prepended to all the lines and is used by the algorithm to\nrecursively update.\n\nIf `'label'` has newlines they will be indented at the present indentation level\nwith the current prefix.\n\nTo disable unicode results in favor of all-ansi output set `opts.unicode` to\n`false`.\n\n# install\n\nWith [npm](http://npmjs.org) do:\n\n```\nnpm install archy\n```\n\n# license\n\nMIT\n", "readmeFilename": "readme.markdown", "bugs": { "url": "https://github.com/substack/node-archy/issues" }, "homepage": "https://github.com/substack/node-archy#readme", "_id": "archy@1.0.0", "_shasum": "f9c8c13757cc1dd7bc379ac77b2c62a5c2868c40", "_resolved": "https://registry.npmjs.org/archy/-/archy-1.0.0.tgz", "_from": "archy@1.0.0" }