d70595b667
# Objective - Fixes #6370 - Closes #6581 ## Solution - Added the following lints to the workspace: - `std_instead_of_core` - `std_instead_of_alloc` - `alloc_instead_of_core` - Used `cargo +nightly fmt` with [item level use formatting](https://rust-lang.github.io/rustfmt/?version=v1.6.0&search=#Item%5C%3A) to split all `use` statements into single items. - Used `cargo clippy --workspace --all-targets --all-features --fix --allow-dirty` to _attempt_ to resolve the new linting issues, and intervened where the lint was unable to resolve the issue automatically (usually due to needing an `extern crate alloc;` statement in a crate root). - Manually removed certain uses of `std` where negative feature gating prevented `--all-features` from finding the offending uses. - Used `cargo +nightly fmt` with [crate level use formatting](https://rust-lang.github.io/rustfmt/?version=v1.6.0&search=#Crate%5C%3A) to re-merge all `use` statements matching Bevy's previous styling. - Manually fixed cases where the `fmt` tool could not re-merge `use` statements due to conditional compilation attributes. ## Testing - Ran CI locally ## Migration Guide The MSRV is now 1.81. Please update to this version or higher. ## Notes - This is a _massive_ change to try and push through, which is why I've outlined the semi-automatic steps I used to create this PR, in case this fails and someone else tries again in the future. - Making this change has no impact on user code, but does mean Bevy contributors will be warned to use `core` and `alloc` instead of `std` where possible. - This lint is a critical first step towards investigating `no_std` options for Bevy. --------- Co-authored-by: François Mockers <francois.mockers@vleue.com>
112 lines
3.2 KiB
Rust
112 lines
3.2 KiB
Rust
use core::cmp::Ordering;
|
|
use std::fs::File;
|
|
|
|
use serde::Serialize;
|
|
use tera::{Context, Tera};
|
|
use toml_edit::DocumentMut;
|
|
|
|
use crate::Command;
|
|
|
|
#[derive(Debug, Serialize, PartialEq, Eq)]
|
|
struct Feature {
|
|
name: String,
|
|
description: String,
|
|
is_default: bool,
|
|
}
|
|
|
|
impl Ord for Feature {
|
|
fn cmp(&self, other: &Self) -> Ordering {
|
|
self.name.cmp(&other.name)
|
|
}
|
|
}
|
|
|
|
impl PartialOrd for Feature {
|
|
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
|
|
Some(self.cmp(other))
|
|
}
|
|
}
|
|
|
|
fn parse_features(panic_on_missing: bool) -> Vec<Feature> {
|
|
let manifest_file = std::fs::read_to_string("Cargo.toml").unwrap();
|
|
let manifest = manifest_file.parse::<DocumentMut>().unwrap();
|
|
|
|
let features = manifest["features"].as_table().unwrap();
|
|
let default: Vec<_> = features
|
|
.get("default")
|
|
.unwrap()
|
|
.as_array()
|
|
.unwrap()
|
|
.iter()
|
|
.flat_map(|v| {
|
|
core::iter::once(v.as_str().unwrap().to_string()).chain(
|
|
features
|
|
.get(v.as_str().unwrap())
|
|
.unwrap()
|
|
.as_array()
|
|
.unwrap()
|
|
.iter()
|
|
.map(|v| v.as_str().unwrap().to_string()),
|
|
)
|
|
})
|
|
.collect();
|
|
|
|
features
|
|
.get_values()
|
|
.iter()
|
|
.flat_map(|(key, _)| {
|
|
let key = key[0];
|
|
|
|
if key == "default" {
|
|
None
|
|
} else {
|
|
let name = key
|
|
.as_repr()
|
|
.unwrap()
|
|
.as_raw()
|
|
.as_str()
|
|
.unwrap()
|
|
.to_string();
|
|
if let Some(description) = key.leaf_decor().prefix() {
|
|
let description = description.as_str().unwrap().to_string();
|
|
if !description.starts_with("\n# ") || !description.ends_with('\n') {
|
|
panic!("Missing description for feature {name}");
|
|
}
|
|
let description = description
|
|
.strip_prefix("\n# ")
|
|
.unwrap()
|
|
.strip_suffix('\n')
|
|
.unwrap()
|
|
.to_string();
|
|
Some(Feature {
|
|
is_default: default.contains(&name),
|
|
name,
|
|
description,
|
|
})
|
|
} else if panic_on_missing {
|
|
panic!("Missing description for feature {name}");
|
|
} else {
|
|
None
|
|
}
|
|
}
|
|
})
|
|
.collect()
|
|
}
|
|
|
|
pub(crate) fn check(what_to_run: Command) {
|
|
let mut features = parse_features(what_to_run.contains(Command::CHECK_MISSING));
|
|
features.sort();
|
|
|
|
if what_to_run.contains(Command::UPDATE) {
|
|
let mut context = Context::new();
|
|
context.insert("features", &features);
|
|
Tera::new("docs-template/*.md.tpl")
|
|
.expect("error parsing template")
|
|
.render_to(
|
|
"features.md.tpl",
|
|
&context,
|
|
File::create("docs/cargo_features.md").expect("error creating file"),
|
|
)
|
|
.expect("error rendering template");
|
|
}
|
|
}
|