LizardByte / LizardByte/roadmap
cpp: audit include statements
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 2
- Forks
- 0
- Avg merge
- 25m
- Merged PRs (30d)
- 5
Description
### Is there an existing issue for this item?
- [x] I have searched the existing issues
### Repositories
LizardByte/Sunshine, LizardByte/libdisplaydevice, LizardByte/tray
### Languages/Skills/Technologies
C++
### Description
Many includes are shown as not used by CLion. I haven't investigated if these are legitimate warnings, but we should audit the includes and probably automate it as part of CI.
I found the following that might be able to help:
- https://github.com/myint/cppclean
- https://github.com/include-what-you-use/include-what-you-use
https://stackoverflow.com/questions/614794/detecting-superfluous-includes-in-c-c
### Estimated Effort
effort:Large
### Priority
priority:High
### Target Milestone
1-3 months
### Dependencies
_No response_
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing include warnings in the C++ code across LizardByte/Sunshine, LizardByte/libdisplaydevice, and LizardByte/tray. Compare cppclean and include-what-you-use against the CLion findings, then determine the CI scope. Done means the includes have been audited and an agreed automated check is integrated into CI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- ci-cd, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100