writing-hashql-diagnostics

Use the hashql-diagnostics crate to generate structured diagnostics with consistent formatting, severity levels, and message style. The crate enforces lowercase messages, backtick code references, imperative tone, and avoids apologetic language across errors, warnings, and notes.

Actionable diagnostics combine a clear Label describing what went wrong, an appropriate Severity level, and a Suggestion or Patch showing the fix. The hashql-diagnostics crate ensures diagnostics follow this structure so users understand the problem and how to resolve it.

Yes. The Diagnostic builder supports adding both suggestions and patches. Patches provide concrete code changes users can apply, while suggestions offer guidance. This makes diagnostics more helpful for users fixing HashQL code.

Follow the hashql-diagnostics testing and review guidelines to validate that diagnostics meet style requirements: lowercase messages, proper code references, imperative language, and structured use of labels, severity levels, and patches for consistency.

The crate provides multiple severity levels—Error, Warning, and Note—allowing you to classify diagnostics by importance. Each level helps users prioritize which issues to address first in their HashQL code.