Eglot apparently produces much less rich completions than lsp-mode with zls?

[notcancername]

Hello everyone,
I am attempting to use eglot as a LSP client. It seems to work well, however, when using it with ZLS for Zig, it seemingly produces significantly worse completions with company-mode and doesn't seem to use yas at all. I enabled them before enabling eglot.

Eglot:

lsp-mode:

ElDoc works well.

I'm using GNU Emacs 28.2 (build 3, x86_64-pc-linux-gnu, X toolkit, cairo version 1.16.0, Xaw scroll bars) of 2023-03-14.

Surely I am doing something wrong here? If anyone could give me some pointers as to what might cause this, I would much appreciate it.

[joaotavora]

What is the version of Eglot you're using and how did you install it? Could be that the Zig language server doesn't provide these rich completions by default, and needs some configuration.

[joaotavora]

So I installed the community/zig package in my Arch linux system and the zls package from AUR (https://aur.archlinux.org/packages/zls-bin).

Then I make sure I install company-mode, zig-mode, and eglot with M-x package-install. Finally

emacs -Q -f package-initialize ~/tmp/thingy.zip -f global-company-mode -f eglot

[notcancername]

Huh. I'm really sorry, I have no clue why.

[joaotavora]

As to why zls is not providing snippets, I don't know. If yasnippet is installed (and enabled!) Eglot reports that snippets are supported, so
the server may send them. But it's not sending them.

(tangent: In the upcoming version of Eglot that you may try on Emacs master branch, the mere presence of the yasnippet package will suffice to support snippets)

Zls is also warning me that zls and zig don't quite match up (I did this in a rush).

If lsp-mode gives you snippets, what may help here is an event transcript from the lsp-mode <-> zls session.

[joaotavora]

Huh. I'm really sorry, I have no clue why.

Until relatively recently, Eglot did have that problem where in some cases, the "poor" description of a completion was shown instead of the rich one. But that is fixed in 1.13 as I have verified. So maybe you have an old version of Eglot lying around installed by some other means? Do the emacs -Q test.

[notcancername]

Hey, I just noticed in the event log:

[stderr] info : (server): zls initializing
[stderr] info : (server): Server.ClientCapabilities{ .supports_snippets = true, .supports_apply_edits = true, .supports_will_save = true, .supports_will_save_wait_until = true, .supports_publish_diagnostics = true, .supports_code_action_fixall = false, .hover_supports_md = true, .completion_doc_supports_md = false, .label_details_support = false, .supports_configuration = true, .supports_workspace_did_change_configuration_dynamic_registration = false }
[stderr] info : (server): Using offset encoding: utf-8
[stderr] debug: (server): Took 1ms to process method initialize
[stderr] debug: (server): Took 0ms to process method initialized
[stderr] debug: (store ): Opened document `file:///home/user/src/random/text.zig`
[stderr] debug: (server): Took 2ms to process method textDocument/didOpen
[stderr] debug: (server): setting configuration option 'enable_snippets' to 'false'
[stderr] debug: (server): setting configuration option 'enable_ast_check_diagnostics' to 'false'
[stderr] debug: (server): setting configuration option 'enable_autofix' to 'false'
[stderr] debug: (server): setting configuration option 'enable_import_embedfile_argument_completions' to 'false'
[stderr] debug: (server): setting configuration option 'enable_semantic_tokens' to 'false'
[stderr] debug: (server): setting configuration option 'enable_inlay_hints' to 'false'
[stderr] debug: (server): setting configuration option 'inlay_hints_show_builtin' to 'false'
[stderr] debug: (server): setting configuration option 'inlay_hints_exclude_single_argument' to 'false'
[stderr] debug: (server): setting configuration option 'operator_completions' to 'false'
[stderr] debug: (server): setting configuration option 'max_detail_length' to '0'
[stderr] info : (config): Using zig executable /usr/local/bin/zig
[stderr] info : (config): Using zig lib path '/home/user/Downloads/zig-linux-x86_64-0.11.0-dev.2336+5b82b4004/lib'
[stderr] info : (config): Using build runner global cache path '/home/user/.cache/zig'
[stderr] info : (config): Detected runtime zig version: '0.11.0-dev.2336+5b82b4004'
[stderr] debug: (server): Took 10ms to process method workspace/didChangeConfiguration
[stderr] info : (server): Setting configuration...
[stderr] debug: (server): Server.ClientCapabilities{ .supports_snippets = true, .supports_apply_edits = true, .supports_will_save = true, .supports_will_save_wait_until = true, .supports_publish_diagnostics = true, .supports_code_action_fixall = false, .hover_supports_md = true, .completion_doc_supports_md = false, .label_details_support = false, .supports_configuration = true, .supports_workspace_did_change_configuration_dynamic_registration = false }
[stderr] info : (config): Using zig executable /usr/local/bin/zig
[stderr] info : (config): Using zig lib path '/home/user/Downloads/zig-linux-x86_64-0.11.0-dev.2336+5b82b4004/lib'
[stderr] info : (config): Using build runner global cache path '/home/user/.cache/zig'
[stderr] info : (config): Detected runtime zig version: '0.11.0-dev.2336+5b82b4004'

So it seems something is causing ZLS to disable these features? Would you mind sharing your event log?

[joaotavora]

Here's my event log

[internal] Sun Apr  2 01:57:41 2023:
(:message "Running language server: zls")
[client-request] (id:1) Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :id 1 :method "initialize" :params
	  (:processId 9680 :rootPath "/home/capitaomorte/tmp/" :rootUri "file:///home/capitaomorte/tmp" :initializationOptions #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data
																	     ())
		      :capabilities
		      (:workspace
		       (:applyEdit t :executeCommand
				   (:dynamicRegistration :json-false)
				   :workspaceEdit
				   (:documentChanges t)
				   :didChangeWatchedFiles
				   (:dynamicRegistration t)
				   :symbol
				   (:dynamicRegistration :json-false)
				   :configuration t :workspaceFolders t)
		       :textDocument
		       (:synchronization
			(:dynamicRegistration :json-false :willSave t :willSaveWaitUntil t :didSave t)
			:completion
			(:dynamicRegistration :json-false :completionItem
					      (:snippetSupport t :deprecatedSupport t :resolveSupport
							       (:properties
								["documentation" "details" "additionalTextEdits"])
							       :tagSupport
							       (:valueSet
								[1]))
					      :contextSupport t)
			:hover
			(:dynamicRegistration :json-false :contentFormat
					      ["markdown" "plaintext"])
			:signatureHelp
			(:dynamicRegistration :json-false :signatureInformation
					      (:parameterInformation
					       (:labelOffsetSupport t)
					       :activeParameterSupport t))
			:references
			(:dynamicRegistration :json-false)
			:definition
			(:dynamicRegistration :json-false :linkSupport t)
			:declaration
			(:dynamicRegistration :json-false :linkSupport t)
			:implementation
			(:dynamicRegistration :json-false :linkSupport t)
			:typeDefinition
			(:dynamicRegistration :json-false :linkSupport t)
			:documentSymbol
			(:dynamicRegistration :json-false :hierarchicalDocumentSymbolSupport t :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 :json-false)
			:codeAction
			(:dynamicRegistration :json-false :codeActionLiteralSupport
					      (:codeActionKind
					       (:valueSet
						["quickfix" "refactor" "refactor.extract" "refactor.inline" "refactor.rewrite" "source" "source.organizeImports"]))
					      :isPreferredSupport t)
			:formatting
			(:dynamicRegistration :json-false)
			:rangeFormatting
			(:dynamicRegistration :json-false)
			:rename
			(:dynamicRegistration :json-false)
			:inlayHint
			(:dynamicRegistration :json-false)
			:publishDiagnostics
			(:relatedInformation :json-false :codeDescriptionSupport :json-false :tagSupport
					     (:valueSet
					      [1 2])))
		       :general
		       (:positionEncodings
			["utf-32" "utf-8" "utf-16"])
		       :experimental #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data
						   ()))
		      :workspaceFolders
		      [(:uri "file:///home/capitaomorte/tmp" :name "~/tmp/")]))
