如何一键生成项目树形结构
# 1. 背景
我们在进行自己开发项目的介绍时,经常需要跟别人介绍我们自己项目的结构,这时候很多人可能会通过截图项目的工程,比如:
说明: 上述通过截图的方式,看起来不直观,而且显得不专业。
# 2. 使用 tree
优雅一键生成项目树形结构
这里,我们建议通过第三方的工具 tree
,进行优雅的一键生成树形目录结构。
命令如下:
tree -d -L 1
可以快速的展示出当前项目的主要目录如下:
.
├── admin
├── data-simulator
├── dynamic-rule-engine
└── ip-profile
下面分别简单介绍下每个目录。
- admin : 反爬虫项目的后台管理模块,用于后台业务逻辑处理以及前台效果展示。
- **data-simulator : ** 数据仿真模块,用于线下模拟数据。
- **dynamic-rule-engine : ** 动态规则引擎,flink 在线实时计算数据。
- ** ip-profile : ** ip 画像,提供 ip 的画像,并且动态规则引擎的数据可能会写入 ip 画像的库中。
# 3. mac 安装 tree
教程
teee
是一种递归目录结构列表命令,产生一个深度缩进列表文件。
具体步骤入下:
- 下载安装
tree
的包 地址:http://mama.indstate.edu/users/ice/tree/ - 解压 tree-${版本号}.tgz 文件
tar -zxvf tree-${版本号}.tgz
- 进入解压后的目录中,并用ls查看
cd tree-${版本号}
ls
可以查看到有一个 Makefile文件
- 修改
tree
的配置文件 Makefile。将其中55行左右的注释去掉,如下图:
# Uncomment for OS X:
# It is not allowed to install to /usr/bin on OS X any longer (SIP):
prefix = /usr/local
CC=cc
CFLAGS=-O2 -Wall -fomit-frame-pointer -no-cpp-precomp
LDFLAGS=
MANDIR=/usr/share/man/man1
OBJS+=strverscmp.o
- 修改完成后,执行命令:
make
- 使用管理员身份,执行如下命令:
sudo cp tree /usr/local/bin
- 测试
tree
是否安装成功
tree --version
# 4. tree
使用教程
格式: tree + 参数
-a 显示所有文件和目录。
-A 使用ASNI绘图字符显示树状图而非以ASCII字符组合。
-C 在文件和目录清单加上色彩,便于区分各种类型。
-d 显示目录名称而非内容。
-D 列出文件或目录的更改时间。
-f 在每个文件或目录之前,显示完整的相对路径名称。
-F 在执行文件,目录,Socket,符号连接,管道名称名称,各自加上"*","/","=","@","|"号。
-g 列出文件或目录的所属群组名称,没有对应的名称时,则显示群组识别码。
-i 不以阶梯状列出文件或目录名称。
-I 不显示符合范本样式的文件或目录名称。
-l 如遇到性质为符号连接的目录,直接列出该连接所指向的原始目录。
-n 不在文件和目录清单加上色彩。
-N 直接列出文件和目录名称,包括控制字符。
-p 列出权限标示。
-P 只显示符合范本样式的文件或目录名称。
-q 用"?"号取代控制字符,列出文件和目录名称。
-s 列出文件或目录大小。
-t 用文件和目录的更改时间排序。
-u 列出文件或目录的拥有者名称,没有对应的名称时,则显示用户识别码。
-x 将范围局限在现行的文件系统中,若指定目录下的某些子目录,其存放于另一个文件系统上,则将该子目录予以排除在寻找范围外。
上次更新: 2022/12/07, 14:49:16