唯品秀前端博客
当前位置: 前端开发 > Node+Koa >

Node.js通过tree-cli插件快速生成项目结构README.md项目目录描述

作者：管理员 2022-04-02 19:54:03 分类：Node+Koa 阅读（2039） 0

以树状格式列出目录的结构和内容。Tree-cli 是一个递归目录结构的程序，可生成深度缩进的文件列表。没有指定参数时参数，tree 会列出当前目录中的文件。给定目录参数后，可以依次列出在给定目录中找到的所有文件和/或目录，并可以输出为指定文件。

演示

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/Users/lijun/Documents/个人项目/Art_Blog/src
├── css
├── font
|  └── 阿里图标库本地备份
├── images
|  └── smilies
|     ├── paopao
|     └── qq
├── include
|  ├── css
|  └── js
├── js
|  ├── video
|  └── xfg_banner
├── layer
|  ├── mobile
|  |  └── need
|  └── theme
|     └── default
└── music

directory: 19

安装 tree cli

1
npm install -g tree-cli

查看帮助

  • 可以通过该命令查看插件的详细信息
    • 1
    tree --help
  • 指定目录层级（深度）：
    • 1
    tree -l 2
  • 将结果输出到文件：
    • 1
    tree -l 2 -o out.txt
  • 只输出目录：
    • 1
    tree -l 2 -o out.txt -d
  • 这里要注意一下：为避免与系统目录冲突，在 Windows 环境下，需要将 tree 替换成 treee：
    • 1
    treee -l 2 -o out.md

    更多可选参数：

    1. --help：输出详细的用法列表。
    2. --version：输出tree-cli的版本。
    3. --debug：显示调试信息。
    4. --fullpath：打印每个文件的完整路径前缀。
    5. --ignore：忽略您指定的目录或文件-接受以逗号分隔的字符串作为数组： 'node_modules/, .git/, .gitignore'
    6. --link：如果符号链接指向目录，则遵循符号链接，就好像它们是目录一样。在检测到时将避免会导致递归的符号链接。
    7. --noreport：省略在树列表末尾打印文件和目录报告，并省略在控制台上打印树。
    8. --base：指定根目录。来自cwd根的相对路径和绝对路径均可接受。此参数是可选的。
    9. -a：打印所有文件。默认情况下，tree不打印隐藏文件（以点“。”开头的文件）。树决不会打印文件系统构造“。”。（当前目录）和“ ..”（上一个目录）。
    10. -d：仅列出目录。
    11. -f：在目录后附加“ /”，在套接字文件后附加“ =”和“ |” 用于FIFO。
    12. -i：使树不打印缩进线，与-f选项一起使用时很有用。
    13. -l：目录树的最大显示深度。
    14. -o：将输出发送到文件名

    结语

    除了上述方案外，还可以通过mddir给README.md自述文件快速生成项目目录结构

    本站所有文章、图片、资源等如无特殊说明或标注，均为来自互联网或者站长原创，版权归原作者所有；仅作为个人学习、研究以及欣赏！如若本站内容侵犯了原著者的合法权益，可联系我们进行处理，邮箱：343049466@qq.com
    赞(1) 打赏
    标签：

    上一篇：

    下一篇：

    相关推荐

    共 0 条评论关于"Node.js通过tree-cli插件快速生成项目结构README.md项目目录描述"

    表情

    最新评论

      暂无留言哦~~
    谢谢你请我吃鸡腿*^_^*

    支付宝扫一扫打赏

    微信扫一扫打赏