Document call hierarchy plugin

[July541]

This document includes

• description
• demo
• requirement and configure
• acknowledge

[jneira]

wow, that was really fast, many thanks for adding the docs, we miss them here a lot 😅

[July541]

Yes, I got a lot of trouble when I first into this project 😅, hope it can bring convenience to others.

[jneira]

I would add a link to this readme in the main one, in the features section f.e.

[July541]

@jneira I am not sure how to point out where the setting is precisely, maybe we can link it to a unified place(lots of plugins need this)

[jneira]

mmm you can the discover the hls server configuration with 2 commands:

• haskell-language-server vscode-extension-schema: it outputs a json snippet usable in the vscode extension package.json config to add them auto to the extension config ui in vscode
• haskell-language-server generate-default-config: it outputs the default values of that config

So the configuration for hlint, for example, would be:

{
  "haskell.plugin.hlint.diagnosticsOn": false
}

If you put a file with that content in a settings.json int the project root dir, you will disable hlint

... but i tried both commands with last version and it does not mention any hls-call-hierarchy plugin.. 🤔

I think something has to be done to "register" the plugin and include its config in the output, but dont remember right now (i think @berberman did that nice addition to the cli)

[berberman]

but i tried both commands with last version and it does not mention any hls-call-hierarchy plugin

Ah, that's because

haskell-language-server/hls-plugin-api/src/Ide/Plugin/ConfigUtils.hs

Lines 87 to 95 in 047ffc3

	handlersToGenericDefaultConfig :: DSum.DSum IdeMethod f -> [A.Pair]
	handlersToGenericDefaultConfig (IdeMethod m DSum.:=> _) = case m of
	STextDocumentCodeAction -> ["codeActionsOn" A..= True]
	STextDocumentCodeLens -> ["codeLensOn" A..= True]
	STextDocumentRename -> ["renameOn" A..= True]
	STextDocumentHover -> ["hoverOn" A..= True]
	STextDocumentDocumentSymbol -> ["symbolsOn" A..= True]
	STextDocumentCompletion -> ["completionOn" A..= True]
	_ -> []

and

haskell-language-server/hls-plugin-api/src/Ide/Plugin/ConfigUtils.hs

Lines 117 to 124 in 047ffc3

	handlersToGenericSchema (IdeMethod m DSum.:=> _) = case m of
	STextDocumentCodeAction -> [withIdPrefix "codeActionsOn" A..= schemaEntry "code actions"]
	STextDocumentCodeLens -> [withIdPrefix "codeLensOn" A..= schemaEntry "code lenses"]
	STextDocumentRename -> [withIdPrefix "renameOn" A..= schemaEntry "rename"]
	STextDocumentHover -> [withIdPrefix "hoverOn" A..= schemaEntry "hover"]
	STextDocumentDocumentSymbol -> [withIdPrefix "symbolsOn" A..= schemaEntry "symbols"]
	STextDocumentCompletion -> [withIdPrefix "completionOn" A..= schemaEntry "completions"]
	_ -> []

need update for new call hierarchy handlers

[jneira]

@July541 could you have the chance of update those definitions, to complete the hierarchy plugin integration?

[July541]

Sure, I'll do it.

[Ailrun]

I think it's helpful to mention somewhere in this doc that this works only on definitions, not type signatures. I recently saw some people said that this feature doesn't work, but it was actually that they used this on type signatures.

[jneira]

out of curiosity anyone knows if other langs work differently?

[Ailrun]

I would add a link to this readme in the main one, in the features section f.e.

Yeah, giving users the links to documented plugins will be great. Currently it's kinda hard to know which one is documented, and it's also not so user-friendly that asking users to check directories for all packages.

[July541]

Continue on #2072.