src/tools/tidy/src/edition.rs

//! Tidy check to ensure that crate `edition` is '2021' or '2024'.

use std::path::Path;

use crate::diagnostics::{CheckId, TidyCtx};
use crate::walk::{filter_dirs, walk};

pub fn check(path: &Path, tidy_ctx: TidyCtx) {
    let mut check = tidy_ctx.start_check(CheckId::new("edition").path(path));
    walk(path, |path, _is_dir| filter_dirs(path), &mut |entry, contents| {
        let file = entry.path();
        let filename = file.file_name().unwrap();
        if filename != "Cargo.toml" {
            return;
        }

        let is_current_edition = contents
            .lines()
            .any(|line| line.trim() == "edition = \"2021\"" || line.trim() == "edition = \"2024\"");

        let is_workspace = contents.lines().any(|line| line.trim() == "[workspace]");
        let is_package = contents.lines().any(|line| line.trim() == "[package]");
        assert!(is_workspace || is_package);

        // Check that all packages use the 2021 edition. Virtual workspaces don't allow setting an
        // edition, so these shouldn't be checked.
        if is_package && !is_current_edition {
            check.error(format!(
                "{} doesn't have `edition = \"2021\"` or `edition = \"2024\"` on a separate line",
                file.display()
            ));
        }
    });
}