Giter Club home page Giter Club logo

nodetree's Introduction

nodetree

list contents of directories in a tree-like format similar to the Tree Command.

SYNOPSIS

nodetree [-ad] [-L <level>] [--noreport] [--version] [--help] [--prune] [<directory> ...]

DESCRIPTION

Nodetree is a recursive directory listing program that produces a depth indented listing of files. With no arguments, nodetree lists the files in the current directory. When directory arguments are given, nodetree lists all the files and/or directories found in the given directories each in turn. Upon completion of listing all files/directories found, nodetree returns the total number of files and/or directories listed. Nodetree is heavily inspired by the Tree Command.

INSTALL

$ npm install --save nodetree

NODE

With defaults:

var nodetree = require('nodetree');
nodetree(process.cwd());

With all options set:

var nodetree = require('nodetree');
nodetree(process.cwd(), {
  all: false,
  directories: false,
  level: 2,
  prune: false,
  noreport: false
});

CLI

$ npm install -g nodetree
$ man nodetree

OPTIONS

Nodetree understands the following command line switches:

NODE OPTIONS

nodetree(basepath, options)

options.all

Type: Boolean
Default: false
See cli option -a below.

options.directories

Type: Boolean
Default: false
See cli option -d below.

options.level

Type: int
Default: null
See cli option -L below.

options.prune

Type: Boolean
Default: false
See cli option --prune below.

options.noreport

Type: Boolean
Default: false
See cli option --noreport below.

CLI OPTIONS

  • -a: All files are printed. By default tree does not print hidden files (those beginning with a dot '.'). In no event does tree print the file system constructs '.' (current directory) and '..' (previous directory).

  • -d: List directories only.

  • -L : Max display depth of the directory tree.

  • --prune: Makes tree prune empty directories from the output.

  • --noreport: Omits printing of the file and directory report at the end of the tree listing.

  • --version: Outputs the version of nodetree.

NEED HELP?

Feel free to read the Contributing Guide or the Changelog if you have any questions.

AUTHOR

Written by Larry Gordon

COPYRIGHT

The MIT License (MIT)

nodetree's People

Contributors

psyrendust avatar

Stargazers

Andy avatar  avatar JowayYoung avatar Carden avatar jinweitang avatar  avatar nil.ni avatar Matt Murahashi Kenichi avatar

Watchers

James Cloos avatar  avatar

nodetree's Issues

Implement `--matchdirs` flag from tree

--matchdirs
        If a match pattern is specified by the -P option, this will cause the pattern to be applied to directory names (in  addition  to  filenames).   In  the
        event  of a match on the directory name, matching is disabled for the directory's contents. If the --prune option is used, empty folders that match the
        pattern will not be pruned.

Fix man page

nodetree -h outputs man nodetree to stdout without showing the man page.

Environment

OS X 10.13.4
zsh 5.4.2 (x86_64-apple-darwin16.7.0)
GNU bash, version 4.4.12(1)-release (x86_64-apple-darwin16.3.0)
nodetree 0.0.3

Implement `-P` flag from tree

-P pattern
        List  only  those  files that match the wild-card pattern.  Note: you must use the -a option to also consider those files beginning with a dot `.'  for
        matching.  Valid wildcard operators are `*' (any zero or more characters), `?' (any single character), `[...]' (any  single  character  listed  between
        brackets  (optional  - (dash) for character range may be used: ex: [A-Z]), and `[^...]' (any single character not listed in brackets) and `|' separates
        alternate patterns.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.