VSCode项目结构树状图导出工具

胖强同学_5531

胖强同学_5531

2026-07-27

836人浏览

原创

tree命令是唯一可信的项目结构导出方式,因其直接读取磁盘、不依赖vscode配置,在pnpm workspace、lerna或符号链接场景下准确可靠;windows 10 1809+自带,macos需brew安装,linux多预装;推荐配合-i和-l参数过滤与限深,并用脚本固化命令以确保一致性。

vscode项目结构树状图导出工具

tree 命令是唯一值得信任的导出方式

插件生成的结构图不可信,尤其在含 pnpm workspace、Lerna 或符号链接的项目中,常漏目录、缩进错乱、把 dist/ 当隐藏文件跳过——因为它们依赖 VSCode 的 files.exclude 配置,而那本不是定义“项目结构”的标准。

tree 直接读磁盘,不经过编辑器抽象层,输出就是真实文件系统快照。Windows 10 1809+ 自带;macOS 需 brew install tree;Linux 多数预装,Debian/Ubuntu 缺失时跑 sudo apt install tree。

  • 执行前务必确认当前终端工作目录是项目根目录:pwd 看一眼,别靠右键“在终端中打开”就默认安全
  • 常用过滤:加 -I "node_modules|.git|.DS_Store" 排除干扰项
  • 限制深度防爆炸:用 tree -L 4 控制最多显示 4 层
  • 输出为纯文本可直接粘贴进 README 或文档,不带 Markdown 链接、无缩进污染

别用插件导出用于 CI 或交接的结构图

像 Project Tree 或 File Tree Generator 这类插件,会在 README.md 里写入带链接的 Markdown 树,但链接指向的是 VSCode 内部 URI(如 file:///.../src/index.ts),粘到飞书、Notion 或 GitHub PR 里就失效;更麻烦的是,它们对 symlink 和 hard link 的处理不一致,导致 workspace 子包路径显示为绝对路径或直接消失。

  • 插件默认不递归扫描未打开的子文件夹,而 tree 无此限制
  • 某些插件会把 .d.ts 文件当“类型声明”忽略,但实际它属于交付产物,该出现在结构图里
  • 如果必须用插件,导出后一定要比对 tree -L 3 输出,逐行核对关键目录是否存在

一键脚本比记参数更可靠

每次敲 tree -I "node_modules|.git" -L 4 > structure.txt 容易漏参数、拼错路径。存个脚本,以后双击或 alias 就行。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

macOS/Linux:gen-tree.sh

#!/bin/bash
tree -I "node_modules|.git|.DS_Store|dist|build" -L 4 -o structure.txt

Windows PowerShell:gen-tree.ps1

tree /F /A /I "node_modules,.git,.DS_Store,dist,build" | Out-File -Encoding UTF8 structure.txt
  • 脚本里硬编码过滤项,避免每次手动输错分隔符(tree 用 |,PowerShell 用 ,)
  • -o 或 Out-File 直接落地为文件,省去复制粘贴环节
  • 加 -L 4 是经验阈值:再深就失去概览意义,反而难读

结构图不是越全越好,而是要匹配用途

给新人看的架构图,重点在顶层模块划分(src/、packages/、scripts/);给 CI 流水线用的结构清单,可能需要包含 dist/ 和 types/——这些不该被默认过滤掉。

  • 别盲目加 -I 把所有“看起来不重要”的目录都扔掉
  • 导出前想清楚:这图谁看?解决什么问题?是否要体现构建产物?
  • 同一项目可维护多个脚本变体,比如 gen-tree-dev.sh(含 node_modules)和 gen-tree-doc.sh(只留业务代码)

真正容易被忽略的,是工作目录和用途匹配——不是工具选错,而是没想清“这个结构图到底要回答什么问题”。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1235

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2532

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1869

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1707

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2567

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1798

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1222

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1096

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

434

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程