golang/go

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

Open

#60,898 创建于 2023年6月20日

在 GitHub 查看
 (1 评论) (1 反应) (1 负责人)Go (19,008 fork)batch import
DocumentationNeedsInvestigationhelp wantedmodules

仓库指标

Star
 (133,883 star)
PR 合并指标
 (30 天内没有已合并 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
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Go
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70