[stderr] info : ( main ): No config file zls.json found.
[stderr] info : (config): Using zig executable /usr/bin/zig
[stderr] info : (config): Using zig lib path '/usr/lib/zig'
[server-reply] (id:1) Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :id 1 :result
	  (:capabilities
	   (:positionEncoding "utf-8" :signatureHelpProvider
			      (:triggerCharacters
			       ["("]
			       :retriggerCharacters
			       [","])
			      :textDocumentSync
			      (:openClose t :change 1 :save t)
			      :renameProvider t :completionProvider
			      (:resolveProvider :json-false :triggerCharacters
						["." ":" "@" "]"]
						:completionItem
						(:labelDetailsSupport t))
			      :documentHighlightProvider t :hoverProvider t :codeActionProvider t :declarationProvider t :definitionProvider t :typeDefinitionProvider t :implementationProvider :json-false :referencesProvider t :documentSymbolProvider t :colorProvider :json-false :documentFormattingProvider t :documentRangeFormattingProvider :json-false :foldingRangeProvider t :selectionRangeProvider :json-false :workspaceSymbolProvider :json-false :rangeProvider :json-false :documentProvider t :workspace
			      (:workspaceFolders
			       (:supported :json-false :changeNotifications :json-false))
			      :semanticTokensProvider
			      (:full t :range :json-false :legend
				     (:tokenTypes
				      ["type" "parameter" "variable" "enumMember" "field" "errorTag" "function" "keyword" "comment" "string" "number" "operator" "builtin" "label" "keywordLiteral"]
				      :tokenModifiers
				      ["namespace" "struct" "enum" "union" "opaque" "declaration" "async" "documentation" "generic"]))
			      :inlayHintProvider t)
	   :serverInfo
	   (:name "zls" :version "0.1.0")))
