golang/go

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

Open

#60,898 opened on 2023年6月20日

GitHub で見る
 (1 comment) (1 reaction) (1 assignee)Go (19,008 forks)batch import
DocumentationNeedsInvestigationhelp wantedmodules

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

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

コントリビューターガイド

調査方針
この問題は、解析されたmodfile（`modfile`パッケージから）において、どのフィールドがnilになり得るかについてのドキュメントを要求しています。具体的には、`modfile.File.Module`がnilになる可能性があり、`Module.Syntax`については曖昧さがあります。ドキュメントは既存の`modfile`パッケージのドキュメントに追加する必要があり、おそらく`src/cmd/go/internal/modfile/`ディレクトリ内の`.go`ファイルに追加されます。目標は、現在の実装とgoplsでの使用法に基づいて、すべてのフィールドのnil安全性を明確にすることです。
技術スタック
go
領域
developer experiencetooling
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Go
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70