swiftlang/swift

We should have a tool that finds unused diagnostic IDs

Open

#67,306 opened on Jul 14, 2023

View on GitHub
 (8 comments) (0 reactions) (1 assignee)Swift (10,719 forks)batch import
QoIcompilerdevelopment toolsfeaturegood first issueutils

Repository metrics

Stars
 (69,989 stars)
PR merge metrics
 (Avg merge 8d 17h) (510 merged PRs in 30d)

Description

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 direction
Write a script (Python or Swift) that parses 'Diagnostics*.def' files for declared diagnostic IDs, then scans 'lib/' and 'include/' for references to those IDs. Output unused IDs. Consider adding as a test.
Tech stack
swiftpython
Domain
compilerstooling
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.
Half day
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
PythonSwift
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80