Don't emit nested objects as document symbols #859
Conversation
lionel-
force-pushed
the
feature/method-symbols
branch
from
698f1a3 to
f67b10f
Compare
lionel-
force-pushed
the
feature/top-level-assign-symbols
branch
from
5e3988d to
a4f5a00
Compare
| foo.detail = Some(String::from("function()")); | ||
|
|
||
| assert_eq!(test_symbol("foo <- function() { bar <- 1 }"), vec![foo]); | ||
| insta::assert_debug_snapshot!(test_symbol("foo <- function() { bar <- function() 1 }")); |
There was a problem hiding this comment.
I think it would be worth also having a snapshot test that sets include_assignments_in_blocks to true if you can easily expose that toggle
There was a problem hiding this comment.
Good idea. (I'm assuming you mean testing nested assignments below, rather than making extra sure we always include functions here)
| // Assigned variables in nested contexts are not emitted as symbols | ||
| fn test_symbol_nested_assignments() { | ||
| insta::assert_debug_snapshot!(test_symbol( | ||
| " |
There was a problem hiding this comment.
And, to be super clear, at top level we do want assigned variables to be treated as symbols?
I honestly don't think that sounds super useful either
Like, a 300 line R script is bound to have a ton of assignments, and I'm not sure that seeing them in the outline feels that useful.
There was a problem hiding this comment.
It's useful at least in packages with e.g. R6 classes.
In scripts top-level assignments allow to quickly look through things like assigned data frames. But you're right that lots of variables won't be very useful to have in there.
lionel-
force-pushed
the
feature/method-symbols
branch
from
f67b10f to
323baa2
Compare
lionel-
force-pushed
the
feature/top-level-assign-symbols
branch
from
bc8ec87 to
db257d2
Compare
Branched from #858
Addresses posit-dev/positron#8330
Objects assigned in
{}blocks are currently emitted as document symbols, which causes the ouline and document symbol search (@prefix in command palette) to be quite busy:Screen.Recording.2025-06-27.at.15.18.45.mov
Here is how it looks like if we only emit top-level objects:
Screen.Recording.2025-06-27.at.15.20.35.mov
This is controllable via a new
"positron.r.symbols.includeAssignmentsInBlockssetting. By default we don't include these nested assignments.QA Notes
You should see the new setting in the config UI:
It's documented that files need to be reopened (they can also be changed) or the server restarted for this setting to take effect.