npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

directree

v1.0.0

Published

Creates tree representation of given folder(s)

Downloads

2

Readme

directree

Build Status Coverage Status

NPM

Creates a tree representation of any directory. Handy if you want to add a tree representation of your project to your documentation.

Installation

Run

npm install directree -g

Usage

directree [options] <path>

It takes the following options:

  • show-files
  • log-level
  • ignore-pattern
  • output

Path

It's the path of the folder you want to show as a tree. It's required.

Example

    directree .

Show Files

Add this flag if you want to show files in the tree.

Example

    directree -f .
    directree --show-files .

Logging level

If there's something going wrong in the drawing, you can go to a deeper level of logging. The default level is 3 (only errors), the deepest and most verbose level of logging is 0.

Example

    directree -l 2 .
    directree --log-level 2 .

Ignore pattern

You can hide some results in the tree by using the ignore-pattern argument. It runs minimatch under the hood, thus it takes a glob as argument.

Example

    directree -i node_modules/**/*.js .
    directree --ignore-pattern node_modules/**/*.js .

Output

If you mind, you can write your output on a file using the output parameters.

Please note: this is an async feature, so keep that in mind in case of programmatic usage!

Example

    directree -f  -o ./tree.txt .
    directree --output ./tree.txt .

Programmatic usage

You can use this utility in your Node.js apps too. You only need to provide the same parameters as before, but in a camelCase way.

Thus the parameters object looks like:

{
    path: {string},
    showFiles: {boolean},
    logLevel: {number},
    ignorePattern: {string},
    output: {string}
}

Example

    const directree = require('directree');

    directree({
        path: './',
        showFiles: true,
        logLevel: 3,
        ignorePattern: 'node_modules',
        output: './tree.txt'
    })

Contributing

Contributors are well welcomed! Please do not skip git hooks when you submit Pull Requests :D