Why use nvim-metals instead of Metals + nvim-lspconfig

[ckipp01]

A common question I get asked is what exactly does nvim-metals include that just using Metals + nvim-lspconfig doesn't offer. I've done my best to outline the extra benefits you will get by using this plugin below:

• metals/quickPick is implemented.
• metals/inputBox is implemented.
• metals/executeClientCommandis implemented.
• metals/status is implemented. NOTE: this needs to be turned on.
• metals/didFocusTextDocument is implemented.
• metals/publishDecorations. This is what shows virtual text in worksheets instead of comments.
• Lots of built in commands. eg: :MetalsBuildImport, :MetalsBspSwitch, :MetalsNewScalaFile. You can see them all by doing a :h metals-commands.
• Easy Metals install with :MetalsInstall.
• Correct init_options to ensure all the extensions above work as expected.
• Extra integrations, such as that with nvim-dap and Telescope.
• Implements the Metals Tree View Protocol.
• Some extra defaults applied to make things like document hightlights and code lenses work without needing to add autocmds yourself.

Without much of the above implemented you'll pretty quickly run into issues with things in Metals not working as expected, or not offering support for things that it has the ability to do, but just needs the correct settings set. It's highly recommended to use nvim-metals if you're going to be using Metals with the native LSP support in NeoVim.