kubernetes-sigs/cluster-api

Lint unused funcs

Ouverte

#7 599 ouverte le 23 nov. 2022

Voir sur GitHubGuide contributeur
 (12 commentaires) (0 réaction) (1 personne assignée)Go (1 532 forks)auto 404
help wantedkind/featurepriority/backlogtriage/accepted

Métriques du dépôt

Stars
 (4 267 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Explorez les linters Go existants comme `unused` ou écrivez un linter personnalisé pour détecter les fonctions inutilisées dans la base de code, en vous concentrant d'abord sur le code non test.
Stack technique
go
Domaine
developer experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Go
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70