当前位置:

首页 > 编程开发 > Sublime一键生成代码结构目录树,写文档和README的装X利器

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

SublimeText通过自定义构建系统调用tree命令实现一键生成目录树,适用于README文档,不识别语言符号或Markdown锚点。需在项目根目录下安装tree并配置构建系统,Windows推荐GitforWindows。结构树需手动更新,CI中可加时间戳注释。

本文目录
    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。

    • 推荐方案:安装 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 文档生成,建议配合脚本自动追加生成时间注释。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    Sublime Text3插件问题解决
    Sublime Text3插件问题解决

    手动安装PackageControl后,SublimeText3可能出现无法安装包、菜单消失或快捷键失效,需进入用户偏好设置,将“ignored_packages”中移除PackageControl,即可正常扩展编辑器功能。

    Sublime Text 4持续优化多选区与语法支持,回应现代代码编辑需求
    Sublime Text 4持续优化多选区与语法支持,回应现代代码编辑需求

    SublimeText4Build4200稳定版正式发布,重点优化多选区编辑性能,大幅提升响应速度;重写SQL、Bash等语法高亮,增强代码识别;新增Zsh与TOML原生支持,扩展语言覆盖;提升Git查询及命令行执行效率,延续轻量高效、高度可配置的编辑器定位。

    Sublime Text推进插件生态调整,旧Python宿主淘汰进入明确时间表
    Sublime Text推进插件生态调整,旧Python宿主淘汰进入明确时间表

    SublimeText编辑器从Build4200版本开始,将分阶段淘汰基于Python3.3的插件宿主,首先逐步过渡到Python3.8,最终目标锁定为Python3.14。与此同时,Windows和macOS的最低操作系统要求分别提升至Windows10和macOS10.13。对于插件开发者而言,需要特别关注API兼容性问题,而普通用户则几乎不会受到任何影

    Sublime Text开发版Build 4205上线,插件运行环境升级至Python 3.14
    Sublime Text开发版Build 4205上线,插件运行环境升级至Python 3.14

    SublimeText开发版Build4205于2026年4月23日正式发布,仅面向已购买许可证的用户。内置Python版本已升级至3.14,新增了open_terminal终端命令、ScopeSelector中的>运算符,并对撤销与重做历史进行了调整与优化。此外,Windows系统最低要求提升至10,macOS系统最低要求提升至10.13。

    如何用CSS修改不同input标签的样式
    如何用CSS修改不同input标签的样式

    使用CSS属性选择器`input[type=""]`可精确修改特定类型input的样式,如文本输入框、提交按钮等,避免影响其他元素。该方法也适用于其他属性值,实现精准定位和样式调整,提升代码可维护性与选择器效率。

    Sublime快速查找未关闭的括号_Sublime代码纠错实用插件
    Sublime快速查找未关闭的括号_Sublime代码纠错实用插件

    BracketHighlighter插件通过PackageControl安装并重启后生效,实时高亮匹配的括号、标签和引号,不匹配时显示红色边框及“[unmatched]”提示。该插件不自动补全或修改代码,高亮样式依赖主题配色方案。支持圆括号、方括号、花括号和尖括号等多种类型,提升代码可读性。

    Sublime配置Lua游戏开发环境_Sublime编写Lua脚本高亮设置
    Sublime配置Lua游戏开发环境_Sublime编写Lua脚本高亮设置

    SublimeText默认不识别.lua语法高亮,需手动将语言切换为Lua语言。构建系统需要设置working_dir为$file_path,否则Love2D将无法正常加载项目文件。Windows系统下运行可用cmd/c加pause防闪退。使用Love2D开发游戏需确保项目根目录包含main.lua、路径全英文,且Sublime没有内置调试器。

    Sublime怎么实现光标位置历史回退_Sublime快速回到上一次编辑点
    Sublime怎么实现光标位置历史回退_Sublime快速回到上一次编辑点

    SublimeText的跳转堆栈仅记录主动跳转操作(例如F12键、Ctrl键加点击),并不记录编辑行为。Ctrl加U键所回退的是跳转位置而非编辑点,该堆栈最多十六条且重启后即清空。因此,用户定位修改点需要借助GitGutter插件、书签或Git命令。

    Sublime如何关闭文件预览功能?Sublime点击文件不自动打开设置
    Sublime如何关闭文件预览功能?Sublime点击文件不自动打开设置

    关闭Sublime的单击预览文件功能,需要修改用户配置文件,将“preview_on_click”参数的值设为false(布尔类型),且要遵循JSON格式。如果安装了SideBarEnhancements拓展插件,还需将“enable_click_to_open”参数同样设为false。另外,对于项目侧栏和搜索结果中的文件预览,也可分别独立设置。

    Sublime如何实现正则表达式提取 Sublime筛选特定字符技巧【实操】
    Sublime如何实现正则表达式提取 Sublime筛选特定字符技巧【实操】

    SublimeText通过正则捕获组实现关键词提取,需使用非贪婪量词和边界锚定确保匹配精准。ReplaceinFiles不支持$1引用,批量提取应使用FindinFiles复制结果。后续需手动去重、分行或转数组,注意作用域和编码问题。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。