Actix-web's attribute macros are not IDE friendly #2394
Labels
A-codegen
project: actix-web-codegen
C-improvement
Category: an improvement to existing functionality
good-first-issue
easy to pick up for newcomers
In short this is a problem with how syn and attributes using syn implement failure, as these crates tend to just discard the entire attributed item on a parsing failure, replacing it with a
compile_error!
invocation. This has the side effect that when typing inside an item, a user may momentarily create invalid syntax causing the item to be fully discarded resulting in loss of IDE features as the item now effectively does not exist in the file until this syntax error has been fixed.Possible Solution
A simple solution to this problem is to change the attributes such that when they error, they re-emit the original item with the
compile_error!
invocation, that way IDEs will still see the item even if the attribute fails causing IDE features to continue to function.Sidenote: This will fix the general problem, but if the attribute introduces new usable items inside the item they will of course not always be visible in completions with just this fix. An ideal fix would be to make the attribute do parsing with recovery in such cases if required.
Steps to Reproduce
This problem can be observed(in rust-analyzer) by doing the following.
Using the Readme's example snippet(where
$0
represents the current cursor position):0.m
and notice that we do not get any completions#[actix_web::main]
attribute0.m
again, this time with completionsrustc -V
): rustc 1.55.0 (c8dfcfe04 2021-09-06)See a relevant RA issue rust-lang/rust-analyzer#10468
The text was updated successfully, but these errors were encountered: