mrraindrop / tree-cli Goto Github PK

View Code? Open in Web Editor NEW

247.0 5.0 24.0 468 KB

🌴List contents of directories in tree-like format.

License: MIT License

JavaScript 100.00%

treelist tree-cli cli-tree tree tree-cmd file-structure

tree-cli's Introduction

tree-cli

List contents of directories in tree-like format.

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

example

cmd:

tree -l 2 -o output.txt

result:

/Applications/XAMPP/htdocs/node_playground/tree-cli
├── README.md
├── bin
|  └── tree
├── node_modules
|  ├── bluebird
|  ├── chalk
|  ├── cli-spinner
|  ├── meow
|  └── object-assign
├── package.json
└── tree.js

directory: 7 file: 4

install

npm install -g tree-cli

usage

Use the command `tree` or `treee` (to avoid confliction with system command).

NOTE: use treee instead of tree on windows system.

tree/treee

Use it as a node module to get the detailed tree data.

require('tree-cli')({
  base: '.',    // or any path you want to inspect.
  noreport: true
}).then(res => {
  // res.data is the data for the file tree.
  // res.report is the stringified scanning report.
  console.log(res.data, res.report);
});

You can find the type declaration for the exporting function and the type declaration of its' params and result in the 'types/index.d.ts' file. If you are using VSCode, you'll find the type hint during your typing.

Breaking change: In version before 0.6.0, the resovled result is the tree structure of the scanned directory. But in latest v0.6.0, the resolved result is changed to a object contains both the file tree structure and the scanned report. The structure of result would be:

{
  data: {
    // ...The file node tree.
  },
  report: '...',  // The final report.
}

use --help to list help info.

tree --help

specify the level of path (how deep to scan).

use -l levelNumber to specify the path level.

tree -l 2

output result to a file

use -o outputFilePath to specify the output file.

tree -l 2 -o out.txt

show directory only

use -d to show directories only.

tree -l 2 -o out.txt -d

other arguments

see Options.

FOR WINDOWS USERS

you should just use the treee command as tree has been already taken by windows system.

treee -l 2 -o out.txt -d

Options

--help: outputs a verbose usage listing.
--version: outputs the version of tree-cli.
--debug: show debug info.
--fullpath: prints the full path prefix for each file.
--ignore: ignores directory or file you specify - accepts arrays as comma-delimited strings: 'node_modules/, .git/, .gitignore'
--link: follows symbolic links if they point to directories, as if they were directories. Symbolic links that will result in recursion are avoided when detected.
--noreport: omits printing of the file and directory report at the end of the tree listing and omits printing the tree on console.
--base: specify a root directory. Relative path from cwd root and absolute path are both acceptable. This argument is optional.
-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.
-f: append a '/' for directories, a '=' for socket files and a '|' for FIFOs.
-i: makes tree not print the indentation lines, useful when used in conjunction with the -f option.
-l: max display depth of the directory tree.
-o: send output to filename.

tree-cli's People

Contributors

Stargazers

Watchers

tree-cli's Issues

Stringify output

Hello! Can you consider exporting the stringify function, or have some other wayto obtain the stringified output without having to shell out? e.g. accepting a buffer or stream to write into.

I am using this as a library (i.e. require-ing it) and am mainly interested in getting the string output, not the data structure itself.

--ignore does not work with nested folders

ignore command treee -l 10 --ignore "venv , app\tmp\__pycache__" not working , prints out everything. the folder structure works when only treee -l 10 --ignore venv is given.

Not showing all files

on test-windows part in https://github.com/bnoordhuis/v8-cmake/pull/18/checks?check_run_id=598611704, it not showing all files like \build\Debug\d8.exe

constantly crashing on exception

This module is not working as supposed to, it crash and exit node application due to the error:
TypeError: Cannot read properties of undefined (reading 'sort')

tree.js:315:27

if (_flags.directoryFirst) {
          parent.children.sort(_comparePriority);
        }

the callback onError does nothing when exception occurred but instead it crash my application:

