GNU bug report logs - #77948
Eglot: Allow other keys in window/logMessage

Previous Next

Full log

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Grégoire Duchêne <gduchene <at> awhk.org>
To: bug-gnu-emacs <at> gnu.org
Subject: Eglot: Allow other keys in window/logMessage
Date: Sun, 20 Apr 2025 20:00:51 +0100

[Message part 1 (text/plain, inline)]

Hello GNU Emacs folks!

I’ve recently noticed lots of error messages printed by Eglot when
working on a Swift project:

  Error running timer: (error "Keyword argument :logName not one of
  (:type :message)") [2 times]

After digging a little bit, I found out that SourceKit-LSP is now
sending window/logMessage messages with a ‘logName’ field set [0], which
is not defined in the LSP specification [1].

Since Eglot isn’t doing anything particular with those messages, I think
it would be reasonable to allow other keys in that message.

Here’s how to reproduce the issue:
  1. Install swift-mode.
  2. Configure Eglot to support SourceKit-LSP:
       (use-package eglot
         :config (add-to-list 'eglot-server-programs
                              '(swift-mode . ("sourcekit-lsp")))  
         :defer t)
  3. Create an empty Swift 6.1 project:
     - mkdir /tmp/EglotTest; cd /tmp/EglotTest
     - swift package init
  4. Open the Package.swift file, enable Eglot, and take a look at the
     messages buffer.

I’m attaching a patch that fixes the issue. Let me know what you think!


Thanks,
-- gregoire

[0]: https://github.com/swiftlang/sourcekit-lsp/blob/12dc0483e32378a2f3c5afcc8337bd977644f182/Sources/LanguageServerProtocol/Notifications/LogMessageNotification.swift#L27-L37
[1]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#window_logMessage

[0001-Eglot-Allow-other-keys-in-window-logMessage.patch (application/octet-stream, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.