Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rulyotano/tree-extended

NodeJs make a raw text tree representation of a directory's content. It is highly customizable: max-deep, filters by deep level, different charsets...
https://github.com/rulyotano/tree-extended

ascii deep directory directory-map directory-tree map nodejs tree

Last synced: 1 day ago
JSON representation

NodeJs make a raw text tree representation of a directory's content. It is highly customizable: max-deep, filters by deep level, different charsets...

Host: GitHub
URL: https://github.com/rulyotano/tree-extended
Owner: rulyotano
License: mit
Created: 2018-02-02T18:24:39.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-08-30T13:22:17.000Z (5 months ago)
Last Synced: 2025-01-11T15:50:00.206Z (7 days ago)
Topics: ascii, deep, directory, directory-map, directory-tree, map, nodejs, tree
Language: TypeScript
Homepage: https://www.npmjs.com/package/tree-extended
Size: 1.08 MB
Stars: 42
Watchers: 4
Forks: 10
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Tree Extended

NodeJs make a raw text tree representation of a directory's content. Accept several options

## Requires

NodeJs >= 6.x

## Install

Install as a node's package.

`npm install tree-extended -g`

Then, it is just running `tree-extended` in any directory.

## Collaborate

You can contribuite by forking the project on [GitHub](https://github.com/rulyotano/tree-extended).

## Doc

Run `tree-extended -h` for view the help.

```
"tree-extended" is a function for making a directory tree in a text format. You can configure if you want print ascii characters or not. Also has a deep parameter.

'tree-extended "Path for making the tree" [-argument1[="valArg1"]] [-argument2[="valArg2"]] [-argument3[="valArg3"]]...[-argument[="valArgn"]]'

arguments:
(-?, -h, -help): Prints this help
(-max=max_level): The max deep level
(-max-show-not-empty): If -max is set and -max-show-not-empty is set, show '...' string when level prune.
(-[c|charset]=ascii|utf8|utf8-icons): Show an specific charset (default: utf8).
(-gitignore): Ignore the .git/ folder and the content inside .gitignore file.
(-ignore="[level1:]folder/file name1, [level2:]folder/file name2, ..."): Ignores folders or files in an optional tree level.
(-only="[level1:]folder/file name1, [level2:]folder/file name2, ..."): Filter and only show that folders or files in an optional tree level.
```

## Screenshot

![Screenshot](https://raw.githubusercontent.com/rulyotano/tree-extended/master/image.png)

## Samples
### Basic

Command: `tree-extended`

Directory Tree:

```
├───a/
│ ├───aa/
│ ├───ab/
│ └───ac/
├───a1/
├───b/
│ ├───ba/
│ │ ├───bafile1.txt
│ │ └───bafile2.txt
│ ├───bb/
│ ├───bc/
│ │ └───bca/
│ │ └───bca-file1.txt
│ ├───bd/
│ └───bfile1.txt
├───c/
├───c1/
└───d/
├───d1/
└───d2/
```

### Max Level

Command: `tree-extended -max=2`

Directory Tree:

```
├───a/
│ ├───aa/
│ ├───ab/
│ └───ac/
├───a1/
├───b/
│ ├───ba/
│ ├───bb/
│ ├───bc/
│ ├───bd/
│ └───bfile1.txt
├───c/
├───c1/
└───d/
├───d1/
└───d2/
```

### Max Level and Show not empty

Command: `tree-extended -max=1 -max-show-not-empty`

Directory Tree:

```
├───a/
│ └───...
├───a1/
├───b/
│ └───...
├───c/
├───c1/
└───d/
└───...
```

### Custom Charset(s)

#### With Ascii charset

Command: `tree-extended -max=2 -c=ascii`

Directory Tree:

```
+---a/
| +---aa/
| +---ab/
| \---ac/
+---a1/
+---b/
| +---ba/
| +---bb/
| +---bc/
| +---bd/
| \---bfile1.txt
+---c/
+---c1/
\---d/
+---d1/
\---d2/
```

#### With Utf8 Icons charset

Command: `tree-extended -max=2 -charset=utf8-icons`

Directory Tree:

```
├───📁 a/
│ ├───📁 aa/
│ └───📁 ab/
├───📁 a1/
├───📁 b/
│ ├───📁 bb/
│ ├───📁 bd/
│ └───📄 bfile1.txt
└───📁 d/
└───📁 d1/
```

### Ignores

Command: `tree-extended -ignore="1:ba, 2:bafile1, c"`

Directory Tree:

```
├───a/
│ ├───aa/
│ └───ab/
├───a1/
├───b/
│ ├───bb/
│ ├───bd/
│ └───bfile1.txt
└───d/
├───d1/
└───d2/
```

### Only

Command: `tree-extended -only="0:b, 1:bc, 2:bca"`

Directory Tree:

```
├───b/
│ └───bc/
│ └───bca/
│ └───bca-file1.txt
└───ba/
```

In this example you can see you can restrict to only one path (or many). But here we can see that like the restriction is `0:b` (in the level `0` restric to `b`) also `ba/` is included. For avoiding this, we can use regular expressions in the patterns.

Command: `tree-extended -only="0:b$, 1:bc, 2:bca"`

Directory Tree:

```
└───b/
└───bc/
└───bca/
└───bca-file1.txt
```