golang/go

x/mod/modfile: document which fields in a parsed modfile may be nil

Open

#60.898 aperta il 20 giu 2023

Vedi su GitHub
 (1 commento) (1 reazione) (1 assegnatario)Go (19.008 fork)batch import
DocumentationNeedsInvestigationhelp wantedmodules

Metriche repository

Star
 (133.883 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

We've had several crashes in gopls related to modfile.File.Module being nil.

On the other hand, we have a bunch of code checking if modfile.File.Module.Syntax is nil -- is that possible if modfile.File.Module is non-nil?

It would be nice if the modfile API documented which fields may be nil.

CC @bcmills @adonovan

Guida contributor

Direzione di ricerca
La richiesta del problema è di documentare quali campi in un modfile analizzato (dal pacchetto `modfile`) possono essere nil. Nello specifico, `modfile.File.Module` può essere nil, e c'è ambiguità riguardo a `Module.Syntax`. La documentazione dovrebbe essere aggiunta alla documentazione esistente del pacchetto `modfile`, probabilmente nei file `.go` in `src/cmd/go/internal/modfile/`. L'obiettivo è chiarire la sicurezza nil di tutti i campi, basandosi sull'implementazione corrente e sull'utilizzo in gopls.
Tech stack
go
Dominio
developer experiencetooling
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70