Get files from Shake VFS from within plugin handlers #4328
Conversation
This file contains 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 avoids a few conversions between Rope and Text in the next commit
- Note: Syntactic changes to Development.IDE.Plugin.CodeAction around line
2000 are to work around the following stylish-haskell failure:
plugins/hls-refactor-plugin/src/Development/IDE/Plugin/CodeAction.hs: <string>:2002:5:
error: [GHC-58481]
parse error (possibly incorrect indentation or mismatched brackets)
This commit changes plugins to get virtual files from the Shake VFS rather than from the language server's VFS. - Replace `Ide.Types.pluginGetVirtualFile` with `Development.IDE.Core.FileStore.getFileContents` - Replace `Ide.Types.pluginGetVersionedTextDoc` with `Development.IDE.Core.FileStore.getVersionedTextDoc`
awjchen
requested review from
konn,
wz1000,
santiweight,
eddiemundo,
georgefst,
jvanbruegge,
peterbecich,
fendor,
VeryMilkyJoe and
michaelpj
as code owners
awjchen
commented
Jun 20, 2024
fendor
requested changes
Jun 20, 2024
There was a problem hiding this comment.
The idea and execution is good, but could we introduce some plugin util functions that abstract over the most common use cases? I find
liftIO $ runAction "ModuleName.getFileContents" state $ fmap snd $ getFileContents nfp
much less appealing than
lift . pluginGetVirtualFile $ toNormalizedUri uri
In particular
contents <- liftIO $ runAction "Pragmas.GetFileContents" ide $ maybe (pure Nothing) (fmap snd . getFileContents) $ LSP.uriToNormalizedFilePath $ toNormalizedUri uri
looks much more complicated.
Some combinators that make it easier to figure out at a glance what is going on would be great.
|
I agree with @fendor , it would be great if this is introduced as new util function. And perhaps other plugin can use it. |
|
@fendor Sorry for the delay! I've added some util functions that make the file accesses look more like they did before this PR |
fendor
approved these changes
Jul 1, 2024
|
Looks like it has some warnings, which is failing the build. |
|
Oops, I think I've fixed it now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR is a step towards #4057.
This PR modifies plugin handlers to get virtual files from the Shake VFS instead of the language server's VFS. Specifically, this PR removes both
pluginGetVirtualFileandpluginGetVersionedTextDoc, and replaces them with the (existing)getFileContentsand (new)getVersionedTextDocShake actions.This PR also changes
getFileContentsto return theRopeat hand instead of converting it toText, which eliminates a few redundant conversions (specifically, at uses ofgetCompletionPrefix[fromRope]). There are probably more instances in the plugin handlers whereRopes could replaceTextfor more efficiency, but this PR does not address them.