讲师中心 微信公众号
AI工具推荐 视频效率加速

Sublime一键生成代码结构目录树,写文档和README的装X利器

胖磊吖_1035

胖磊吖_1035

发布时间:2026-06-29 13:52:42

|

723人浏览过

|

来源于php中文网

原创

Sublime Text 无原生一键生成目录树功能,需通过自定义构建系统调用系统 tree 命令实现;适用于 README 文档,不支持语言符号识别或 Markdown 锚点;推荐 macOS/Linux 下用 brew/apt 安装 tree 并配置 Tree.sublime-build,注意 $file_path 指当前文件所在目录,需在项目根目录下打开文件后按 Ctrl-B/Cmd-B 运行;Windows 建议安装 Git for Windows 获取完整 tree;插件易受 files.exclude 干扰且对 symlink/monorepo 支持差,tree 输出更可靠;结构树需随项目更新手动重生成,CI 中可加时间戳注释。

sublime一键生成代码结构目录树,写文档和readme的装x利器

Sublime Text 本身不提供“一键生成代码结构目录树”的原生功能,所谓“一键”,本质是调用系统 tree 命令 + 自定义构建系统实现的快捷封装。它适合写文档、README 或架构说明,但别指望它能自动识别语言符号或生成 Markdown 锚点目录——那是另一类插件干的事。

用 tree 构建系统导出项目结构(macOS/Linux 推荐)

这是最轻量、最可控的方式:不装插件、不卡顿、输出干净,直接贴进 README 就能用。

  • 先确认已安装:tree — macOS 用 brew install tree,Linux 一般自带或运行 sudo apt install tree
  • 菜单 → Tools → Build System → New Build System…,粘贴以下内容并保存为 Tree.sublime-build:
{
  "cmd": ["tree", "-I", "node_modules|.git|.DS_Store|__pycache__|dist|build", "-L", "4", "$file_path"],
  "working_dir": "$file_path",
  "target": "exec"
}
  • -I 后填要排除的目录,用竖线 | 分隔,不支持正则
  • -L 4 控制层级深度,避免输出爆炸;--dirsfirst 可加在 cmd 数组里让目录排前面
  • 关键点:$file_path 指的是当前打开文件所在目录,不是项目根目录——所以必须先在项目根目录下的某个文件中打开 Sublime(比如 package.json 或 README.md),再按 Cmd+B(macOS)或 Ctrl+B(Windows/Linux)

Windows 下跑 tree 的实际门槛

Win10 1809+ 系统自带 tree,但默认只输出 ASCII 树形,不带 /F 参数时不会列出文件名;旧系统常报 'tree' is not recognized。

Sublime Text Build Linux版
Sublime Text Build Linux版

Sublime Text Linux x86-64 deb 安装包。官方也提供 rpm、tar.xz 和软件源安装方式。

下载
  • 推荐方案:安装 Git for Windows(含完整 tree),或用 Chocolatey 运行 choco install tree
  • 替代命令(无需额外安装):cmd /c "tree /F /A",但不支持 -I 排除,得靠 PowerShell 脚本后处理
  • PowerShell 中可用 Get-ChildItem -Recurse | Group-Object PSParentPath 模拟,但格式松散、难读,不如直接上 tree
  • 别信“右键资源管理器 → 在此处打开终端”就万事大吉——VSCode/Sublime 都可能没继承正确的 PATH,建议在终端里先手动执行 tree --version 确认可用

为什么别依赖插件生成结构树?

像 Project Tree Generator 这类插件看似点一下就出结果,实际在复杂项目里容易翻车。

  • 它们默认遵循 VSCode/Sublime 的 files.exclude 配置,但这个配置本意是控制“是否显示”,不是定义“项目结构”——你隐藏了 dist/,不代表它不该出现在部署文档里
  • 遇到符号链接(symlink)、pnpm workspace、Lerna monorepo 时,插件常漏目录或错乱缩进,而 tree -L 3 输出可作为黄金标准人工比对
  • 生成的 Markdown 格式常把 index.js 自动转成 [index.js](./index.js),粘到飞书/Notion 里反而多出跳转,纯文本结构更安全
  • 真正需要“代码大纲”(函数/类列表)请用 CTags + Ctrl+T,和“文件目录树”是两回事,混用只会增加调试成本

真正容易被忽略的点是:结构树不是一次性的。项目新增模块、删掉测试目录后,记得重新运行构建系统——别让 README 里的树形结构和真实磁盘对不上。另外,tree 输出不含时间戳或哈希,如果用于 CI 文档生成,建议配合脚本自动追加生成时间注释。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

相关专题

更多
Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

80

2026.09.23

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

40

2026.09.23

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

20

2026.09.23

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

20

2026.09.22

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

40

2026.09.22

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

40

2026.09.22

loomy官网入口地址合集
loomy官网入口地址合集

本专题汇总了 Loomy 桌面 AI 助理的官方入口地址合集及使用指南。提供 macOS 与 Windows 客户端下载 。Loomy 是讯飞推出的桌面级 AI 工作搭子,支持文件整理、数据分析、网页操作及通过飞书/钉钉远程操控电脑,助你高效完成本地办公任务 。

40

2026.09.22

NumPy常见函数使用方法
NumPy常见函数使用方法

本专题整理 NumPy 常见函数使用方法相关教程,覆盖函数大全、参数用法、数组运算、统计聚合、排序处理、where 条件筛选、linspace 创建数列等常用场景,帮助读者快速掌握 NumPy 函数调用思路和实际数据处理技巧。

60

2026.09.22

NumPy性能优化版本更新与常见报错排查
NumPy性能优化版本更新与常见报错排查

本专题整理 NumPy 性能优化、版本更新与常见报错排查相关教程,覆盖向量化计算、广播性能、内存布局、NumPy 2.0 升级、版本兼容冲突、安装导入报错、dtype 溢出、矩阵运算异常和 broadcasting 报错修复,帮助读者系统掌握 NumPy 性能调优与问题定位方法。

80

2026.09.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn