跳到正文
  1. How-to
  2. 在真实项目里
  3. 加一个新功能,不碰坏旧的

加一个新功能,不碰坏旧的

一句话说清楚要加什么、哪些旧行为不能变,再让它把新旧两种情况都验证一遍。

一个小功能一到两次对话适用:要给已经在用的项目加功能,又怕弄坏原来好好的东西完整教程第 5 步:设计、动手、收拾干净

先照抄一个

最短的写法
/pstack:poteto-mode 给这个命令加一个 --json 参数。原来的文本输出要和现在逐字一样。两种输出都要验证。

这句话三部分:

  1. 要什么:加一个 --json 参数。
  2. 不能变的:原来的文本输出。它会拿改前改后的输出直接比,有一点不同就算失败。
  3. 两种都验证:防止它只测新的 JSON,忘了旧的文本。

加功能难在别弄坏旧的。新功能能用,旧的输出却悄悄变了一点。把不能变的写进提示词,它就会把这一条当成要检查的项。

Chrome 插件的例子

你想在选项页加一个设置:打开侧边栏时默认显示哪个分组。以前没有这个设置,侧边栏总是显示「全部」。

Chrome 插件的例子
/pstack:poteto-mode 在选项页加一个设置:打开侧边栏时默认显示哪个分组。
写代码之前,先告诉我这个设置在 chrome.storage.sync 里存成什么样。
不许变的:没设置过的用户,侧边栏还是和现在一样显示「全部」;已有的其他设置读出来不变。
验证两种情况:一个从没设置过的新 profile,一个设置成「工作」分组的 profile。
给我看两种情况下 chrome.storage.sync 里的实际内容,和侧边栏打开时的截图。
  • 先说存成什么样:动手前你就能发现问题。比如它想新开一个存储键,你想放进已有的设置里。
  • 没设置过的用户不变:老用户升级后什么都没动。这是最容易改坏的情况。
  • 两个 profile:新旧两种情况,各有一个能判断对错的检查。
  • storage 内容加截图:界面看着对不够,还要看真正存下来的值。

发出去以后看哪里

开头:它的复述,和数据存成什么样。 它会先读懂要改的代码,再说打算怎么存。不对就马上打断。

最后:两种情况的证据。 两份 storage 内容和截图。验证不了的,它会写「inconclusive」(说不准),不会算通过。

想先看设计再动手

改动跨好几个文件时,它会自己调 /pstack:architect 做设计。默认设计完就直接开写。想先看一眼,就发这句:

先停下来给我看设计
/pstack:architect with checkpoint. 设计完先停下来给我看,我同意了再动手。

让它能自己点开你的插件

要在界面上验证,它得会启动你的项目。它总说没法验证界面的话,先跑一次 /pstack:create-verification-skill。它会生成一个项目专用的验证技能,详见完整教程第 6 步。

卡住了?

它把旧的输出格式也顺手改了。

回它:「原来的文本输出不许变。把改前改后的输出 diff 给我看,必须为空。」下次在第一句里就写上不能变的东西。

它只验证了新功能,没验证旧的。

补一句:「apply prove it works. 两种情况都跑一遍真命令,把输出贴给我。」prove it works 的意思是拿真实结果证明它能用。这是 pstack 认识的一条原则名,原样打出来它就懂。它会给你真实输出,不只说「编译通过」。

很小的功能,它也要走设计那一套吗?

不一定。只改一个文件时,用不上的步骤会在待办清单里标成 n/a 或 skip,后面写着理由。觉得理由不对,直接说。

它多做了我没要的功能。

回它:「只做我说的这一个设置。其他想法列出来给我,不要实现。」多出来的想法应该写在回复里,不该写进代码。

本站是 pstack 的非官方入门教程,不是官方文档;pstack 由 poteto 开发,命令和行为以官方仓库为准。教程原始源码见 GitHub。

由 airali部署,基于小小东的 MIT 授权教程改编。