# @ngsctt/arborist

> A Node.js file tree builder

Latest version **0.2.1** (published 2020-01-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ngsctt/arborist
pnpm add @ngsctt/arborist
yarn add @ngsctt/arborist
bun add @ngsctt/arborist
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2020-01-02 |
| First published | 2019-12-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 0 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Nathan Scott |
| Maintainers | ngsctt |

## Links

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

## Recent versions

- 0.2.1 (latest) — 2020-01-02
- 0.2.0 — 2020-01-02
- 0.1.2 — 2019-12-18
- 0.1.1 — 2019-12-16
- 0.1.0 — 2019-12-16

## README

# arborist
## What
A Node.js directory tree builder

## Why
I initially tried using [directory-tree][], but found it wasn't flexible enough

## How
### Installation
```
npm i @ngsctt/arborist
```

### Usage
```js
const arborist = require('@ngsctt/arborist');

const rootDir = 'directory';      // relative to __dirname
const options = {
  stats: ["birthtime", "mtime"],  // lstatSync properties to include
  path: ["dir", "base", "name"],  // Node path properties to include
  exclude: ["^.DS_Store", "^_"]   // globs to exclude
}
const maxDepth = 10;              // maximum depth of tree

const tree = arborist(rootDir, options, maxDepth)
```

## Licence
This project is released under the [MIT Licence](/LICENSE).



[directory-tree]: https://www.npmjs.com/package/directory-tree

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