[client-notification] Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :method "initialized" :params #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data
							    ()))
[client-notification] Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :method "textDocument/didOpen" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig" :version 0 :languageId "zig" :text "const std = @import(\"std\");\n\npub fn main() !void {\n    std.ArrayList\n    const stdout = std.io.getStdOut().writer();\n    try stdout.print(\"Hello, world!\\n\");\n}\n")))
[client-notification] Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :method "workspace/didChangeConfiguration" :params
	  (:settings #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data
				   ())))
[client-request] (id:2) Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :id 2 :method "textDocument/inlayHint" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :range
	   (:start
	    (:line 0 :character 0)
	    :end
	    (:line 7 :character 0))))
[stderr] info : (server): zls initializing
[stderr] info : (server): Server.ClientCapabilities{ .supports_snippets = true, .supports_semantic_tokens = false, .supports_inlay_hints = true, .hover_supports_md = true, .completion_doc_supports_md = false, .label_details_support = false, .supports_configuration = true }
[stderr] info : (server): Using offset encoding: utf8
[server-notification] Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :method "window/showMessage" :params
	  (:type 2 :message "ZLS has been build with a newer version than you are using!\nThis may cause unexpected issues."))
[server-request] (id:i_haz_configuration) Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :id "i_haz_configuration" :method "workspace/configuration" :params
	  (:items
	   [(:section "zls.enable_snippets")
	    (:section "zls.enable_ast_check_diagnostics")
	    (:section "zls.enable_autofix")
	    (:section "zls.enable_import_embedfile_argument_completions")
	    (:section "zls.zig_lib_path")
	    (:section "zls.zig_exe_path")
	    (:section "zls.warn_style")
	    (:section "zls.build_runner_path")
	    (:section "zls.global_cache_path")
	    (:section "zls.enable_semantic_tokens")
	    (:section "zls.enable_inlay_hints")
	    (:section "zls.inlay_hints_show_builtin")
	    (:section "zls.inlay_hints_exclude_single_argument")
	    (:section "zls.inlay_hints_hide_redundant_param_names")
	    (:section "zls.inlay_hints_hide_redundant_param_names_last_token")
	    (:section "zls.operator_completions")
	    (:section "zls.include_at_in_builtins")
	    (:section "zls.max_detail_length")
	    (:section "zls.skip_std_references")
	    (:section "zls.builtin_path")
	    (:section "zls.highlight_global_var_declarations")]))
[client-reply] (id:i_haz_configuration) Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :id "i_haz_configuration" :result
	  [nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil])
[server-notification] Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :method "textDocument/publishDiagnostics" :params
	  (:uri "file:///home/capitaomorte/tmp/hello.zig" :diagnostics
		[(:range
		  (:start
		   (:line 3 :character 8)
		   :end
		   (:line 3 :character 17))
		  :severity 1 :code "expected_semi_after_stmt" :source "zls" :message "expected ';' after statement" :relatedInformation nil)]))
