archy

WebJar for archy

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

archy
Last Version

Last Version

1.0.0
Release Date

Release Date

Type

Type

jar
Description

Description

archy
WebJar for archy
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

http://github.com/substack/node-archy

Download archy

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/archy/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>archy</artifactId>
    <version>1.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/archy/
implementation 'org.webjars.npm:archy:1.0.0'
// https://jarcasting.com/artifacts/org.webjars.npm/archy/
implementation ("org.webjars.npm:archy:1.0.0")
'org.webjars.npm:archy:jar:1.0.0'
<dependency org="org.webjars.npm" name="archy" rev="1.0.0">
  <artifact name="archy" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='archy', version='1.0.0')
)
libraryDependencies += "org.webjars.npm" % "archy" % "1.0.0"
[org.webjars.npm/archy "1.0.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

archy

Render nested hierarchies npm ls style with unicode pipes.

browser support

build status

example

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 do:

npm install archy

license

MIT

Versions

Version
1.0.0