# @lunjs/archy

> render nested hierarchies `npm ls` style with unicode pipes

Latest version **0.1.0** (published 2021-11-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lunjs/archy
pnpm add @lunjs/archy
yarn add @lunjs/archy
bun add @lunjs/archy
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2021-11-16 |
| First published | 2020-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14 |
| Dependencies | 0 |
| Unpacked size | 8.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | jKey Lu |
| Maintainers | jkeylu |
| Keywords | hierarchy, npm ls, unicode, pretty, print, tree, ascii |

## Links

- npm: https://www.npmjs.com/package/@lunjs/archy
- Repository: https://github.com/lunjs/archy
- Homepage: https://github.com/lunjs/archy#readme
- Issues: https://github.com/lunjs/archy/issues
- npm.io page: https://npm.io/package/@lunjs/archy

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2021-11-16
- 0.0.3 — 2020-08-19
- 0.0.2 — 2020-07-26
- 0.0.1 — 2020-07-26

## README

# @lunjs/archy

## Installation

```
npm install @lunjs/archy
```

## Usage

```
const archy = require('@lunjs/archy');
const s = archy.draw({
  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!
```

## Options

| Key | Value |
| -- | -- |
| style | default is `'NPM'`, support `'NPM'` or `'FMW'` |
| label | default is `'label'`, support function |
| nodes | default is `'nodes'`, support function |
| unicode | default is `true` |
| drawRootBranch | default is `false` |
| prefix | default is `''` |
| concurrency | default is `Infinity`, only for `drawAsync` |

## Inspired by

- [node-archy](https://github.com/substack/node-archy)

## License

- [lunjs/archy - MIT](LICENSE)
- [substack/node-archy - MIT](https://github.com/substack/node-archy/blob/master/LICENSE)

---
_Source: https://npm.io/package/@lunjs/archy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._