SuperAPI AI 工具集

implement-command

通用与其它

查看项目

更新于 10-16 07:27

技能介绍

用途:在 node-redis 仓库中端到端实现一个新的 Redis 命令或命令变体,适用于 @redis/client 核心命令以及 @redis/json、@redis/search、@redis/bloom、@redis/time-series 等模块包;不涉及 RESP 编解码改动或新客户端传输层。

主要能力与流程:

  1. 先收集输入:向用户索取 redis/redis 的命令 JSON 规范(src/commands/<name>.json)、一个已加载该命令的运行中 Redis 实例、以及首次引入该命令的服务器版本;缺失时需明确标注未验证或省略 @since/minimumDockerVersion。
  2. 编写 packages/<pkg>/lib/commands/<NAME>.ts:文件名用下划线分隔子命令(如 ACL_CAT),模块命令去掉点前缀(ARRAPPEND.ts 对应 JSON.ARRAPPEND)。命令对象用 as const satisfies Command,包含 parseCommand(用 parser.push、pushKey、pushKeys、pushVariadic 等序列化参数)与 transformReply(透传、函数或按 RESP 版本键控的 {2,3})。RESP2 需统一到 RESP3 形状。可选标志有 IS_READ_ONLY、CACHEABLE、NOT_KEYED_COMMAND。
  3. 在 commands/index.ts 注册原始名与 camelCase 别名,每个条目上方必须有 JSDoc(npm run check:command-jsdoc 会校验),补 @param、@since,必要时加 @remarks。
  4. 编写同目录 <NAME>.spec.ts:用 parseArgs 断言线上参数数组,用 testUtils.testAll 覆盖单机与集群,行为测试按引入版本加 minimumDockerVersion 门控。
  5. 重新生成静态命令元数据:npm run generate:metadata --workspace=packages/client -- redis://localhost:6379,须针对加载全部模块的完整服务器运行,并检查 git diff 只含预期改动。

限制:需要 Docker 运行真实 Redis 容器;元数据文件自动生成不可手改;命令对象上的 IS_READ_ONLY/CACHEABLE 会覆盖元数据表,应作为有意修正而非重复声明;未提供规范或实例时只能基于 redis.io 实现并标注未验证。