onError({path,err}){
       
}

tree-cli TODO

TODO:

bugfix
make it require-able
more command arguments for linux tree command
test cases

Suppress `console.log`

Can we have a way to suppress the console.log() output? As mentioned in #15, I am using this as a library to get the output.

Prebuilt binaries?

If someone wants to install tree-cli, they have to install npm, even if they have no need for that, besides installing tree-cli.

Would it be possible to provide prebuilt binaries?

Incorrect output with `--ignore`

When the last entry of the listing is filtered with --ignore , the actual non-filtered last output is displayed with ├── instead of └─

Folder First then Files

Is there any way to make sure that the folders are first in the output and files second?

"Too many parameters" error on Windows

It doesn't seem to accept parameters when running on Windows:

> tree -L 2 -o out.txt
Too many parameters - 2

> tree -o tree.txt
Too many parameters - tree.txt

How to list ALL

It looks like you must specify the folder depth, any way to list all sub directories?

'ignore' parameter to not list directories/files that match name

Feature request:

--ignore 'file.txt, node_modules' - Useful for filtering out files that are insignificant to some project structures.

```tree -l 2 -o out.txt -d``` throws error on Windows 7

error message is this: tree -l 2 -o out.txt -d

Debug log is printed by default

When I tree ./build, I get my log prepended by this:

[log] flags { debug: false,
  base: '.',
  indent: 2,
  fullpath: false,
  link: false,
  noreport: false,
  l: 1,
  o: 'tree_out',
  f: false }
[log] result:

I'd expect that not to be there when I'm not passing any debug flags.
My version of tree is 0.4.6, node version is 6.7.0.

The directory named "module" is missing

source directory structure

...
|-- build
|  |-- main
|  |-- module
...

tree-cli result

tree -l 2 -o tree.txt --ignore 'node_modules,coverage'

build/module directory is missing from the results.

Don't create the output file by default

I just want to see my folder structure in the console, and there is no option to disable the output file.

feature_request(option): Markdown output

1. Summary

It would be nice, if would be possible print output to Markdown format.

2. Example data

Simple tree structure:

KiraTreeCLI/
├── KiraDirectory/
│   └── KiraSecondFile.txt
└── KiraFirstFile.txt

3. Expected result

# KiraTreeCLI

1. KiraFirstFile.txt

## KiraDirectory

1. KiraSecondFile.txt

4. Argumentation

I want to publish my big list of books, so that it can be conveniently referenced. For example, that would be possible show my Astronomy books to other users, I could share link https://kristinita.netlify.app/Special/Полная-библиография#Астрономия; Physics books — https://kristinita.netlify.app/Special/Полная-библиография#Физика and so on.

Yes, I know regular expressions. But currently, I have tree → Markdown conversion difficulties, because I can’t do, that files would be higher than directories in output (KiraFirstFile.txt than KiraDirectory/).

5. Examples of expected behavior

5.1. Markdown format

It would be very nice, if tree-node-cli can print output in Markdown format directly. For example, if I will run command:

tree --markdown

I will get the expected result from section «Expected result»:

# KiraTreeCLI

1. KiraFirstFile.txt

## KiraDirectory

1. KiraSecondFile.txt

5.2. dirs-end

If you are for any reason will not do conversion to Markdown, it would be nice to have at least --dirs-end option. Files in this case will always be located above the directories.

Command:

tree --dirs-end

Result:

KiraTreeCLI/
├── KiraFirstFile.txt
└── KiraDirectory/
    └── KiraSecondFile.txt

6. Not helped

I couldn’t find in Internet third-party tools for conversion filesystem tree structure to Markdown format.

7. Do not offer

I don’t need to convert filesystem tree structure to Markdown list; please, do not offer it. I need, that directories and subdirectories would be converted to Markdown headers; please, read section «Argumentation».

Thanks.

Available to be used as npm module

Are there any plans to make this available to use as a require-able node module? I'm looking for something similar to this for one of my projects and it'd be pretty awesome to be able to use in another node script :)