swiftlang/swift

We should have a tool that finds unused diagnostic IDs

Open

#67.306 geöffnet am 14. Juli 2023

Auf GitHub ansehen
 (8 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Swift (10.719 Forks)batch import
QoIcompilerdevelopment toolsfeaturegood first issueutils

Repository-Metriken

Stars
 (69.989 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T 17h) (510 gemergte PRs in 30 T)

Beschreibung

While working on #67075, I found several stale diagnostics that are declared in Diagnostics*.def files, but are never used anywhere in the compiler. I deleted most of the ones I found, but I’m sure there are many more.

We should have a tool that scans lib/ and include/ for uses of diagnostic IDs and flags any that are never actually used. This could perhaps be a test that would fail if there are unused diagnostics.

This might be a good first issue for a new contributor who has reasonably strong Python or Swift skills but doesn’t have any experience with compilers yet.

Contributor Guide

Research-Richtung
Schreibe ein Skript (Python oder Swift), das 'Diagnostics*.def' Dateien nach deklarierten Diagnose IDs durchsucht und dann 'lib/' und 'include/' nach Verweisen auf diese IDs scannt. Gib ungenutzte IDs aus. Erwäge, dies als Test hinzuzufügen.
Tech Stack
swiftpython
Domain
compilerstooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonSwift
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80