SuperAPI AI 工具集

writing-hashql-diagnostics

写作与研究

查看项目

更新于 10-15 22:12

技能介绍

用途:本技能提供 HASH 项目专用的诊断信息编写模式,使用 hashql-diagnostics crate 产出可操作、风格一致的错误与警告。

主要能力:支持创建 Diagnostic,设置 Severity(Bug、Fatal、Error、Warning、Note),添加 Label、Message 与 Suggestions/Patch 修复建议,并规定消息风格规范。

必要用法:使用 hashql_diagnostics::{Diagnostic, Label, Message, Severity};典型代码为 let mut diagnostic = Diagnostic::new(category, Severity::Error).primary(Label::new(span, "expected bool, found String")); 随后可 add_label、add_message,并通过 Suggestions::patch 给出修复。

风格要求:消息以小写开头,代码元素用反引号,表述具体可操作,使用 invalid 而非 illegal,help 用祈使句;不要以标点结尾(多句除外),避免致歉措辞、含糊表达与大写开头。

适用场景:编写编译错误、警告、提示与自动修复建议,并需与 HashQL 测试技能配合做 compiletest 覆盖。

限制:资料未提供完整的消息风格指南、span 选择与分类设计细节,亦未说明安装方式与平台要求。