[server-request] (id:i_haz_configuration) Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :id "i_haz_configuration" :method "workspace/configuration" :params
	  (:items
	   [(:section "zls.enable_snippets")
	    (:section "zls.enable_ast_check_diagnostics")
	    (:section "zls.enable_autofix")
	    (:section "zls.enable_import_embedfile_argument_completions")
	    (:section "zls.zig_lib_path")
	    (:section "zls.zig_exe_path")
	    (:section "zls.warn_style")
	    (:section "zls.build_runner_path")
	    (:section "zls.global_cache_path")
	    (:section "zls.enable_semantic_tokens")
	    (:section "zls.enable_inlay_hints")
	    (:section "zls.inlay_hints_show_builtin")
	    (:section "zls.inlay_hints_exclude_single_argument")
	    (:section "zls.inlay_hints_hide_redundant_param_names")
	    (:section "zls.inlay_hints_hide_redundant_param_names_last_token")
	    (:section "zls.operator_completions")
	    (:section "zls.include_at_in_builtins")
	    (:section "zls.max_detail_length")
	    (:section "zls.skip_std_references")
	    (:section "zls.builtin_path")
	    (:section "zls.highlight_global_var_declarations")]))
[client-reply] (id:i_haz_configuration) Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :id "i_haz_configuration" :result
	  [nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil])
[server-reply] (id:2) Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :id 2 :result nil)
[stderr] info : (server): Setting configuration...
[stderr] info : (config): Using zig executable /usr/bin/zig
[stderr] info : (server): Setting configuration...
[stderr] info : (config): Using zig executable /usr/bin/zig
[client-request] (id:3) Sun Apr  2 01:57:42 2023:
(:jsonrpc "2.0" :id 3 :method "textDocument/signatureHelp" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 3 :character 17)))
[client-request] (id:4) Sun Apr  2 01:57:42 2023:
(:jsonrpc "2.0" :id 4 :method "textDocument/hover" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 3 :character 17)))
[client-request] (id:5) Sun Apr  2 01:57:42 2023:
(:jsonrpc "2.0" :id 5 :method "textDocument/documentHighlight" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 3 :character 17)))
[server-reply] (id:3) Sun Apr  2 01:57:42 2023:
(:jsonrpc "2.0" :id 3 :result
	  (:signatures
	   []))
[server-reply] (id:4) Sun Apr  2 01:57:42 2023:
(:jsonrpc "2.0" :id 4 :result
	  (:contents
	   (:kind "markdown" :value "```zig\nfn ArrayList(comptime T: type) type\n```\n```zig\n(fn)\n```\nA contiguous, growable list of items in memory.  \nThis is a wrapper around an array of T values. Initialize with `init`.  \n  \nThis struct internally stores a `std.mem.Allocator` for memory management.  \nTo manually specify an allocator with each method call see `ArrayListUnmanaged`.")))
[server-reply] (id:5) Sun Apr  2 01:57:42 2023:
(:jsonrpc "2.0" :id 5 :result
	  [])
[client-request] (id:6) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 6 :method "textDocument/signatureHelp" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 5 :character 0)))
[client-request] (id:7) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 7 :method "textDocument/hover" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 5 :character 0)))
[client-request] (id:8) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 8 :method "textDocument/documentHighlight" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 5 :character 0)))
[server-reply] (id:6) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 6 :result
	  (:signatures
	   []))
[server-reply] (id:7) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 7 :result nil)
[server-reply] (id:8) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 8 :result nil)
[client-notification] Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :method "textDocument/didChange" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig" :version 2)
	   :contentChanges
	   [(:text "const std = @import(\"std\");\n\npub fn main() !void {\n    std.ArrayList\n    const stdout = std.io.getStdOut().writer();\n      try stdout.print(\"Hello, world!\\n\");\n}\n")]))
[client-request] (id:9) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 9 :method "textDocument/signatureHelp" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 5 :character 2)))
[client-request] (id:10) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 10 :method "textDocument/hover" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 5 :character 2)))
[client-request] (id:11) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 11 :method "textDocument/documentHighlight" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 5 :character 2)))
[client-request] (id:12) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 12 :method "textDocument/inlayHint" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :range
	   (:start
	    (:line 5 :character 0)
	    :end
	    (:line 7 :character 0))))
[server-notification] Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :method "textDocument/publishDiagnostics" :params
	  (:uri "file:///home/capitaomorte/tmp/hello.zig" :diagnostics
		[(:range
		  (:start
		   (:line 3 :character 8)
		   :end
		   (:line 3 :character 17))
		  :severity 1 :code "expected_semi_after_stmt" :source "zls" :message "expected ';' after statement" :relatedInformation nil)]))
