Empty initializationOptions with 'remote' server.

[Isomorph70]

I am trying to set up the ltex-ls-plus language server, to
make it work as I like some extra options are needed, but I
having trouble tranfering them.

I have it running on my server named cyberty, and
I am trying to use it via TCPSocket from desktop developer machine using Emacs 29.4 and eglot.

The :initializationOptions don't seem to get transferred to the server.

My eglot ltex-lp-plus set up looks like this:

with-eval-after-load 'eglot
;; Add cyberty server for org-mode and text-mode
(add-to-list 'eglot-server-programs
'((org-mode text-mode)
. ("cyberty" 986
(:initializationOptions
(:ltex
(:additionalRules
(:motherTongue "da-DK"
:languageModel "/run/current-system/sw/share/ngrams"
:enablePickyRules t)))))))
)

EGLOT events buffer look like this:
[jsonrpc] D[22:37:46.707] Running language server: cyberty:986 [jsonrpc] e[22:37:46.708] --> initialize[1] {"jsonrpc":"2.0","id":1,"method":"initialize","params":{"processId":null,"clientInfo":{"name":"Eglot","version":"1.17"},"rootPath":"/home/shs/projekter/autosof/tests/","rootUri":"file:///home/shs/projekter/autosof/tests","initializationOptions":{},"capabilities":{"workspace":{"applyEdit":true,"executeCommand":{"dynamicRegistration":false},"workspaceEdit":{"documentChanges":true},"didChangeWatchedFiles":{"dynamicRegistration":true},"symbol":{"dynamicRegistration":false},"configuration":true,"workspaceFolders":true},"textDocument":{"synchronization":{"dynamicRegistration":false,"willSave":true,"willSaveWaitUntil":true,"didSave":true},"completion":{"dynamicRegistration":false,"completionItem":{"snippetSupport":false,"deprecatedSupport":true,"resolveSupport":{"properties":["documentation","details","additionalTextEdits"]},"tagSupport":{"valueSet":[1]}},"contextSupport":true},"hover":{"dynamicRegistration":false,"contentFormat":["markdown","plaintext"]},"signatureHelp":{"dynamicRegistration":false,"signatureInformation":{"parameterInformation":{"labelOffsetSupport":true},"documentationFormat":["markdown","plaintext"],"activeParameterSupport":true}},"references":{"dynamicRegistration":false},"definition":{"dynamicRegistration":false,"linkSupport":true},"declaration":{"dynamicRegistration":false,"linkSupport":true},"implementation":{"dynamicRegistration":false,"linkSupport":true},"typeDefinition":{"dynamicRegistration":false,"linkSupport":true},"documentSymbol":{"dynamicRegistration":false,"hierarchicalDocumentSymbolSupport":true,"symbolKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26]}},"documentHighlight":{"dynamicRegistration":false},"codeAction":{"dynamicRegistration":false,"resolveSupport":{"properties":["edit","command"]},"dataSupport":true,"codeActionLiteralSupport":{"codeActionKind":{"valueSet":["quickfix","refactor","refactor.extract","refactor.inline","refactor.rewrite","source","source.organizeImports"]}},"isPreferredSupport":true},"formatting":{"dynamicRegistration":false},"rangeFormatting":{"dynamicRegistration":false},"rename":{"dynamicRegistration":false},"inlayHint":{"dynamicRegistration":false},"publishDiagnostics":{"relatedInformation":false,"codeDescriptionSupport":false,"tagSupport":{"valueSet":[1,2]}}},"window":{"showDocument":{"support":true},"workDoneProgress":true},"general":{"positionEncodings":["utf-32","utf-8","utf-16"]},"experimental":{}},"workspaceFolders":[{"uri":"file:///home/shs/projekter/autosof/tests","name":"~/projekter/autosof/tests/"}]}} [jsonrpc] e[22:37:46.797] <-- initialize[1] {"jsonrpc":"2.0","id":1,"result":{"capabilities":{"textDocumentSync":1,"completionProvider":{},"codeActionProvider":{"codeActionKinds":["quickfix.ltex.acceptSuggestions"]},"executeCommandProvider":{"commands":["_ltex.checkDocument","_ltex.getServerStatus"]}}}} [jsonrpc] e[22:37:46.797] --> initialized {"jsonrpc":"2.0","method":"initialized","params":{}} [jsonrpc] e[22:37:46.798] --> textDocument/didOpen {"jsonrpc":"2.0","method":"textDocument/didOpen","params":{"textDocument":{"uri":"file:///home/shs/projekter/autosof/tests/ltex-eglot.org","version":0,"languageId":"org","text":"* Eglot tests.\n** Don’t forget to put on the breaks.\nThis error should be found by ngrams model.\n** This is an mistake.\n** The bananas is tasty.\n** We look forward to welcome you.\n** Are human beings any different than animals?\n"}}} [jsonrpc] e[22:37:46.799] --> workspace/didChangeConfiguration {"jsonrpc":"2.0","method":"workspace/didChangeConfiguration","params":{"settings":{}}} [jsonrpc] e[22:37:46.843] <-- window/workDoneProgress/create[1] {"jsonrpc":"2.0","id":"1","method":"window/workDoneProgress/create","params":{"token":"{\"uri\":\"file:///home/shs/projekter/autosof/tests/ltex-eglot.org\",\"operation\":\"checkDocument\",\"uuid\":\"df58f42f-b505-5b18-c678-4bb4baee4d4a\"}"}} [jsonrpc] e[22:37:46.843] --> window/workDoneProgress/create[1] {"jsonrpc":"2.0","id":"1","result":null} [jsonrpc] e[22:37:46.889] <-- $/progress {"jsonrpc":"2.0","method":"$/progress","params":{"token":"{\"uri\":\"file:///home/shs/projekter/autosof/tests/ltex-eglot.org\",\"operation\":\"checkDocument\",\"uuid\":\"df58f42f-b505-5b18-c678-4bb4baee4d4a\"}","value":{"kind":"end"}}} [jsonrpc] e[22:37:46.889] <-- window/workDoneProgress/create[2] {"jsonrpc":"2.0","id":"2","method":"window/workDoneProgress/create","params":{"token":"{\"uri\":\"file:///home/shs/projekter/autosof/tests/ltex-eglot.org\",\"operation\":\"checkDocument\",\"uuid\":\"695978c9-519b-ea5a-7ee2-c290a0fca77c\"}"}} [jsonrpc] e[22:37:46.889] --> window/workDoneProgress/create[2] {"jsonrpc":"2.0","id":"2","result":null} [jsonrpc] e[22:37:46.932] <-- $/progress {"jsonrpc":"2.0","method":"$/progress","params":{"token":"{\"uri\":\"file:///home/shs/projekter/autosof/tests/ltex-eglot.org\",\"operation\":\"checkDocument\",\"uuid\":\"695978c9-519b-ea5a-7ee2-c290a0fca77c\"}","value":{"kind":"begin","title":"Checking document","cancellable":false,"message":"file:///home/shs/projekter/autosof/tests/ltex-eglot.org"}}} [jsonrpc] e[22:37:46.932] <-- workspace/configuration[3] {"jsonrpc":"2.0","id":"3","method":"workspace/configuration","params":{"items":[{"scopeUri":"file:///home/shs/projekter/autosof/tests/ltex-eglot.org","section":"ltex"}]}} [jsonrpc] e[22:37:46.932] --> workspace/configuration[3] {"jsonrpc":"2.0","id":"3","result":[null]} [jsonrpc] e[22:37:47.203] <-- $/progress {"jsonrpc":"2.0","method":"$/progress","params":{"token":"{\"uri\":\"file:///home/shs/projekter/autosof/tests/ltex-eglot.org\",\"operation\":\"checkDocument\",\"uuid\":\"695978c9-519b-ea5a-7ee2-c290a0fca77c\"}","value":{"kind":"end"}}} [jsonrpc] e[22:37:47.205] <-- textDocument/publishDiagnostics {"jsonrpc":"2.0","method":"textDocument/publishDiagnostics","params":{"uri":"file:///home/shs/projekter/autosof/tests/ltex-eglot.org","diagnostics":[{"range":{"start":{"line":0,"character":2},"end":{"line":0,"character":7}},"severity":3,"code":"MORFOLOGIK_RULE_EN_US","codeDescription":{"href":"https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang\u003den-US"},"source":"LTeX","message":"\u0027Eglot\u0027: Possible spelling mistake found."},{"range":{"start":{"line":2,"character":30},"end":{"line":2,"character":36}},"severity":3,"code":"MORFOLOGIK_RULE_EN_US","codeDescription":{"href":"https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang\u003den-US"},"source":"LTeX","message":"\u0027ngrams\u0027: Possible spelling mistake found."},{"range":{"start":{"line":3,"character":11},"end":{"line":3,"character":13}},"severity":3,"code":"EN_A_VS_AN","codeDescription":{"href":"https://community.languagetool.org/rule/show/EN_A_VS_AN?lang\u003den-US"},"source":"LTeX","message":"Use \u0027a\u0027 instead of \u0027an\u0027 if the following word doesn\u0027t start with a vowel sound, e.g. \u0027a sentence\u0027, \u0027a university\u0027."},{"range":{"start":{"line":4,"character":15},"end":{"line":4,"character":17}},"severity":3,"code":"AGREEMENT_SENT_START","codeDescription":{"href":"https://community.languagetool.org/rule/show/AGREEMENT_SENT_START?lang\u003den-US"},"source":"LTeX","message":"You should probably use: \u0027are\u0027."},{"range":{"start":{"line":5,"character":19},"end":{"line":5,"character":29}},"severity":3,"code":"ADMIT_ENJOY_VB","codeDescription":{"href":"https://community.languagetool.org/rule/show/ADMIT_ENJOY_VB?lang\u003den-US"},"source":"LTeX","message":"In the grammatical structure \u0027look + forward + to + verb\u0027, the verb \u0027to\u0027 is used with the gerund."},{"range":{"start":{"line":6,"character":34},"end":{"line":6,"character":38}},"severity":3,"code":"DIFFERENT_THAN","codeDescription":{"href":"https://community.languagetool.org/rule/show/DIFFERENT_THAN?lang\u003den-US"},"source":"LTeX","message":"Did you mean \u0027different from\u0027? \u0027Different than\u0027 is often considered colloquial style."}]}}

[joaotavora]

I'm not sure :initializationOptions is supported with the host/port combinations. This might be a bug... And one that is not probably not easy to fix...

Anyway, you should be using this syntax:

(add-to-list 'eglot-server-programs
             '((text-mode org-mode)
               . ("cyberty" 986
                  :initializationOptions
                  (:ltex
                   (:additionalRules
                    (:motherTongue "da-DK"
                                   :languageModel "/run/current-system/sw/share/ngrams"
                                   :enablePickyRules t))))))

And please try with this patch applied to eglot.elL

diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index d69019a8bd7..6a39df7e848 100644
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -1567,11 +1567,14 @@ eglot--connect
                 ((integerp (cadr contact))
                  (setq server-info (list (format "%s:%s" (car contact)
                                                  (cadr contact))))
-                 `(:process ,(lambda ()
-                               (apply #'open-network-stream
-                                      readable-name nil
-                                      (car contact) (cadr contact)
-                                      (cddr contact)))))
+                 (list :process (lambda ()
+                                  (apply #'open-network-stream
+                                         readable-name nil
+                                         (car contact) (cadr contact)
+                                         (cddr contact)))
+                       :initializationOptions
+                       (plist-get (cddr contact)
+                                  :initializationOptions)))
                 ((and (stringp (car contact))
                       (cl-find-if (lambda (x)
                                     (or (eq x :autoport)

If this doesn't work (I didn't test it), then I have to see what I can do. You can always write a special class yourself that will work regardless, but doing so is not trivial, and I'd probably have to help you.

[Isomorph70]

I'm trying to use a modified version of Eglot in Emacs, but I’m running into issues where the system-installed version keeps loading instead. Here’s what I’ve done so far:

Copied and modified eglot.el.
Added my modified version to load-path before the system path:

(add-to-list 'load-path "~/.emacs.d/eglot" t)
(require 'eglot)

1. Verified that load-path correctly lists my modified version before the system-installed one.
   

2. Used (setq package-load-list '((eglot nil) (all))) to prevent the system package from loading.
   

3. Checked M-x find-library eglot, but it still opens the system version instead of my modified one.

How can I ensure that Emacs loads my modified version of Eglot instead of the system-installed one? Is there an internal mechanism in Eglot or Emacs that might be overriding my load-path settings?

Thanks for your help!

[joaotavora]

Use load, not require if you want to be sure. Probably you're requiring eglot in a complex configuration, maybe some use-package doing it behind your back (did I mention I hate use-package?). But use simply (load "filename to patched eglot") and you should be fine.