一、简介
Treer是一个命令行工具,用于生成目录结构树。
二、安装
$ npm install treer -g
三、用法
1. treer -h
打印帮助信息
$ treer -h
Usage: treer [options]
Options:
-V, --version output the version number
-d, --directory [dir] Please specify a directory to generate structure tree (default: "/Users/guopanpan/aidy/RuoYi-Vue3")
-i, --ignore [ig] You can ignore specific directory name
-e, --export [epath] export into file
-h, --help output usage information
2. treer -V
打印treer版本号
$ treer -V
1.0.4
3. treer -d
指定一个目录来生成结构树,如果不指定目录,则会将当前目录作为指定目录
$ treer -d ./RuoYi-Vue
RuoYi-Vue3
├─.DS_Store
├─.env.development
├─.env.production
├─.env.staging
├─README.md
├─index.html
├─package.json
├─vite.config.js
├─yarn-error.log
├─yarn.lock
├─vite
| ├─plugins
| | ├─auto-import.js
| | ├─compression.js
| | ├─index.js
| | ├─setup-extend.js
| | └svg-icon.js
├─src
| ├─App.vue
| ├─main.js
| ├─permission.js
| ├─settings.js
4. treer -i
忽略特定的目录名称,它也支持 rege 正则
// 忽略多个目录
treer -i "/node_modules|.git|.idea/"
// 忽略单个目录
treer -i node_modules
5. treer -e
导出到的指定文件,可以配合-d、-i一起使用
treer -e treer.md -i node_modules
The result has been saved into treer.md // 表示保存成功