Khan/genqlient

Redo error-formatting utilities to be a bit more idiomatic

Open

#118 geöffnet am 28. Sept. 2021

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Go (141 Forks)github user discovery
good first issuehelp wantedinternal

Repository-Metriken

Stars
 (1.310 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

We have our own errorf (in generate/errors.go) so that we can do structured errors with positions. But our errorf is a bit un-idiomatic (which caused confusion in #117) -- it just wraps the first error argument it finds rather than using %w -- and it also doesn't actually format wrapped errors in a very good way (e.g. here). We could probably do better, either having our wrapper do an ordinary fmt.Errorf (by formatting the position at call-time), or by making it a bit more idiomatic and using its extra structure to hoist the position to the outermost error.

Contributor Guide

Research-Richtung
Erkunden Sie die beiden vorgeschlagenen Ansätze: (1) Formatieren Sie die Position zum Zeitpunkt des Aufrufs mit fmt.Errorf, oder (2) lassen Sie errorf %w verwenden und die Position zum äußersten Fehler heben. Sehen Sie sich die aktuelle Verwendung von errorf in generate/errors.go an und wie Fehler an anderen Stellen verwendet werden.
Tech Stack
go
Domain
backend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GoGo error handling
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75