From 71c6e31889923b1101d7651429ab9ed0f2384024 Mon Sep 17 00:00:00 2001
From: Chris Kipp <ckipp@pm.me>
Date: Fri, 15 Dec 2023 14:01:59 +0100
Subject: [PATCH] feat: account for new verboseCompilation setting

refs: https://github.com/scalameta/metals/pull/5937
---
 doc/metals.txt        | 30 +++++++++++++++++++-----------
 lua/metals/config.lua |  1 +
 2 files changed, 20 insertions(+), 11 deletions(-)

diff --git a/doc/metals.txt b/doc/metals.txt
index 0a4dcc8..fa39577 100644
--- a/doc/metals.txt
+++ b/doc/metals.txt
@@ -168,6 +168,7 @@ _ones that are sent and used by the server_
   * |ammoniteJvmProperties|
   * |bloopSbtAlreadyInstalled|
   * |bloopVersion|
+  * |enableSemanticHighlighting|
   * |excludedPackages|
   * |fallbackScalaVersion|
   * |gradleScript|
@@ -187,7 +188,7 @@ _ones that are sent and used by the server_
   * |showImplicitConversionsAndClasses|
   * |showInferredType|
   * |superMethodLensesEnabled|
-  * |enableSemanticHighlighting|
+  * |verboseCompilation|
 
 _ones that are used internally by `nvim-metals`_
   * |disabledMode|
@@ -250,6 +251,15 @@ continually do this every time you want to use it even in the same workspace.
 If people _actually_ use this setting and want that, submit a feature request,
 if not it's not worth the extra work.
 
+enableSemanticHighlighting                          *enableSemanticHighlighting* 
+
+Type: boolean ~
+Default: true ~
+
+When this option is enabled, Metals will provide semantic tokens for clients
+that support it. The feature is still experimental and does not work for
+all sources.
+
 excludedPackages                                              *excludedPackages*
 
 Type: table as list ~
@@ -474,16 +484,6 @@ Default: true ~
 When enabled Metals will populate code lenses for you to navigate to the
 parent/super methods of members.
 
-
-enableSemanticHighlighting                          *enableSemanticHighlighting* 
-
-Type: boolean ~
-Default: true ~
-
-When this option is enabled, Metals will provide semantic tokens for clients
-that support it. The feature is still experimental and does not work for
-all sources.
-
                                                            *useGlobalExecutable*
 Type: boolean ~
 Default: false ~
@@ -495,6 +495,14 @@ there is a specific reason that you want to manage your own version and
 install manually, then I'd recommend not using this setting and just letting
 `nvim-metals` handle it.
 
+                                                            *verboseCompilation*
+Type: boolean ~
+Default: false ~
+
+If a build server supports it (for example Bloop or Scala CLI), setting it to
+true will make the logs contain all the possible debugging information
+including that about incremental compilation in Zinc.
+
 ================================================================================
 COMMANDS                                                       *metals-commands*
 
diff --git a/lua/metals/config.lua b/lua/metals/config.lua
index 8f02b26..03a0a76 100644
--- a/lua/metals/config.lua
+++ b/lua/metals/config.lua
@@ -134,6 +134,7 @@ local valid_metals_settings = {
   "showInferredType",
   "superMethodLensesEnabled",
   "testUserInterface",
+  "verboseCompilation",
 }
 
 -- We keep these separated from the `valid_metals_settings` just for clarity.