Treer：生成目录结构树

最新推荐文章于 2024-04-29 21:20:26 发布

soul g

最新推荐文章于 2024-04-29 21:20:26 发布

阅读量1.7k

点赞数 1

文章标签： npm vue.js javascript

本文链接：https://blog.csdn.net/Y2ANGAO/article/details/125322836

版权

Treer：生成目录结构树

1 简介

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

2 安装

注意：Treer 的安装需要用到 Node，node 安装请移步node.js 安装教程 (Windows zip 版)

打开终端输入如下命令：

npm install treer -g
// 或者
npm i treer -g

3 用法

3.1 treer -h

作用：打印帮助信息。
语法：

treer -help
// 或者
treer -h

基本使用：

PS C:\Users\86175> treer -help
Usage: index [options]

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

3.2 treer -V

作用：输出版本号。
语法：

treer -V

基本使用：

PS C:\Users\86175> treer -V
1.0.4

3.3 treer -d

作用：指定一个目录来生成结构树。
语法：

treer -d 指定目录
// 如果不指定目录，则会将当前目录作为指定目录

基本使用：

注意：从这里到文章结束都会用一个初始化的 vue-cli 项目来演示。基本目录如下图：

在这里插入图片描述

PS C:\Users\86175\Desktop> treer -d vue
├─.gitignore
├─babel.config.js
├─package-lock.json
├─package.json
├─README.md
├─src
|  ├─App.vue
|  ├─main.js
|  ├─components
|  |     └HelloWorld.vue
|  ├─assets
|  |   └logo.png
├─public
|   ├─favicon.ico
|   └index.html
├─node_modules	// 该目录文件过多，不做展示
├─.git				// 该目录文件过多，不做展示

3.4 treer -i

作用：忽略特定的目录名称，它也支持 rege 正则。
语法：

treer -i 忽略的目录名称

基本使用：

// 1. 忽略单个目录
S C:\Users\86175\Desktop> treer -d vue -i node_modules
vue
├─.gitignore
├─babel.config.js
├─package-lock.json
├─package.json
├─README.md
├─src
|  ├─App.vue
|  ├─main.js
|  ├─components
|  |     └HelloWorld.vue
|  ├─assets
|  |   └logo.png
├─public
|   ├─favicon.ico
|   └index.html
├─.git	// 该目录文件过多，不做展示

// 2. 通过正则忽略多个目录
PS C:\Users\86175\Desktop> treer -d vue -i "/node_modules|.git/"
vue
├─babel.config.js
├─package-lock.json
├─package.json
├─README.md
├─src
|  ├─App.vue
|  ├─main.js
|  ├─components
|  |     └HelloWorld.vue
|  ├─assets
|  |   └logo.png
├─public
|   ├─favicon.ico
|   └index.html

3.5 treer -e

作用：导出到的指定文件。
语法：

treer -e 指定文件

基本使用：

// 可以配合 -d 和 -i 一起使用。
// 需求：生成 vue 文件夹目录结构树并忽略 node_modules 和 .git，最后将生成的目录结构树导入到 tree.md 文件中。
// 实现：
PS C:\Users\86175\Desktop> treer -d vue -e treer.md -i "/node_modules|.git/"
vue
├─babel.config.js
├─package-lock.json
├─package.json
├─README.md
├─src
|  ├─App.vue
|  ├─main.js
|  ├─components
|  |     └HelloWorld.vue
|  ├─assets
|  |   └logo.png
├─public
|   ├─favicon.ico
|   └index.html


The result has been saved into treer.md // 表示保存成功