kubernetes-sigs/cluster-api

Lint unused funcs

Open

#7,599 opened on Nov 23, 2022

View on GitHub
 (12 comments) (0 reactions) (1 assignee)Go (1,532 forks)auto 404
help wantedkind/featurepriority/backlogtriage/accepted

Repository metrics

Stars
 (4,267 stars)
PR merge metrics
 (PR metrics pending)

Description

It would be great if we had a linter which detects unused funcs.

I recently opened a PR to drop some unused code in KCP: https://github.com/kubernetes-sigs/cluster-api/pull/7598

I found the following cases:

  1. funcs which weren't used by anyone: e.g. ControlPlane.MachineInfrastructureTemplateRef
  2. funcs which were only used by test code: e.g. ControlPlane.NewMachine

I think if there is a linter 1. should be relatively easy to detect.

I'm not sure about 2., it could be that there are a lot of false positives as we probably have non-test code which is used as test utils in tests.

But even if we only find a linter for 1. it should be a good improvement

/kind feature

Contributor guide

Research direction
Explore existing Go linters like `unused` or write a custom one to detect unused functions in the codebase, focusing on non test code first.
Tech stack
go
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70