feat(lsp-zig.el): Add zls configuration (#4348)

* feat(lsp-zig.el): Add zls configuration

* Fix compile

Author: jcs090218

clients/lsp-zig.el

@@ -39,6 +39,197 @@ executable with variable `exec-path'."
   :group 'lsp-zig
   :type 'string)
 
+(defcustom lsp-zig-trace-server "off"
+  "Traces the communication between Emacs and the language server."
+  :group 'lsp-zig
+  :type '(choice (const "off")
+                 (const "messages")
+                 (const "verbose")))
+
+(defcustom lsp-zig-check-for-update t
+  "Whether to automatically check for new updates."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-enable-snippets t
+  "Enables snippet completions when the client also supports them."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-enable-argument-placeholders t
+  "Whether to enable function argument placeholder completions."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-enable-build-on-save nil
+  "Whether to enable build-on-save diagnostics."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-build-on-save-step "install"
+  "Select which step should be executed on build-on-save."
+  :group 'lsp-zig
+  :type 'string)
+
+(defcustom lsp-zig-zls-enable-autofix nil
+  "Whether to automatically fix errors on save.
+Currently supports adding and removing discards."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-semantic-tokens "partial"
+  "Traces the communication between Emacs and the language server."
+  :group 'lsp-zig
+  :type '(choice (const "off")
+                 (const "messages")
+                 (const "verbose")))
+
+(defcustom lsp-zig-zls-enable-inlay-hints t
+  "Enables inlay hint support when the client also supports it."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-inlay-hints-show-variable-type-hints t
+  "Enable inlay hints for variable type."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-inlay-hints-show-parameter-name t
+  "Enable inlay hints for parameter names."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-inlay-hints-exclude-single-argument t
+  "Don't show inlay hints for single argument calls."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-inlay-hints-show-builtin t
+  "Don't show inlay hints for single argument calls."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-inlay-hints-hide-redundant-param-names nil
+  "Hides inlay hints when parameter name matches the identifier (e.g. foo: foo)."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-inlay-hints-hide-redundant-param-names-last-token nil
+  "Hides inlay hints when parameter name matches the last token of a parameter
+node (e.g. foo: bar.foo, foo: &foo)."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-warn-style nil
+  "Enables warnings for style guideline mismatches."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-highlight-global-var-declarations nil
+  "Whether to highlight global var declarations."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-dangerous-comptime-experiments-do-not-enable nil
+  "When true, skips searching for references in std.
+Improves lookup speed for functions in user's code.  Renaming and
+go-to-definition will continue to work as is."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-skip-std-references nil
+  "hen true, skips searching for references in std.
+Improves lookup speed for functions in user's code.  Renaming and
+ go-to-definition will continue to work as is."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-prefer-ast-check-as-child-process t
+  "Favor using `zig ast-check` instead of ZLS's fork."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-record-session nil
+  "When true, zls will record all request is receives and write in into
+`record_session_path`, so that they can replayed with `zls replay`."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-record-session-path ""
+  "Output file path when `record_session` is set.
+The recommended file extension *.zlsreplay."
+  :group 'lsp-zig
+  :type 'string)
+
+(defcustom lsp-zig-zls-replay-session-path ""
+  "Used when calling `zls replay` for specifying the replay file.
+If no extra argument is given `record_session_path` is used as the default path."
+  :group 'lsp-zig
+  :type 'string)
+
+(defcustom lsp-zig-zls-builtin-path ""
+  "Path to `builtin'; useful for debugging, automatically set if let null."
+  :group 'lsp-zig
+  :type 'string)
+
+(defcustom lsp-zig-zls-zig-lib-path ""
+  "Zig library path.
+e.g. `/path/to/zig/lib/zig`, used to analyze std library imports."
+  :group 'lsp-zig
+  :type 'string)
+
+(defcustom lsp-zig-zls-build-runner-path ""
+  "Path to the `build_runner.zig` file provided by zls.
+null is equivalent to `${executable_directory}/build_runner.zig`."
+  :group 'lsp-zig
+  :type 'string)
+
+(defcustom lsp-zig-zls-global-cache-path ""
+  "Path to a directory that will be used as zig's cache.
+null is equivalent to `${KnownFolders.Cache}/zls`."
+  :group 'lsp-zig
+  :type 'string)
+
+(defcustom lsp-zig-zls-build-runner-global-cache-path ""
+  "Path to a directory that will be used as the global cache path when executing
+a projects build.zig.  null is equivalent to the path shown by `zig env`."
+  :group 'lsp-zig
+  :type 'string)
+
+(defcustom lsp-zig-zls-completions-with-replace nil
+  "Completions confirm behavior.
+If `true', replace the text after the cursor."
+  :group 'lsp-zig
+  :type 'boolean)
+
+(defcustom lsp-zig-zls-completion-label-details nil
+  "When false, the function signature of completion results is hidden.
+Improves readability in some editors."
+  :group 'lsp-zig
+  :type 'boolean)
+
+;;
+;;; Util
+
+(defmacro lsp-zig--mute-apply (&rest body)
+  "Execute BODY without message."
+  (declare (indent 0) (debug t))
+  `(let (message-log-max)
+     (with-temp-message (or (current-message) nil)
+       (let ((inhibit-message t)) ,@body))))
+
+(defun lsp-zig--execute (cmd &rest args)
+  "Return non-nil if CMD executed succesfully with ARGS."
+  (save-window-excursion
+    (lsp-zig--mute-apply
+      (= 0 (shell-command (concat cmd " "
+                                  (mapconcat #'shell-quote-argument
+                                             (cl-remove-if #'null args)
+                                             " ")))))))
+
+;;
+;;; Installation
+
 (defcustom lsp-zig-server-store-path
   (expand-file-name "zig/" lsp-server-install-dir)
   "The path to the file in which zls will be stored."
@@ -75,28 +266,6 @@ executable with variable `exec-path'."
 (defvar lsp-zig--downloaded-file (f-join lsp-zig-server-store-path "temp.tar")
   "The full file path after downloading the server zipped file.")
 
-;;
-;;; Util
-
-(defmacro lsp-zig--mute-apply (&rest body)
-  "Execute BODY without message."
-  (declare (indent 0) (debug t))
-  `(let (message-log-max)
-     (with-temp-message (or (current-message) nil)
-       (let ((inhibit-message t)) ,@body))))
-
-(defun lsp-zig--execute (cmd &rest args)
-  "Return non-nil if CMD executed succesfully with ARGS."
-  (save-window-excursion
-    (lsp-zig--mute-apply
-      (= 0 (shell-command (concat cmd " "
-                                  (mapconcat #'shell-quote-argument
-                                             (cl-remove-if #'null args)
-                                             " ")))))))
-
-;;
-;;; Installation
-
 (defun lsp-zig--stored-zls-executable ()
   "Return the stored zls executable.
 
@@ -124,6 +293,39 @@ and not the global storage."
 ;;
 ;;; Core
 
+(lsp-register-custom-settings
+ '(("zig.zls.trace.server" lsp-zig-trace-server)
+   ("zig.zls.checkForUpdate" lsp-zig-check-for-update)
+   ("zig.zls.path" lsp-zig-zls-executable)
+   ("zig.zls.enableSnippets" lsp-zig-zls-enable-snippets)
+   ("zig.zls.enableArgumentPlaceholders" lsp-zig-zls-enable-argument-placeholders)
+   ("zig.zls.enableBuildOnSave" lsp-zig-zls-enable-build-on-save)
+   ("zig.zls.buildOnSaveStep" lsp-zig-zls-build-on-save-step)
+   ("zig.zls.enableAutofix" lsp-zig-zls-enable-autofix)
+   ("zig.zls.semanticTokens" lsp-zig-zls-semantic-tokens)
+   ("zig.zls.enableInlayHints" lsp-zig-zls-enable-inlay-hints)
+   ("zig.zls.inlayHintsShowVariableTypeHints" lsp-zig-zls-inlay-hints-show-variable-type-hints)
+   ("zig.zls.inlayHintsShowParameterName" lsp-zig-zls-inlay-hints-show-parameter-name)
+   ("zig.zls.inlayHintsShowBuiltin" lsp-zig-zls-inlay-hints-show-builtin)
+   ("zig.zls.inlayHintsExcludeSingleArgument" lsp-zig-zls-inlay-hints-exclude-single-argument)
+   ("zig.zls.inlayHintsHideRedundantParamNames" lsp-zig-zls-inlay-hints-hide-redundant-param-names)
+   ("zig.zls.inlayHintsHideRedundantParamNamesLastToken" lsp-zig-zls-inlay-hints-hide-redundant-param-names-last-token)
+   ("zig.zls.warnStyle" lsp-zig-zls-warn-style)
+   ("zig.zls.highlightGlobalVarDeclarations" lsp-zig-zls-highlight-global-var-declarations)
+   ("zig.zls.dangerousComptimeExperimentsDoNotEnable" lsp-zig-zls-dangerous-comptime-experiments-do-not-enable)
+   ("zig.zls.skipStdReferences" lsp-zig-zls-skip-std-references)
+   ("zig.zls.preferAstCheckAsChildProcess" lsp-zig-zls-prefer-ast-check-as-child-process)
+   ("zig.zls.recordSession" lsp-zig-zls-record-session)
+   ("zig.zls.recordSessionPath" lsp-zig-zls-record-session-path)
+   ("zig.zls.replaySessionPath" lsp-zig-zls-replay-session-path)
+   ("zig.zls.builtinPath" lsp-zig-zls-builtin-path)
+   ("zig.zls.zigLibPath" lsp-zig-zls-zig-lib-path)
+   ("zig.zls.buildRunnerPath" lsp-zig-zls-build-runner-path)
+   ("zig.zls.globalCachePath" lsp-zig-zls-global-cache-path)
+   ("zig.zls.buildRunnerGlobalCachePath" lsp-zig-zls-build-runner-global-cache-path)
+   ("zig.zls.completionsWithReplace" lsp-zig-zls-completions-with-replace)
+   ("zig.zls.completionLabelDetails" lsp-zig-zls-completion-label-details)))
+
 (lsp-register-client
  (make-lsp-client
   :new-connection (lsp-stdio-connection