Check cfg to catch feature typos
#12091
Labels
A-Build-System
Related to build systems or continuous integration
C-Code-Quality
A section of code that is hard to understand or change
D-Trivial
Nice and easy! A great choice to get started with Bevy
Comments
BD103
added
D-Trivial
alice-i-cecile
added
the
A-Build-System
|
We can actually add this to CI: we run some checks on nightly already :) |
|
I'm working on removing the warnings and adding the check to the CI. I'll make a pr in a bit once it is ready! |
github-merge-queue bot
pushed a commit
that referenced
this issue
Feb 25, 2024
# Objective - Add the new `-Zcheck-cfg` checks to catch more warnings - Fixes #12091 ## Solution - Create a new `cfg-check` to the CI that runs `cargo check -Zcheck-cfg --workspace` using cargo nightly (and fails if there are warnings) - Fix all warnings generated by the new check --- ## Changelog - Remove all redundant imports - Fix cfg wasm32 targets - Add 3 dead code exceptions (should StandardColor be unused?) - Convert ios_simulator to a feature (I'm not sure if this is the right way to do it, but the check complained before) ## Migration Guide No breaking changes --------- Co-authored-by: Alice Cecile <[email protected]>
msvbg
pushed a commit
to msvbg/bevy
that referenced
this issue
Feb 26, 2024
# Objective - Add the new `-Zcheck-cfg` checks to catch more warnings - Fixes bevyengine#12091 ## Solution - Create a new `cfg-check` to the CI that runs `cargo check -Zcheck-cfg --workspace` using cargo nightly (and fails if there are warnings) - Fix all warnings generated by the new check --- ## Changelog - Remove all redundant imports - Fix cfg wasm32 targets - Add 3 dead code exceptions (should StandardColor be unused?) - Convert ios_simulator to a feature (I'm not sure if this is the right way to do it, but the check complained before) ## Migration Guide No breaking changes --------- Co-authored-by: Alice Cecile <[email protected]>
msvbg
pushed a commit
to msvbg/bevy
that referenced
this issue
Feb 26, 2024
# Objective - Add the new `-Zcheck-cfg` checks to catch more warnings - Fixes bevyengine#12091 ## Solution - Create a new `cfg-check` to the CI that runs `cargo check -Zcheck-cfg --workspace` using cargo nightly (and fails if there are warnings) - Fix all warnings generated by the new check --- ## Changelog - Remove all redundant imports - Fix cfg wasm32 targets - Add 3 dead code exceptions (should StandardColor be unused?) - Convert ios_simulator to a feature (I'm not sure if this is the right way to do it, but the check complained before) ## Migration Guide No breaking changes --------- Co-authored-by: Alice Cecile <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Nightly Rust has added support for
-Zcheck-cfg, which will show a warning if there is a#[cfg(...)for a nonexistant feature / cfg.While not possible to add this to CI because it is currently nightly-only, it can be run locally to catch all current typos.
Please read this comment on how to use
-Zcheck-cfg. Once you follow the setup, run:I found a few warnings related to missing features, but I currently don't have the time to work on it today.
The text was updated successfully, but these errors were encountered: