README.md 文档使用 treer 生成树形项目结构

使用treer命令忽略特定目录生成项目结构

原创于 2023-07-27 17:10:35 发布 · 1.4k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java

Java 专栏收录该内容

7 篇文章

订阅专栏

文章介绍了在编写前后端项目的README.md时，如何使用treer命令来代替tree，以便更方便地生成项目结构，并能忽略如node_modules、.git等特定目录。通过全局安装treer，使用-e和-i参数来指定输出文件和需要忽略的文件或文件夹的正则表达式列表。

一、前言

前后端编写 README.md 文档的时候，常常需要描写项目的结构，使用 tree 命令生成的目录又不能忽略某个目录，不方便。后来我找到了可以忽略某些目录的 treer命令，特此记录一下:

二、使用 treer 生成项目结构

全局安装tree ,用于生成目录结构

npm install treer -g

查看版本

treer --version

生成项目骨架

treer -d ./ -e treer.md  -i "/node_modules|.git|.idea|dist|.flattened-pom.xml|logs|target|.iml|.java|.xml|.png|.sql|src|.txt|.yml/"

# -e 参数指定了输出文件为 treer.md， -i 参数表示要忽略的文件和文件夹的正则表达式列表。

# -i "/node_modules|.git|.idea|dist|.flattened-pom.xml|logs|target/"，命令会忽略指定文件和文件夹，注意前后的/不能省略