【TraeCode 上手记】我用 TraeCode 从零搭建 TypeScript CLI 工具并发布到 npm

我是一名 Node.js/TypeScript 开发者,平时主要做 CLI 工具和后端 API 开发。最近想做一个批量处理 Markdown 文件并生成目录索引的命令行工具,之前用传统方式从零搭建项目脚手架、配置 tsconfig、设置 ESLint/Prettier 就要花掉半个小时。这次我决定试试看 TraeCode 能不能帮我加速整个流程。

我这次想解决什么

需要一个能递归扫描指定目录下所有 Markdown 文件,解析标题层级,自动生成带锚点链接的目录索引的 CLI 工具。要求支持自定义输出格式(JSON/Markdown/HTML),并且能发布到 npm 供团队使用。

我是谁,为什么这件事对我重要

我有 3 年 Node.js/TS 开发经验,日常维护多个内部 CLI 工具。这类"从零到发布"的小工具我以前通常要花半天时间,如果 TraeCode 能把这个过程压缩到 1-2 小时,对我来说就是一个巨大的效率提升。

我是怎么把 TraeCode 慢慢用顺的

第一步:我直接跟 Agent 说"帮我创建一个 TypeScript CLI 项目,用 commander 做参数解析,支持扫描目录下的 Markdown 文件并生成索引"。Agent 在 30 秒内给出了完整的项目结构规划,包括 package.json、tsconfig.json、src 目录结构。

第二步:我让 Agent 逐个实现核心模块。文件遍历模块用了 fast-glob(比原生 fs.readdir 方便太多),Markdown 解析用了 marked 库,Agent 不仅写了代码,还解释了为什么选 fast-glob 而不是 glob(性能更好,支持异步)。

第三步:遇到一个坑——marked 解析出的标题节点跟我预期的不一样,内部用的是 tokens 数组嵌套结构。我把报错信息贴给 Agent,它马上定位到是我用错了 API(应该用 marked.lexer 而不是 marked.parse),并给出了修正方案。

第四步:发布 npm 时,Agent 帮我检查了 package.json 的必要字段(name、version、main、bin、files),还提醒我加 .npmignore 避免把源码测试文件也发布上去。

我最后做成了什么

从开始到 npm publish 成功,总共花了不到 2 小时。最终产出了一个 200+ 行的 CLI 工具,支持 --dir、–output、–format 三个参数,能输出 JSON/Markdown/HTML 三种格式的索引文件。这个工具现在已经在我们团队的文档项目里用上了。

给后来人的建议

如果你也是做 Node.js/TS 开发的,我的建议是:不要只把 TraeCode 当"代码补全工具"。把它当成一个随时可以讨论技术方案的同事——先跟它聊清楚你要做什么、为什么这样做,然后让它帮你拆任务、写代码、排查问题。另外,遇到报错不要自己闷头查,直接把错误信息贴给它,它定位问题的速度往往比你手动翻文档快得多。

1 个赞