Keep plugin id of cabal-fmt in sync with default config id

Add documentation to note that these values are to be kept in sync

Author: VeryMilkyJoe

hls-plugin-api/src/Ide/Types.hs

@@ -200,6 +200,7 @@ instance Default Config where
     -- , formattingProvider          = "floskell"
     -- , formattingProvider          = "stylish-haskell"
     , cabalFormattingProvider     = "cabal-fmt"
+    -- this string value needs to kept in sync with the value provided in HlsPlugins
     , maxCompletions              = 40
     , plugins                     = mempty
     }
@@ -344,38 +345,38 @@ defaultConfigDescriptor =
 class HasTracing (MessageParams m) => PluginMethod (k :: MethodType) (m :: Method FromClient k) where
 
   -- | Parse the configuration to check if this plugin is enabled.
-  -- Perform sanity checks on the message to see whether plugin is enabled
+  -- Perform sanity checks on the message to see whether the plugin is enabled
   -- for this message in particular.
-  -- If a plugin is not enabled, its handlers, commands, etc... will not be
+  -- If a plugin is not enabled, its handlers, commands, etc. will not be
   -- run for the given message.
   --
-  -- Semantically, this method described whether a Plugin is enabled configuration wise
+  -- Semantically, this method describes whether a plugin is enabled configuration wise
   -- and is allowed to respond to the message. This might depend on the URI that is
-  -- associated to the Message Parameters, but doesn't have to. There are requests
-  -- with no associated URI that, consequentially, can't inspect the URI.
+  -- associated to the Message Parameters. There are requests
+  -- with no associated URI that, consequentially, cannot inspect the URI.
   --
-  -- Common reason why a plugin might not be allowed to respond although it is enabled:
-  --   * Plugin can not handle requests associated to the specific URI
+  -- A common reason why a plugin might not be allowed to respond although it is enabled:
+  --   * The plugin cannot handle requests associated with the specific URI
   --     * Since the implementation of [cabal plugins](https://github.com/haskell/haskell-language-server/issues/2940)
-  --       HLS knows plugins specific for Haskell and specific for [Cabal file descriptions](https://cabal.readthedocs.io/en/3.6/cabal-package.html)
+  --       HLS knows plugins specific to Haskell and specific to [Cabal file descriptions](https://cabal.readthedocs.io/en/3.6/cabal-package.html)
   --
   -- Strictly speaking, we are conflating two concepts here:
-  --   * Dynamically enabled (e.g. enabled on a per-message basis)
+  --   * Dynamically enabled (e.g. on a per-message basis)
   --   * Statically enabled (e.g. by configuration in the lsp-client)
   --     * Strictly speaking, this might also change dynamically
   --
-  -- But there is no use to split it up currently into two different methods for now.
+  -- But there is no use to split it up into two different methods for now.
   pluginEnabled
     :: SMethod m
     -- ^ Method type.
     -> MessageParams m
     -- ^ Whether a plugin is enabled might depend on the message parameters
-    --   eg 'pluginFileType' specifies what file extension a plugin is allowed to handle
+    --   e.g. 'pluginFileType' specifies which file extensions a plugin is allowed to handle
     -> PluginDescriptor c
-    -- ^ Contains meta information such as PluginId and what file types this
+    -- ^ Contains meta information such as PluginId and which file types this
     -- plugin is able to handle.
     -> Config
-    -- ^ Generic config description, expected to hold 'PluginConfig' configuration
+    -- ^ Generic config description, expected to contain 'PluginConfig' configuration
     -- for this plugin
     -> Bool
     -- ^ Is this plugin enabled and allowed to respond to the given request

src/HlsPlugins.hs

@@ -161,7 +161,9 @@ idePlugins recorder = pluginDescToIdePlugins allPlugins
       let pId = "fourmolu" in Fourmolu.descriptor (pluginRecorder pId) pId:
 #endif
 #if hls_cabalfmt
-      let pId = "cabalfmt" in CabalFmt.descriptor (pluginRecorder pId) pId:
+      -- this pId needs to be kept in sync with the hardcoded
+      -- cabalFormattingProvider in the Default Config
+      let pId = "cabal-fmt" in CabalFmt.descriptor (pluginRecorder pId) pId:
 #endif
 #if hls_tactic
       let pId = "tactics" in Tactic.descriptor (pluginRecorder pId) pId: