一、简介

treer 是一个命令行工具，用于生成目录结构树。

二、安装

注意：treer 的安装需要用到 node.js，安装nvm-window(node版本管理工具)的问题

打开终端输入如下命令：

npm install treer -g

三、用法

1. treer -h

打印帮助信息。

treer -h
Usage: index [options]Options:-V, --version          输出版本号-d, --directory [dir]  请指定一个目录来生成结构树 (默认: "当前目录路径")-i, --ignore [ig]      您可以忽略特定的目录名称-e, --export [epath]   导出到文件中-h, --help             输出使用信息

2. treer -V

输出版本号。

treer -V
1.0.4

3. treer -d

指定一个目录来生成结构树，如果不指定目录，则会将当前目录作为指定目录。

treer -d 
D:\private\front\vue-admin-template
├─package-lock.json
├─package.json
├─tests
|   ├─unit
|   |  ├─.eslintrc.js
|   |  ├─utils
|   |  |   ├─formatTime.spec.js
|   |  |   ├─param2Obj.spec.js
|   |  |   ├─parseTime.spec.js
|   |  |   └validate.spec.js
//仅展示部分内容

4. treer -i

忽略特定的目录名称，它也支持 rege 正则。

// 忽略多个目录treer -i "/node_modules|.git|.idea/"// 忽略单个目录treer -i node_modules

5. treer -e

导出到的指定文件，可以配合-d、-i一起使用。

生成 vue 文件夹目录结构树并忽略 node_modules，最后将生成的目录结构树导入到 treer.md 文件中。
treer -d vue -e treer.md -i node_modules
treer -e treer.md -i node_modules    //生产当前目录结构树，忽略 node_modules 并写入到treer.md 文件中。The result has been saved into treer.md // 出现这段，表示保存成功。