Add workspace/executeCommand and clearIndexCache command #131
Conversation
gabro
force-pushed
the
workspace-execute-command
branch
from
c223b38
to
4fc0cfc
Compare
| @@ -323,6 +343,18 @@ object ScalametaLanguageServer extends LazyLogging { | |||
| path | |||
| } | |||
|
|
|||
| def clearCacheDirectory(): Unit = | |||
There was a problem hiding this comment.
if somebody knows a better way of recursively deleting a directory with Java NIO, please let me know!
There was a problem hiding this comment.
This is the best way to do it IMO :) It should be verbose!
There was a problem hiding this comment.
On a more serious note, this might merit inclusion in org.langmeta.io.FileIO where we have similar utils
| WorkspaceCommand.withNameOption(request.params.command).map { | ||
| case ClearIndexCache => | ||
| logger.info("Clearing the index cache") | ||
| ScalametaLanguageServer.clearCacheDirectory() |
There was a problem hiding this comment.
we currently clear the index, but we don't trigger re-indexing. I think it's fine for debugging to have this level of granularity, but we may want to add a separate command for triggering re-indexing.
| import enumeratum.EnumEntry | ||
| import enumeratum.EnumEntry.Uncapitalised | ||
|
|
||
| sealed trait WorkspaceCommand extends EnumEntry with Uncapitalised |
There was a problem hiding this comment.
I went for a lowerCamelCase convention here and thanks to Uncapitalised this is automatically handled by withNameOption and entryName
| case ClearIndexCache => | ||
| logger.info("Clearing the index cache") | ||
| ScalametaLanguageServer.clearCacheDirectory() | ||
| }.getOrElse(logger.error(s"Unknown command ${request.params.command}")) |
There was a problem hiding this comment.
the server declares which messages it responds to, but that doesn't prevent the VSCode client to send arbitrary messages, so we log an error to help debugging typos and other mistakes.
| @@ -317,6 +317,12 @@ object DocumentFormattingParams { | |||
| implicit val format = Json.format[DocumentFormattingParams] | |||
| } | |||
|
|
|||
| case class WorkspaceExecuteCommandParams(command: String, arguments: Option[Seq[JsValue]]) | |||
There was a problem hiding this comment.
arguments is any[] in the LSP, so I figured JsValue is a good type is.
| @@ -323,6 +343,18 @@ object ScalametaLanguageServer extends LazyLogging { | |||
| path | |||
| } | |||
|
|
|||
| def clearCacheDirectory(): Unit = | |||
There was a problem hiding this comment.
This is the best way to do it IMO :) It should be verbose!
| @@ -323,6 +343,18 @@ object ScalametaLanguageServer extends LazyLogging { | |||
| path | |||
| } | |||
|
|
|||
| def clearCacheDirectory(): Unit = | |||
There was a problem hiding this comment.
On a more serious note, this might merit inclusion in org.langmeta.io.FileIO where we have similar utils
| @@ -91,5 +92,12 @@ export async function activate(context: ExtensionContext) { | |||
| } | |||
| }); | |||
|
|
|||
| client.onReady().then(() => { | |||
| const clearIndexCacheCommand = commands.registerCommand("scalameta.clearIndexCache", async () => { | |||
There was a problem hiding this comment.
Is this needed for every new command? I thought codeActions was a way for the server to list the commands it supports.
There was a problem hiding this comment.
Yes, it is. codeAction is not very well integrated in the client library, as of now. I guess it may depend by the requirement for extensions to statically include commands in the manifest
|
@gabro For future reference if you prefer you can use the java streams api. I’m not at my computer but it would be something like: Files.walk(pathToDelete) //You need to follow links, I think that is default behavior, can’t remember |
Closes #109