# tree-from-paths
> Convert a list of paths into a archy directory-tree
Latest version **1.1.0** (published 2018-01-14) · MIT license · 0 weekly downloads
## Install
```sh
npm install tree-from-paths
pnpm add tree-from-paths
yarn add tree-from-paths
bun add tree-from-paths
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-01-14 |
| First published | 2017-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nils Knappmeier |
| Maintainers | knappi |
## Links
- npm: https://www.npmjs.com/package/tree-from-paths
- Repository: https://github.com/nknapp/tree-from-paths
- Issues: https://github.com/nknapp/tree-from-paths/issues
- npm.io page: https://npm.io/package/tree-from-paths
## Dependencies (2)
- [archy](https://npm.io/package/archy.md) ^1.0.0
- [lodash.groupby](https://npm.io/package/lodash.groupby.md) ^4.6.0
## Recent versions
- 1.1.0 (latest) — 2018-01-14
- 1.0.0 — 2017-05-21
## README
# tree-from-paths
[](https://npmjs.com/package/tree-from-paths)
[](https://travis-ci.org/nknapp/tree-from-paths)
[](https://coveralls.io/r/nknapp/tree-from-paths)
> Convert a list of paths into a archy directory-tree
# Installation
```
npm install tree-from-paths
```
# Usage
The following example demonstrates how to use this module:
```js
var {render} = require('tree-from-paths')
console.log(render(
[
'basedir/dir1/file1.txt',
'basedir/dir1/file2.txt',
'basedir/dir2/file3.txt',
'basedir/dir3/',
'basedir/dir3/file4.txt',
'basedir/dir3/file5.txt',
'basedir/dir4/dir5/file7.txt'
],
'basedir',
(parent, file, explicit) => {
return `${file}${explicit ? '(*)' : ''}`
}
))
const files = [
{
path: 'basedir/dir1/file1.txt',
created: true
},
{
path: 'basedir/dir1/file2.txt'
},
{
path: 'basedir/dir2/file3.txt'
},
{
path: 'basedir/dir3/'
},
{
path: 'basedir/dir3/file4.txt',
created: true
},
{
path: 'basedir/dir3/file5.txt'
},
{
path: 'basedir/dir4/dir5/file7.txt'
}
]
console.log(
render(files.map(x => x.path), 'basedir', (parent, file, explicit, index) => {
const createdStr = (index >= 0 && files[index].created) ? ' created' : ''
return `${file}${createdStr}`
})
)
```
This will generate the following output
```
/
├─┬ dir1/
│ ├── file1.txt(*)
│ └── file2.txt(*)
├─┬ dir2/
│ └── file3.txt(*)
├─┬ dir3/(*)
│ ├── file4.txt(*)
│ └── file5.txt(*)
└─┬ dir4/dir5/
└── file7.txt(*)
/
├─┬ dir1/
│ ├── file1.txt created
│ └── file2.txt
├─┬ dir2/
│ └── file3.txt
├─┬ dir3/
│ ├── file4.txt created
│ └── file5.txt
└─┬ dir4/dir5/
└── file7.txt
```
# License
`tree-from-paths` is published under the MIT-license.
See [LICENSE.md](LICENSE.md) for details.
# Release-Notes
For release notes, see [CHANGELOG.md](CHANGELOG.md)
# Contributing guidelines
See [CONTRIBUTING.md](CONTRIBUTING.md).
---
_Source: https://npm.io/package/tree-from-paths · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._