Cursor重构函数提示词：生成可发布版本的完整指南

想用Cursor把一个还在调试中的“毛坯”函数，改造成能直接发布到npm给团队甚至社区使用的“精装”版本？核心不止是跑通逻辑——类型安全、错误处理边界、结构化日志埋点、自包含文档注释，每一项都得做到位。

说白了，就是让AI明确你的输出标准，再让它按这套标准一步步重构代码。

整个流程拆解为三个动作，每个动作都要配上清晰的指令约束。

第一步：定死重构目标与硬性约束

提示词开头就得把角色和输出边界划清楚。直接告诉AI：“你是一名资深TypeScript后端工程师，负责将内部实验性函数升级为可发布到npm的公共工具函数。仅输出最终可运行的TS文件内容，不解释、不加说明文字。”

这一步是为了锁死输出格式，避免AI抛出一大堆解释或半成品。紧接着列出不可退让的红线：【必须使用ES2020语法，不可含top-level await；所有参数必须标注类型，返回值必须为Promise或T；函数顶部必须有JSDoc注释，包含@param、@returns、@throws；禁止使用console.log，改用logger.info()和logger.error()】

这几条约束直指生产级代码的核心指标：版本兼容性、类型安全、文档自描述、日志规范化。

第二步：给原始函数并指定重构维度

直接把待重构的函数代码贴进去。然后从三个维度下发指令，每个维度都是“代码成熟度”的关键动作。

第一维：提取该函数所有隐式依赖。像那些没声明就用的全局变量、外部常量、未导入的工具函数，让AI列出所有需要补全的import清单。这一步彻底干掉“幽灵依赖”，让函数能独立发布。

第二维：为每个参数追加运行时校验逻辑。对null、undefined、空字符串等非法输入，抛出带code字段的Error实例，code格式统一为“VALIDATION_XXX”。用代码表明态度：这个函数不接受糊涂输入。

第三维：在函数入口和出口插入结构化日志调用。日志内容必须包括函数名、入参摘要（只记关键信息，别把整个对象倒进去）以及执行耗时（单位毫秒）。这一步让函数变成可观测的，出问题能从日志里直接定位。

第三步：强制生成配套资产

重构完函数本体还不够，为了让它在npm上站住脚，必须附带两个“资产”：单元测试和README。

方式一：附加生成单元测试。直接对AI说：“基于此函数，生成一个Vitest测试文件，覆盖以下场景：① 正常输入返回预期结果；② 缺失必填参数触发VALIDATION_MISSING_FIELD；③ 输入超长字符串触发VALIDATION_STRING_TOO_LONG；④ 异步操作被reject时捕获并透传error.code。”

这样测试不只验证功能逻辑，还覆盖了你刚设好的校验边界和错误类型。测试即文档，同时也是保护网。

方式二：同步产出README片段。在提示词最后另起一行：“生成一段Markdown格式的README说明，包含函数用途、调用示例（含TS类型标注）、错误码列表（code+含义）、兼容性说明（Node.js ≥18.17）。”

这个README不必罗列所有细节，但要确保使用者一眼看懂函数是干嘛的、怎么用、会出什么错、需要什么环境。公共工具函数就该这样。

来源：互联网