VSCode插件打造极简风格的项目目录

浅杰酱_8221

浅杰酱_8221

2026-08-15

859人浏览

原创

directory-tree 更轻量、更可控,默认忽略常见噪音文件且支持精准配置排除项,生成结果可直接嵌入 markdown 代码块,需通过“open folder”打开项目根目录才能正确运行。

vscode插件打造极简风格的项目目录

VS Code 插件选哪个:file-tree-generator 还是 directory-tree?

直接说结论:directory-tree 更轻量、更可控,file-tree-generator 功能多但容易导出冗余内容(比如隐藏文件、node_modules 全展开)。如果你只要一份干净、可读、能直接贴进 README 或文档的结构,优先装 directory-tree。

它默认忽略 .git、node_modules、.DS_Store 等常见噪音,且支持通过配置项 "directoryTree.exclude" 手动追加排除项。而 file-tree-generator 的排除逻辑较弱,常需手动删减输出。

  • 安装后无需重启 VS Code,按 Ctrl + Shift + P 输入 Directory Tree: Generate 即可触发
  • 默认写入当前项目根目录下的 README.md 底部;若无该文件,会自动创建
  • 生成结果用 ?/? 图标区分目录与文件,视觉上比纯 ASCII 树更易扫读

如何避免生成时把 .vscode、.gitignore 之类全列出来?

不是所有“存在”的文件都该出现在结构图里——尤其当你要发给协作方或写进技术文档时,这些配置文件反而干扰主线。关键在插件配置。

directory-tree 支持在工作区设置中添加以下 JSON 片段(打开 .vscode/settings.json 编辑):

{
  "directoryTree.exclude": [
    ".vscode",
    ".git",
    ".gitignore",
    "package-lock.json",
    "yarn.lock",
    "tsconfig.*.json"
  ]
}

注意:exclude 是 glob 模式,不支持正则;路径名必须精确匹配(如 "*.lock" 不生效,得写成 "package-lock.json" 和 "yarn.lock" 两条)。

  • 排除项只对当前工作区生效,不影响其他项目
  • 如果某项目需要保留 .env.example,就别把它加进 exclude 列表
  • 修改配置后需重新运行命令,已生成的内容不会自动刷新

生成的目录结构怎么嵌入 Markdown 文档才不乱?

直接粘贴到 README.md 里,最容易踩的坑是缩进错位导致渲染失败——尤其是用空格缩进时,VS Code 默认可能用 2 空格,而 GitHub 渲染器对缩进敏感。

VSCode
VSCode

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

下载

安全做法是:确保整个树形结构用 4 个空格缩进(或统一用 Tab),且每行开头无多余空格。更稳妥的是把生成块包裹在代码块里:

```text
src/
├─ assets/
│  └─ logo.svg
├─ components/
│  └─ Button.vue
└─ main.ts
```

这样既能保真格式,又避免被 Markdown 解析器误处理。

  • 别用 ```markdown 包裹——树形符号(├─、└─)不是合法 Markdown 语法,会出错
  • 如果要用 GitHub 原生 TOC 跳转,得手动把每个文件/目录转成链接,插件不自动做这事
  • 导出后建议用预览模式(Ctrl + Shift + V)检查是否对齐,不对就调一下编辑器的“indentation”设置

为什么有时候生成结果为空或只有一行?

常见原因就两个:directory-tree 没识别到当前是项目根目录,或者工作区打开方式不对。

它依赖 VS Code 的“打开文件夹”行为判断根路径。如果你只是用“File → Open File…” 打开单个 package.json,插件会认为当前没有项目结构,输出就只有那个文件本身。

  • 务必通过 File → Open Folder… 打开整个项目根目录(含 package.json 或 tsconfig.json 的那一层)
  • 确认左下角状态栏显示的是文件夹名,而不是“No folder opened”
  • 如果项目用了多根工作区(workspace),插件默认只处理第一个根,其余需手动切换活动文件夹再运行

极简风格的核心不在图标多好看,而在信息密度和意图清晰——删掉什么,比加上什么更难决定。每次生成前,先想清楚:这份结构图到底给谁看?他们最需要一眼抓住哪几层?这才是“极简”的真正门槛。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1255

18

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

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

2023.07.21

2612

3

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

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

2024.03.14

1889

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

2587

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

1242

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

454

5

热门下载

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

精品课程

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