CtrlK
BlogDocsLog inGet started
Tessl Logo

diagnostics-development

Guide for creating high-quality, user-friendly diagnostics in Biome. Use when creating diagnostics for lint rules, adding helpful advice to error messages, implementing code frame displays, or improving diagnostic quality.

68

Quality

82%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

65%Weight 40%Scale 1-3

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A code-rich, highly actionable reference for Biome diagnostics that mostly respects Claude's competence, but it is monolithic, repeats some material across the manual-advice and RuleDiagnostic sections, and lacks explicit validation checkpoints in its workflow.

Suggestions

Add an explicit verification step to the workflow, e.g. after registering a category and wiring the diagnostic, run `cargo test` or `biome check` on a sample to confirm it renders.

Collapse the overlap between 'Implement Advices' (custom advice type) and 'Add Diagnostic to Rule' (RuleDiagnostic builder) by leading with the RuleDiagnostic pattern most rules actually use and demoting the manual approach.

Split the type/API reference and the good/bad message gallery into a reference file under references/ so SKILL.md stays a lean overview, improving progressive disclosure.

DimensionReasoningScore

Conciseness

The body is code-forward and assumes Biome/Rust knowledge without explaining basics, but the manual-advice-types section overlaps with the later 'RuleDiagnostic builder pattern' note, and the 'Common Patterns' section reiterates patterns already shown above, so it could be tightened.

2 / 3

Actionability

It provides fully executable Rust across derive macros, Advices impls, RuleDiagnostic::new().note(), markup! usage, and define_categories! registration, with real type names and field annotations that are copy-paste ready.

3 / 3

Workflow Clarity

The 'Common Workflows' section sequences diagnostic creation steps clearly, but there are no explicit validation or verification checkpoints (e.g., running cargo test or biome check to confirm the diagnostic renders), leaving feedback loops implicit.

2 / 3

Progressive Disclosure

No bundle files exist; the ~375-line SKILL.md is monolithic with clear headers and a one-level external References list, but content that could be split (type reference, good/bad message gallery) is inline rather than progressively disclosed into reference files.

2 / 3

Total

9

/

12

Passed

Description

100%Weight 40%Scale 1-3

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong, well-scoped description that concretely states capabilities, includes explicit 'Use when' triggers, and is tightly bound to the Biome diagnostics niche. No significant weaknesses to address.

DimensionReasoningScore

Specificity

The description names the Biome diagnostics domain and lists multiple concrete actions: 'creating diagnostics for lint rules, adding helpful advice to error messages, implementing code frame displays, or improving diagnostic quality'.

3 / 3

Completeness

It clearly answers both 'what' ('Guide for creating high-quality, user-friendly diagnostics in Biome') and 'when' via an explicit 'Use when...' clause enumerating trigger scenarios.

3 / 3

Trigger Term Quality

It uses natural terms a Biome contributor would say ('diagnostics', 'lint rules', 'error messages', 'code frame displays') with good coverage and natural phrasing.

3 / 3

Distinctiveness Conflict Risk

Scoped specifically to Biome diagnostics with distinct triggers tied to lint rules, advice, and code frames, making it unlikely to conflict with unrelated skills.

3 / 3

Total

12

/

12

Passed

Validation

100%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
biomejs/biome
Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.