[server-reply] (id:9) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 9 :result
	  (:signatures
	   []))
[server-reply] (id:10) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 10 :result nil)
[server-reply] (id:11) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 11 :result nil)
[server-reply] (id:12) Sun Apr  2 01:58:20 2023:
(:jsonrpc "2.0" :id 12 :result nil)
[client-notification] Sun Apr  2 01:58:23 2023:
(:jsonrpc "2.0" :method "textDocument/didChange" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig" :version 4)
	   :contentChanges
	   [(:text "const std = @import(\"std\");\n\npub fn main() !void {\n    std.ArrayList\n    const stdout = std.io.getStdOut().writer();\n    try stdout.print(\"Hello, world!\\n\");\n}\n")]))
[client-request] (id:13) Sun Apr  2 01:58:23 2023:
(:jsonrpc "2.0" :id 13 :method "textDocument/signatureHelp" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 5 :character 2)))
[client-request] (id:14) Sun Apr  2 01:58:23 2023:
(:jsonrpc "2.0" :id 14 :method "textDocument/hover" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 5 :character 2)))
[client-request] (id:15) Sun Apr  2 01:58:23 2023:
(:jsonrpc "2.0" :id 15 :method "textDocument/documentHighlight" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :position
	   (:line 5 :character 2)))
[client-request] (id:16) Sun Apr  2 01:58:23 2023:
(:jsonrpc "2.0" :id 16 :method "textDocument/inlayHint" :params
	  (:textDocument
	   (:uri "file:///home/capitaomorte/tmp/hello.zig")
	   :range
	   (:start
	    (:line 5 :character 0)
	    :end
	    (:line 7 :character 0))))
[server-notification] Sun Apr  2 01:58:23 2023:
(:jsonrpc "2.0" :method "textDocument/publishDiagnostics" :params
	  (:uri "file:///home/capitaomorte/tmp/hello.zig" :diagnostics
		[(:range
		  (:start
		   (:line 3 :character 8)
		   :end
		   (:line 3 :character 17))
		  :severity 1 :code "expected_semi_after_stmt" :source "zls" :message "expected ';' after statement" :relatedInformation nil)]))
[server-reply] (id:13) Sun Apr  2 01:58:23 2023:
(:jsonrpc "2.0" :id 13 :result
	  (:signatures
	   []))
[server-reply] (id:14) Sun Apr  2 01:58:23 2023:
(:jsonrpc "2.0" :id 14 :result nil)
[server-reply] (id:15) Sun Apr  2 01:58:23 2023:
(:jsonrpc "2.0" :id 15 :result nil)
[server-reply] (id:16) Sun Apr  2 01:58:23 2023:
(:jsonrpc "2.0" :id 16 :result nil)

[joaotavora]

There's some strange stuff going on here:

[server-request] (id:i_haz_configuration) Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :id "i_haz_configuration" :method "workspace/configuration" :params
	  (:items
	   [(:section "zls.enable_snippets")
	    (:section "zls.enable_ast_check_diagnostics")
	    (:section "zls.enable_autofix")
	    (:section "zls.enable_import_embedfile_argument_completions")
	    (:section "zls.zig_lib_path")
	    (:section "zls.zig_exe_path")
	    (:section "zls.warn_style")
	    (:section "zls.build_runner_path")
	    (:section "zls.global_cache_path")
	    (:section "zls.enable_semantic_tokens")
	    (:section "zls.enable_inlay_hints")
	    (:section "zls.inlay_hints_show_builtin")
	    (:section "zls.inlay_hints_exclude_single_argument")
	    (:section "zls.inlay_hints_hide_redundant_param_names")
	    (:section "zls.inlay_hints_hide_redundant_param_names_last_token")
	    (:section "zls.operator_completions")
	    (:section "zls.include_at_in_builtins")
	    (:section "zls.max_detail_length")
	    (:section "zls.skip_std_references")
	    (:section "zls.builtin_path")
	    (:section "zls.highlight_global_var_declarations")]))
[client-reply] (id:i_haz_configuration) Sun Apr  2 01:57:41 2023:
(:jsonrpc "2.0" :id "i_haz_configuration" :result
	  [nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil])

