From c3c5d2b5a64f4b56385c7fcd9b93e1f9c84c466a Mon Sep 17 00:00:00 2001 From: Jana Chadt Date: Tue, 30 May 2023 14:08:06 +0200 Subject: [PATCH] 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 --- hls-plugin-api/src/Ide/Types.hs | 1 + src/HlsPlugins.hs | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/hls-plugin-api/src/Ide/Types.hs b/hls-plugin-api/src/Ide/Types.hs index 031158c35b..8e762095bb 100644 --- a/hls-plugin-api/src/Ide/Types.hs +++ b/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 } diff --git a/src/HlsPlugins.hs b/src/HlsPlugins.hs index 06b4c26bad..f03b321de0 100644 --- a/src/HlsPlugins.hs +++ b/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: