Agent Skills
返回列表
JSON 格式化与校验工具

JSON 格式化与校验工具

开发编程 更新于 2026.08.30

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_15292d5a/yjkj-harrylabsj-json-formatter。

技能介绍

解决什么问题

JSON 日志、接口响应和配置文件经常以紧凑格式出现,肉眼排查时容易漏掉缺失逗号、引号或嵌套错误。手工格式化又会改变团队约定,甚至覆盖原始顺序。这个技能把“是否合法”和“如何排版”拆成两个明确动作,适合脚本和终端里快速处理文本 JSON。

核心工作流

  • 格式化:使用 format 对 JSON 做 pretty-printing,通过 -i 控制缩进空格数,默认 2 个空格;可用 --sort-keys 按字母排序键名。
  • 校验:使用 validate 只检查语法,不产生格式化输出,便于确认 payload 是否能解析。
  • 输入输出:支持读取文件或 stdin,默认输出 stdout;用 -o 或 --output 写入文件。
  • 退出码:0 表示成功,1 表示 JSON 语法无效,2 表示文件不存在或权限错误,3 表示其他错误,方便 CI 或脚本判断。

边界与注意点

它只面向标准 JSON,不适合处理 JSON5、带注释或 JS 表达式。validate 不会改写内容;--sort-keys 可能改变键的展示顺序,若下游依赖原始顺序,应避免使用。文件模式下仍需确保路径可读或目标目录可写。

使用场景

  • 调试接口响应时,把紧凑 JSON 缩进成两空格并输出到文件。
  • 在 CI 脚本里用 validate 检查服务返回的 JSON 语法,依赖退出码 1 失败。
  • 整理配置样例时,用 --sort-keys 统一键顺序,便于 diff 审阅。
  • 从 stdin 读取日志片段,用 format 重排后再传给下游工具。

适合人员

  • 排查 API 返回报文的工程师,需要快速确认 JSON 是否可解析。
  • 维护 CLI 流水线的工程师,需要把 JSON 校验结果映射为退出码。
  • 整理配置文件的工程师,需要按统一缩进和键顺序生成样例。
  • 编写数据工具脚本的工程师,需要从 stdin 消费并重排 JSON。