I've never seen this. i_haz_configuration? What a cool kid this zig guy is. And why is Eglot taking issue and replying with all nils anyway? I guess because it doesn't have anything to answer with.

[joaotavora]

The nil's are correct, since they translate to null.

[notcancername]

emacs -Q gives the same result, unfortunately:

[joaotavora]

You can't have typed just emacs -Q and did nothing else. Show what you did. Start with the emacs -Q -f package-initialize thingy.zig -f global-company-mode -f yas-global-mode -f eglot that I suggested.

[notcancername]

My bad, I'm not an experienced user.
emacs -Q -f package-initialize ~/src/random/text.zig -f global-company-mode -f yas-global-mode -f eglot gives
(the different colors are due to corfu and company)

[joaotavora]

Yes, stick with company, corfu is problematic with Eglot and will not provide accurate completions unless you do some extra tricks. Now can you C-h f eglot RET C-x o TAB RET and show me the header of the file where that lands you?

[joaotavora]

Also show the output of zls --version.

Mine is: 0.10.0-dev.364+7ef2244

I suspect yours is different because the default level of verbosity in your event logs is also different.

[notcancername]

;;; eglot.el --- The Emacs Client for LSP servers  -*- lexical-binding: t; -*-

;; Copyright (C) 2018-2023 Free Software Foundation, Inc.

;; Version: 1.13
;; Author: João Távora <joaotavora@gmail.com>
;; Maintainer: João Távora <joaotavora@gmail.com>
;; URL: https://github.com/joaotavora/eglot
;; Keywords: convenience, languages
;; Package-Requires: ((emacs "26.3") (jsonrpc "1.0.16") (flymake "1.2.1") (project "0.9.8") (xref "1.6.2") (eldoc "1.11.0") (seq "2.23") (external-completion "0.1"))

;; This is a GNU ELPA :core package.  Avoid adding functionality
;; that is not available in the version of Emacs recorded above or any
;; of the package dependencies.

;; This file is part of GNU Emacs.

[notcancername]

Mine is 0.11.0-dev.324+c2d15bf, it's from git.

[joaotavora]

How did you find it?

Debugging zig code in zls, pretending I knew what I was doing. Eglot helped, actually :-)

So what's happening is that zls's reaction to the empty didChangeConfiguration that Eglot sends it is to change everything to false in its internal server.config, including, in my case snippets, and in your case (for some obscure reason), the completion details.

I think the maintainers of zls should be warned of this. I don't think that's the correct reaction to an empty didChangeConfiguration, but I may be wrong.

[notcancername]

Thank you so much! Everything works perfectly and smoothly.

[notcancername]

I see, awesome! I'll make an issue on their GitHub.

[joaotavora]

Paste the link here. Be sure to explain that didChangeConfiguration from client->server looks like this:

{
    "jsonrpc": "2.0",
    "method": "workspace/didChangeConfiguration",
    "params": {
        "settings": {}
    }
}

[notcancername]

zigtools/zls#1111

[notcancername]

This makes me curious, isn't nil also used as "false" in Emacs?

[joaotavora]

yes, but when translated to JSON nil becomes null

[notcancername]

Okay, thanks! Sorry, that was not directly relevant.

[SuperAuguste]

Hey y'all, zls maintainer here. Issue is a niche little comptime type thing on our end, sorry about that!

I've never seen this. i_haz_configuration? What a cool kid this zig guy is.

LMAO; I mean string IDs are valid per the spec and back in the day I didn't want any overhead tracking IDs so I just hardcoded that one to our configuration response handler :P

And why is Eglot taking issue and replying with all nils anyway? I guess because it doesn't have anything to answer with.

This is the correct (read as: VSCode) behavior for no change in configuration params btw, so it's all good. :)

The nil's are correct, since they translate to null.

This one might've been inspired by zigtools/zls#994; I'm very thankful that you respect the spec entirely, it makes our lives so much easier 😅 <3

Thanks a bunch for your pointers to @notcancername, they helped figure this issue out pretty quickly, and of course, thanks for your work on this language client!

[joaotavora]

Hello, @SuperAuguste , nice server you got there. I've i figured out the issue i was browsing a bit of the zls source. And yes, i think the i_haz_configuration is correct, I'd just never seen it.

Anyway, about this issue.. Did you take a look at why zls kills all the server.config when getting that empty object in didChangeConfiguration? Is that behaviour intentional?