Skip to content

M0029 macro-compile-fail

Rule: Every proc-macro crate has compile-fail tests.

Code M0029 (stable, never reused)
Id macro-compile-fail
Category workspace
Source spirit_level
Fix by hand

Level per tier

Tier Level Reason
small off
small-workspace off
medium warn a proc macro must refuse bad input with a clear error, and only compile-fail cases show that
big warn a proc macro must refuse bad input with a clear error, and only compile-fail cases show that
ai off
embedded off
ui off
egui off
units-strict off
units-paranoid off

Parameters

Name Type Default Meaning
harnesses list of strings ["trybuild", "ui_test"] crates that run compile-fail cases

Why

A proc macro's job is half refusal: it must reject what it cannot expand, with an error that points at the user's code. Ordinary tests only show what compiles. A compile-fail crate holds the inputs the macro must refuse, each a .rs file with its expected .stderr, and fails when an error message changes or a bad input compiles. Bevy keeps one such crate for each of its macro crates.

How to fix

Add a test crate beside the macro crate that depends on it (directly or through the crate that re-exports it) and on trybuild or ui_test:

crates/widgets_macros/            the proc-macro crate
crates/widgets_compile_fail/      dev-dependency on trybuild
  tests/it/main.rs                trybuild::TestCases::new().compile_fail("tests/cases/*.rs")
  tests/cases/missing_field.rs
  tests/cases/missing_field.stderr

The lint looks for a crate that reaches the macro crate and depends on one of the harness crates (parameter harnesses); it does not run the cases.

Configure

[lints.macro-compile-fail]
level = "deny"
harnesses = ["trybuild", "ui_test"]
reason = "why this project wants it at this level"

Allow one finding in the code with // spirit-level: allow(macro-compile-fail) <reason> (waivers); the code works there too, as in [lints.M0029].