Switch to using defcustom-lsp

This means that changing the settings will send `didChangeConfiguration`
notifications to running servers, so you shouldn't have to restart the
server to see the different configuration.

Author: michaelpj

lsp-haskell.el

@@ -46,148 +46,175 @@
 ;; Originally generated from the vscode extension's package.json using lsp-generate-bindings.
 ;; Should ideally stay in sync with what's offered in the vscode extension.
 
-(defcustom lsp-haskell-formatting-provider
+(defcustom-lsp lsp-haskell-formatting-provider
   "ormolu"
   "The formatter to use when formatting a document or range. Ensure the plugin is enabled."
   :group 'lsp-haskell
-  :type '(choice (const "brittany") (const "floskell") (const "fourmolu") (const "ormolu") (const "stylish-haskell") (const "none")))
-(defcustom lsp-haskell-check-project
+  :type '(choice (const "brittany") (const "floskell") (const "fourmolu") (const "ormolu") (const "stylish-haskell") (const "none"))
+  :lsp-path "haskell.formattingProvider")
+(defcustom-lsp lsp-haskell-check-project
   t
   "Whether to typecheck the entire project on load. It could lead to bad perfomance in large projects."
   :group 'lsp-haskell
-  :type 'boolean)
-(defcustom lsp-haskell-max-completions
+  :type 'boolean
+  :lsp-path "haskell.checkProject")
+(defcustom-lsp lsp-haskell-max-completions
   40
   "Maximum number of completions sent to the editor."
   :group 'lsp-haskell
-  :type 'number)
+  :type 'number
+  :lsp-path "haskell.maxCompletions")
 
 ;; ---------------------------------------------------------------------
 ;; Plugin-specific configuration
 (defgroup lsp-haskell-plugins nil
   "Customization group for 'lsp-haskell' plugins."
   :group 'lsp-haskell)
 
-(defcustom lsp-haskell-plugin-import-lens-code-actions-on
+(defcustom-lsp lsp-haskell-plugin-import-lens-code-actions-on
   t
   "Enables explicit imports code actions"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-import-lens-code-lens-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.importLens.codeActionsOn")
+(defcustom-lsp lsp-haskell-plugin-import-lens-code-lens-on
   t
   "Enables explicit imports code lenses"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-hlint-code-actions-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.importLens.codeLensOn")
+(defcustom-lsp lsp-haskell-plugin-hlint-code-actions-on
   t
   "Enables hlint code actions (apply hints)"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-hlint-diagnostics-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.hlint.codeActionsOn")
+(defcustom-lsp lsp-haskell-plugin-hlint-diagnostics-on
   t
   "Enables hlint diagnostics"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-hlint-config-flags
+  :type 'boolean
+  :lsp-path "haskell.plugin.hlint.diagnosticsOn")
+(defcustom-lsp lsp-haskell-plugin-hlint-config-flags
   nil
   "Flags used by hlint"
   :group 'lsp-haskell-plugins
-  :type 'lsp-string-vector)
-(defcustom lsp-haskell-plugin-eval-global-on
+  :type 'lsp-string-vector
+  :lsp-path "haskell.plugin.hlint.config.flags")
+(defcustom-lsp lsp-haskell-plugin-eval-global-on
   t
   "Enables eval plugin"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-module-name-global-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.eval.globalOn")
+(defcustom-lsp lsp-haskell-plugin-module-name-global-on
   t
   "Enables module name plugin"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-splice-global-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.moduleName.globalOn")
+(defcustom-lsp lsp-haskell-plugin-splice-global-on
   t
   "Enables splice plugin (expand template haskell definitions)"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-haddock-comments-global-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.splice.globalOn")
+(defcustom-lsp lsp-haskell-plugin-haddock-comments-global-on
   t
   "Enables haddock comments plugin"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-class-global-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.haddockComments.globalOn")
+(defcustom-lsp lsp-haskell-plugin-class-global-on
   t
   "Enables type class plugin"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-retrie-global-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.class.globalOn")
+(defcustom-lsp lsp-haskell-plugin-retrie-global-on
   t
   "Enables retrie plugin"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-tactics-global-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.retrie.globalOn")
+(defcustom-lsp lsp-haskell-plugin-tactics-global-on
   t
   "Enables Wingman (tactics) plugin"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-tactics-config-auto-gas
+  :type 'boolean
+  :lsp-path "haskell.plugin.tactics.globalOn")
+(defcustom-lsp lsp-haskell-plugin-tactics-config-auto-gas
   4
   "The depth of the search tree when performing \"Attempt to fill hole\". Bigger values will be able to derive more solutions, but will take exponentially more time."
   :group 'lsp-haskell-plugins
-  :type 'number)
-(defcustom lsp-haskell-plugin-tactics-config-hole-severity
+  :type 'number
+  :lsp-path "haskell.plugin.tactics.config.auto_gas")
+(defcustom-lsp lsp-haskell-plugin-tactics-config-hole-severity
   nil
   "The severity to use when showing hole diagnostics."
   :group 'lsp-haskell-plugins
-  :type '(choice (const 1) (const 2) (const 3) (const 4) (const nil)))
-(defcustom lsp-haskell-plugin-tactics-config-max-use-ctor-actions
+  :type '(choice (const 1) (const 2) (const 3) (const 4) (const nil))
+  :lsp-path "haskell.plugin.tactics.config.hole_severity")
+(defcustom-lsp lsp-haskell-plugin-tactics-config-max-use-ctor-actions
   5
   "Maximum number of `Use constructor <x>` code actions that can appear"
   :group 'lsp-haskell-plugins
-  :type 'number)
-(defcustom lsp-haskell-plugin-tactics-config-timeout-duration
+  :type 'number
+  :lsp-path "haskell.plugin.tactics.config.max_use_ctor_actions")
+(defcustom-lsp lsp-haskell-plugin-tactics-config-timeout-duration
   2
   "The timeout for Wingman actions, in seconds"
   :group 'lsp-haskell-plugins
-  :type 'number)
-(defcustom lsp-haskell-plugin-tactics-config-proofstate-styling
+  :type 'number
+  :lsp-path "haskell.plugin.tactics.config.timeout_duration")
+(defcustom-lsp lsp-haskell-plugin-tactics-config-proofstate-styling
   t
   "Should Wingman emit styling markup when showing metaprogram proof states?"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-pragmas-code-actions-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.tactics.config.proofstate_styling")
+(defcustom-lsp lsp-haskell-plugin-pragmas-code-actions-on
   t
   "Enables pragmas code actions"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-pragmas-completion-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.pragmas.codeActionsOn")
+(defcustom-lsp lsp-haskell-plugin-pragmas-completion-on
   t
   "Enables pragmas completions"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-ghcide-completions-config-auto-extend-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.pragmas.completionsOn")
+(defcustom-lsp lsp-haskell-plugin-ghcide-completions-config-auto-extend-on
   t
   "Extends the import list automatically when completing a out-of-scope identifier"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-ghcide-completions-config-snippets-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.ghcide-completions.config.autoExtendOn")
+(defcustom-lsp lsp-haskell-plugin-ghcide-completions-config-snippets-on
   lsp-enable-snippet
   "Inserts snippets when using code completions"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-ghcide-type-lenses-global-on
+  :type 'boolean
+  :lsp-path "haskell.plugin.ghcide-completions.config.snippetsOn")
+(defcustom-lsp lsp-haskell-plugin-ghcide-type-lenses-global-on
   t
   "Enables type lenses plugin"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
-(defcustom lsp-haskell-plugin-ghcide-type-lenses-config-mode
+  :type 'boolean
+  :lsp-path "haskell.plugin.ghcide-type-lenses.globalOn")
+(defcustom-lsp lsp-haskell-plugin-ghcide-type-lenses-config-mode
   t
   "Control how type lenses are shown"
   :group 'lsp-haskell-plugins
-  :type '(choice (const "always") (const "exported") (const "diagnostics")))
-(defcustom lsp-haskell-plugin-refine-imports-global-on
+  :type '(choice (const "always") (const "exported") (const "diagnostics"))
+  :lsp-path "haskell.plugin.ghcide-type-lenses.config.mode")
+(defcustom-lsp lsp-haskell-plugin-refine-imports-global-on
   t
   "Enables refine imports plugin"
   :group 'lsp-haskell-plugins
-  :type 'boolean)
+  :type 'boolean
+  :lsp-path "haskell.plugin.refineImports.globalOn")
 
 ;; ---------------------------------------------------------------------
 ;; Non-language server options
@@ -276,38 +303,6 @@ These are assembled from the customizable variables `lsp-haskell-server-path'
 and `lsp-haskell-server-args' and `lsp-haskell-server-wrapper-function'."
   (funcall lsp-haskell-server-wrapper-function (append (list lsp-haskell-server-path "--lsp") lsp-haskell-server-args) ))
 
-;; Register all the language server settings with lsp-mode.
-;; Note that customizing these will currently *not* send the updated configuration to the server,
-;; users must manually restart. See https://github.com/emacs-lsp/lsp-mode/issues/1174.
-(lsp-register-custom-settings
- '(("haskell.plugin.refineImports.globalOn" lsp-haskell-plugin-refine-imports-global-on t)
-   ("haskell.plugin.ghcide-type-lenses.config.mode" lsp-haskell-plugin-ghcide-type-lenses-config-mode)
-   ("haskell.plugin.ghcide-type-lenses.globalOn" lsp-haskell-plugin-ghcide-type-lenses-global-on t)
-   ("haskell.plugin.ghcide-completions.config.snippetsOn" lsp-haskell-plugin-ghcide-completions-config-snippets-on t)
-   ("haskell.plugin.ghcide-completions.config.autoExtendOn" lsp-haskell-plugin-ghcide-completions-config-auto-extend-on t)
-   ("haskell.plugin.pragmas.completionOn" lsp-haskell-plugin-pragmas-completion-on t)
-   ("haskell.plugin.pragmas.codeActionsOn" lsp-haskell-plugin-pragmas-code-actions-on t)
-   ("haskell.plugin.tactics.config.proofstate_styling" lsp-haskell-plugin-tactics-config-proofstate-styling t)
-   ("haskell.plugin.tactics.config.timeout_duration" lsp-haskell-plugin-tactics-config-timeout-duration)
-   ("haskell.plugin.tactics.config.max_use_ctor_actions" lsp-haskell-plugin-tactics-config-max-use-ctor-actions)
-   ("haskell.plugin.tactics.config.hole_severity" lsp-haskell-plugin-tactics-config-hole-severity)
-   ("haskell.plugin.tactics.config.auto_gas" lsp-haskell-plugin-tactics-config-auto-gas)
-   ("haskell.plugin.tactics.globalOn" lsp-haskell-plugin-tactics-global-on t)
-   ("haskell.plugin.retrie.globalOn" lsp-haskell-plugin-retrie-global-on t)
-   ("haskell.plugin.class.globalOn" lsp-haskell-plugin-class-global-on t)
-   ("haskell.plugin.haddockComments.globalOn" lsp-haskell-plugin-haddock-comments-global-on t)
-   ("haskell.plugin.splice.globalOn" lsp-haskell-plugin-splice-global-on t)
-   ("haskell.plugin.moduleName.globalOn" lsp-haskell-plugin-module-name-global-on t)
-   ("haskell.plugin.eval.globalOn" lsp-haskell-plugin-eval-global-on t)
-   ("haskell.plugin.hlint.config.flags" lsp-haskell-plugin-hlint-config-flags)
-   ("haskell.plugin.hlint.diagnosticsOn" lsp-haskell-plugin-hlint-diagnostics-on t)
-   ("haskell.plugin.hlint.codeActionsOn" lsp-haskell-plugin-hlint-code-actions-on t)
-   ("haskell.plugin.importLens.codeLensOn" lsp-haskell-plugin-import-lens-code-lens-on t)
-   ("haskell.plugin.importLens.codeActionsOn" lsp-haskell-plugin-import-lens-code-actions-on t)
-   ("haskell.maxCompletions" lsp-haskell-max-completions)
-   ("haskell.checkProject" lsp-haskell-check-project t)
-   ("haskell.formattingProvider" lsp-haskell-formatting-provider)))
-
 ;; This mapping is set for 'haskell-mode -> haskell' in the lsp-mode repo itself. If we move
 ;; it there, then delete it from here.
 ;; It also isn't *too* important: it only sets the language ID, see
@@ -323,11 +318,13 @@ and `lsp-haskell-server-args' and `lsp-haskell-server-wrapper-function'."
     :major-modes '(haskell-mode haskell-literate-mode)
     ;; This is arbitrary.
     :server-id 'lsp-haskell
-    ;; We need to manually pull out the configuration section and set it. Possibly in
-    ;; the future lsp-mode will asssociate servers with configuration sections more directly.
+    ;; HLS does not currently send 'workspace/configuration' on startup (https://github.com/haskell/haskell-language-server/issues/2762), 
+    ;; so we need to push the configuration to it manually on startup. We should be able to
+    ;; get rid of this once the issue is fixed in HLS.
     :initialized-fn (lambda (workspace)
                       (with-lsp-workspace workspace
                         (lsp--set-configuration (lsp-configuration-section "haskell"))))
+    :synchronize-sections '("haskell")
     ;; This is somewhat irrelevant, but it is listed in lsp-language-id-configuration, so
     ;; we should set something consistent here.
     :language-id "haskell"