etcd-io/etcd

Enable `unexported-return` linter rule

Open

#18,370 建立於 2024年7月26日

在 GitHub 查看
 (23 留言) (0 反應) (2 負責人)Go (51,701 star) (10,352 fork)batch import
area/testinghelp wantedpriority/important-longtermtype/cleanup

描述

What would you like to be added?

There are two remaining linter rules that we haven't enabled but are left as TODO (./tools/.golangci.yaml): exported and unexported-return. The former will have significant changes to exported functions and interfaces. The latter, even though it impacts exported structs, it's for the better (it exposes them without breaking client implementations).

I suggest breaking the pull requests into small tasks like we did on #17578.

The following modules have warnings to be addressed:

  • api - #18645
  • pkg
  • client/pkg
  • client/v3
  • server - #19052
  • tests
    • #19105

Refer to the attached log file with the result from KEEP_GOING_MODULE=true make verify-lint.

Why is this needed?

To improve the quality of the code.

貢獻者指南

技術棧
go
領域
backenddeveloper experiencetooling
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
over 1 week
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Go programming basicsFamiliarity with static analysis toolsUnderstanding of exported vs unexported in Go
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
10
研究方向
The issue is a meta issue to enable the `unexported return` linter rule across multiple modules in etcd. To contribute, pick a module with pending work (e.g., pkg, client/pkg, client/v3) and run `KEEP GOING MODULE=true make verify lint` to generate warnings. Fix each warning by ensuring that exported functions that return unexported types either export the type or refactor the function. Refer to the attached log file and the pattern set by previous PRs like #18645 and #19052.