W
writing-hashql-diagnostics
HashQL diagnostic writing patterns using hashql-diagnostics crate. Use when creating error messages, warnings, Labels, Messages, Severity levels, Patches, Suggestions, or improving diagnostic quality in HashQL code.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
HashQL diagnostic writing patterns using hashql-diagnostics crate. Use when creating error messages, warnings, Labels, Messages, Severity levels, Patches, Suggestions, or improving diagnostic quality in HashQL code.
How to use
- Aktywuj umiejętność w Claude'a, gdy pracujesz nad kodem HashQL zawierającym diagnostykę — zwłaszcza gdy tworzysz nowe komunikaty błędów, ostrzeżeń lub poprawiasz istniejące. 2. Zdefiniuj kategorię diagnostyki i wybierz odpowiedni poziom ważności (Bug dla błędów wewnętrznych kompilatora, Fatal dla błędów nieodwracalnych, Error dla błędów użytkownika, Warning dla ostrzeżeń). 3. Napisz główną wiadomość diagnostyki zaczynając od małej litery, używając backticks dla elementów kodu (np.
expected bool, found String) i unikając interpunkcji na końcu, chyba że wiadomość ma wiele zdań. 4. Dodaj etykiety (Label) wskazujące konkretne miejsca w kodzie — każda etykieta powinna wyjaśniać kontekst lub powód błędu. 5. Dołącz komunikaty pomocnicze (Message::help) jako imperatywy — podaj konkretne kroki, które programista powinien podjąć (np. "dodaj adnotacje typów" zamiast "coś poszło nie tak"). 6. Przejrzyj wiadomość pod kątem jasności i konkretności — unikaj przeprosin, niejasnych sformułowań i kapitalizacji na początku, chyba że zaczynasz od identyfikatora kodu.