Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

pathtree

okunishinishi21MIT2.0.0

Node.js module to print path tree.

tree, inspect

readme

pathtree

Build Status Code Climate Code Coverage npm Version JS Standard

Node.js module to print path tree.

Installation

$ npm install pathtree --save

Usage

'use strict'

const pathtree = require('pathtree')

pathtree('.', {
  ignore: 'node_modules'
}).then(() => {
  /* ... */
})
.
├── foo
│   ├── bar
│   │   ├── baz.txt
│   │   └── quz.txt
│   └── quzz
│        └── quzzz.txt
└── zzz
     └── bar
          ├── baz.txt
          └── quz.txt

Options

Key Default Description
ignore | Name to ignore.

Using with CLI

Install as a global module.

$ npm install pathtree -g

Then,

$ pathtree . -I node_modules

License

This software is released under the MIT License.