用途:这是 gh-aw 项目的错误消息风格指南,用于统一验证类错误的写法,让用户能快速定位并修复配置问题。
主要能力:给出错误消息模板「[what's wrong]. [what's expected]. [example of correct usage]」,要求每条消息回答三个问题:哪里错了、期望什么格式或取值、如何修复。提倡建设性措辞,避免单独使用 invalid、cannot、must、failed 等否定词,应搭配期望行为与具体修复方式。
使用方式:在 *_validation.go 逻辑中使用 NewValidationError(field, value, reason, suggestion),field 填准确配置路径,reason 说明失败原因,suggestion 给出可操作修复与示例;在传播底层错误并附加上下文时使用 fmt.Errorf 与 %w。建议文本需说明改什么、附最小可用 YAML/代码示例,歧义处用 ✓/✗ 标记。YAML 示例保持最小且合法,使用真实 frontmatter 字段名,仅在 YAML 要求时加引号,缩进用 2 空格。动态内容用 %s、%d、%T、%v、%w 等类型动词。
适用场景:格式/语法错误、枚举或选项字段、类型不匹配、复杂配置等应始终附示例;包装错误、上下文已自明或指向具体文档时可省略示例。改进现有消息时按识别错误、分析上下文、套用模板、补测试、更新注释的流程进行。
限制:资料未提供该技能的具体安装命令、运行方式、收费与平台信息;内容为写作规范,不涉及可执行功能。