Merge pull request #38 from tarides/pre-release-1.1.0

Pre release 1.1.0

Author: xvw

CHANGES.md

@@ -1,5 +1,6 @@
-ocaml-eglot unreleased
+ocaml-eglot 1.1.0
 ======================
+Fri Mar 28 01:27:46 PM CET 2025
 
 - A first support for `flycheck` ([#29](https://github.com/tarides/ocaml-eglot/pull/29), [#33](https://github.com/tarides/ocaml-eglot/pull/33) and [#37](https://github.com/tarides/ocaml-eglot/pull/37))
 - Use a more efficient way to ensure that a vector is empty ([#27](https://github.com/tarides/ocaml-eglot/pull/27))

README.md

@@ -57,6 +57,7 @@ Eglot provides a hook to format the buffer on saving:
    :hook
    (tuareg-mode . ocaml-eglot)
 -  (ocaml-eglot . eglot-ensure))
++  (ocaml-eglot . eglot-ensure)
 +  (ocaml-eglot . (lambda () 
 +                   (add-hook #'before-save-hook #'eglot-format nil t))))
 ```
@@ -80,11 +81,34 @@ configuration in this way:
    :hook
    (tuareg-mode . ocaml-eglot)
 -  (ocaml-eglot . eglot-ensure))
++  (ocaml-eglot . eglot-ensure)
 +  (ocaml-eglot . (lambda () (flycheck-eglot-mode 1)))
 +  :config
 +  (setq ocaml-eglot-syntax-checker 'flycheck))
 ```
 
+### Using Merlin-configuration
+
+OCaml-lsp-server can use `.merlin` as a configuration template (rather
+than configuring via `dune`). This requires the
+[`dot-merlin-reader`](https://ocaml.org/p/dot-merlin-reader/latest)
+package to be installed in the switch being used, and `eglot` can be
+configured in this way:
+
+```diff
+ (use-package ocaml-eglot
+   :ensure t
+   :after tuareg
+   :hook
+   (tuareg-mode . ocaml-eglot)
+-  (ocaml-eglot . eglot-ensure))
++  (ocaml-eglot . eglot-ensure)
++  :config
++  (with-eval-after-load 'eglot
++    (add-to-list 'eglot-server-programs
++                 '(tuareg-mode . ("ocamllsp" "--fallback-read-dot-merlin")))))
+```
+
 ## Features
 
 ### Browsing errors

ocaml-eglot.el

@@ -13,7 +13,7 @@
 ;; Keywords: ocaml languages
 ;; URL: https://github.com/tarides/ocaml-eglot
 ;; Package-Requires: ((emacs "29.1"))
-;; Package-Version: 1.0
+;; Package-Version: 1.1
 ;; SPDX-License-Identifier: MIT
 
 ;;; Commentary: