When auto-configure is enabled, remove hooks for disabled options (#3078)

* When auto-configure is enabled, remove hooks for disabled options

When `lsp-auto-configure' is enabled, hooks are automatically added to
`lsp-configure-hook' for any options which are enabled.  However, if any
of those options are later disabled, the hooks were not removed from
`lsp-configure-hook`; therefore the corresponding behaviour did not
get disabled.

So add the relevant `remove-hook' calls when options are not enabled.

Partial fix for #2525.

* Call lsp--auto-configure from lsp-configure-buffer

Currently `lsp' is the only thing calling `lsp--auto-configure', which
means that auto-configuration only activates when `lsp-mode' called,
rather than when a buffer needs to be configured.

If we consider the following flow:

1. An option `lsp-headerline-breadcrumb-enable' (say) is set to `t'.
2. `lsp-mode` is called, triggering `lsp--auto-configure', which in
   turn executes:

     (add-hook 'lsp-configure-hook 'lsp-headerline-breadcrumb-mode)
3. `lsp-headerline-breadcrumb-enable' is set to `nil'.
4. Another buffer is opened.
5. At this point, `lsp-headerline-breadcrumb-mode' is still in
   `lsp-configure-hook', therefore, the breadcrumb headerline will be
   activated even though the option is disabled.  Clearly this is
   undesirable, as reported in #2525.

So call `lsp--auto-configure` from `lsp-configure-buffer', so that
any hooks which need to be removed will get removed.

Fixes #2525.

Author: aspiers

lsp-mode.el

@@ -4050,6 +4050,8 @@ yet."
                                  (lsp--cur-workspace (list lsp--cur-workspace))))
         lsp--cur-workspace)
     (when lsp-auto-configure
+      (lsp--auto-configure)
+
       (when (and lsp-enable-text-document-color
                  (lsp-feature? "textDocument/documentColor"))
         (add-hook 'lsp-on-change-hook #'lsp--document-color nil t))
@@ -7369,18 +7371,24 @@ returns the command to execute."
   (when (functionp 'lsp-ui-mode)
     (lsp-ui-mode))
 
-  (when lsp-headerline-breadcrumb-enable
-    (add-hook 'lsp-configure-hook 'lsp-headerline-breadcrumb-mode))
-  (when lsp-modeline-code-actions-enable
-    (add-hook 'lsp-configure-hook 'lsp-modeline-code-actions-mode))
-  (when lsp-modeline-diagnostics-enable
-    (add-hook 'lsp-configure-hook 'lsp-modeline-diagnostics-mode))
-  (when lsp-modeline-workspace-status-enable
-    (add-hook 'lsp-configure-hook 'lsp-modeline-workspace-status-mode))
-  (when lsp-lens-enable
-    (add-hook 'lsp-configure-hook 'lsp-lens--enable))
-  (when lsp-semantic-tokens-enable
-    (add-hook 'lsp-configure-hook 'lsp-semantic-tokens--enable))
+  (if lsp-headerline-breadcrumb-enable
+      (add-hook 'lsp-configure-hook 'lsp-headerline-breadcrumb-mode)
+    (remove-hook 'lsp-configure-hook 'lsp-headerline-breadcrumb-mode))
+  (if lsp-modeline-code-actions-enable
+      (add-hook 'lsp-configure-hook 'lsp-modeline-code-actions-mode)
+    (remove-hook 'lsp-configure-hook 'lsp-modeline-code-actions-mode))
+  (if lsp-modeline-diagnostics-enable
+      (add-hook 'lsp-configure-hook 'lsp-modeline-diagnostics-mode)
+    (remove-hook 'lsp-configure-hook 'lsp-modeline-diagnostics-mode))
+  (if lsp-modeline-workspace-status-enable
+      (add-hook 'lsp-configure-hook 'lsp-modeline-workspace-status-mode)
+    (remove-hook 'lsp-configure-hook 'lsp-modeline-workspace-status-mode))
+  (if lsp-lens-enable
+      (add-hook 'lsp-configure-hook 'lsp-lens--enable)
+    (remove-hook 'lsp-configure-hook 'lsp-lens--enable))
+  (if lsp-semantic-tokens-enable
+      (add-hook 'lsp-configure-hook 'lsp-semantic-tokens--enable)
+    (remove-hook 'lsp-configure-hook 'lsp-semantic-tokens--enable))
 
   ;; yas-snippet config
   (setq-local yas-inhibit-overlay-modification-protection t))