-
Notifications
You must be signed in to change notification settings - Fork 1.6k
[ty] Add ty.inlayHints.variableTypes server option
#19780
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| use anyhow::Result; | ||
| use lsp_types::{Position, Range, notification::PublishDiagnostics}; | ||
| use ruff_db::system::SystemPath; | ||
| use ty_server::ClientOptions; | ||
|
|
||
| use crate::TestServerBuilder; | ||
|
|
||
| /// Tests that disabling variable types inlay hints works correctly. | ||
| #[test] | ||
| fn variable_inlay_hints_disabled() -> Result<()> { | ||
| let workspace_root = SystemPath::new("src"); | ||
| let foo = SystemPath::new("src/foo.py"); | ||
| let foo_content = "x = 1"; | ||
|
|
||
| let mut server = TestServerBuilder::new()? | ||
| .with_initialization_options( | ||
| ClientOptions::default().with_variable_types_inlay_hints(false), | ||
| ) | ||
| .with_workspace(workspace_root, None)? | ||
| .with_file(foo, foo_content)? | ||
| .enable_inlay_hints(true) | ||
| .build()? | ||
| .wait_until_workspaces_are_initialized()?; | ||
|
|
||
| server.open_text_document(foo, &foo_content, 1); | ||
| let _ = server.await_notification::<PublishDiagnostics>()?; | ||
|
|
||
| let hints = server | ||
| .inlay_hints_request(foo, Range::new(Position::new(0, 0), Position::new(0, 5)))? | ||
| .unwrap(); | ||
|
|
||
| assert!( | ||
| hints.is_empty(), | ||
| "Expected no inlay hints, but found: {hints:?}" | ||
| ); | ||
|
|
||
| Ok(()) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems unnecessary to traverse the entire tree only to bail out at the assignment level. Should we add a
InlayHintSettings::any_enabledand bail out in the inlay hint request if it returns false to avoid doing all this unnecessary work?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that makes sense.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, I don't think we should add that today because there will be (in the future) multiple positions for which we won't provide a way to disable. I don't think the server should provide configuring every position of inlay hints. So, I'm going to avoid adding this today.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you give an example of inlays that the user can't disable and we'd always provide (I'm not disagreeing, just curious)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, I don't have an example on top of my mind and it might be that it doesn't exists 😅