2022-12-11 11:10:48 +00:00
//! DO NOT EDIT
2022-07-15 17:06:18 +01:00
//! Configuration options for zls.
2022-12-11 11:10:48 +00:00
//! If you want to add a config option edit
2023-01-19 06:46:42 +00:00
//! src/config_gen/config.json and run `zig build gen`
2022-12-11 11:10:48 +00:00
//! GENERATED BY src/config_gen/config_gen.zig
2022-07-15 17:06:18 +01:00
2022-12-11 11:10:48 +00:00
/// Enables snippet completions when the client also supports them
2023-01-02 09:02:28 +00:00
enable_snippets : bool = true ,
2020-05-14 00:10:41 +01:00
2022-09-01 01:48:42 +01:00
/// Whether to enable ast-check diagnostics
2022-09-03 14:12:34 +01:00
enable_ast_check_diagnostics : bool = true ,
2022-07-08 09:13:46 +01:00
2022-12-11 11:10:48 +00:00
/// Whether to automatically fix errors on save. Currently supports adding and removing discards.
2023-01-02 09:02:28 +00:00
enable_autofix : bool = true ,
2022-09-24 20:30:36 +01:00
2022-12-11 11:10:48 +00:00
/// Whether to enable import/embedFile argument completions
2023-01-02 09:02:28 +00:00
enable_import_embedfile_argument_completions : bool = true ,
2022-07-09 10:22:02 +01:00
2023-03-14 17:23:57 +00:00
/// Set level of semantic tokens. Partial only includes information that requires semantic analysis.
semantic_tokens : enum {
none ,
partial ,
full ,
2023-05-27 14:55:33 +01:00
2023-03-14 17:23:57 +00:00
pub const tres_string_enum = true ;
} = . full ,
2020-07-07 21:26:12 +01:00
2022-12-11 11:10:48 +00:00
/// Enables inlay hint support when the client also supports it
2023-01-02 09:02:28 +00:00
enable_inlay_hints : bool = true ,
2022-07-24 12:38:13 +01:00
2022-12-11 11:10:48 +00:00
/// Enable inlay hints for builtin functions
2022-07-24 12:38:13 +01:00
inlay_hints_show_builtin : bool = true ,
2022-12-11 11:10:48 +00:00
/// Don't show inlay hints for single argument calls
2022-07-24 12:38:13 +01:00
inlay_hints_exclude_single_argument : bool = true ,
2022-12-11 11:10:48 +00:00
/// Hides inlay hints when parameter name matches the identifier (e.g. foo: foo)
2022-09-29 19:36:29 +01:00
inlay_hints_hide_redundant_param_names : bool = false ,
2022-12-11 11:10:48 +00:00
/// Hides inlay hints when parameter name matches the last token of a parameter node (e.g. foo: bar.foo, foo: &foo)
2022-09-29 19:36:29 +01:00
inlay_hints_hide_redundant_param_names_last_token : bool = false ,
2022-12-11 11:10:48 +00:00
/// Enables `*` and `?` operators in completion lists
2020-07-07 21:26:12 +01:00
operator_completions : bool = true ,
2021-03-06 19:55:59 +00:00
2022-12-11 11:10:48 +00:00
/// Enables warnings for style guideline mismatches
warn_style : bool = false ,
2022-07-15 17:06:18 +01:00
2022-12-11 11:10:48 +00:00
/// Whether to highlight global var declarations
2022-10-10 06:13:15 +01:00
highlight_global_var_declarations : bool = false ,
2022-11-17 00:28:01 +00:00
/// Whether to use the comptime interpreter
2023-04-30 18:21:43 +01:00
dangerous_comptime_experiments_do_not_enable : bool = false ,
2022-10-10 06:13:15 +01:00
2022-12-11 11:10:48 +00:00
/// Whether the @ sign should be part of the completion of builtins
include_at_in_builtins : bool = false ,
2022-09-04 20:44:07 +01:00
2022-12-11 11:10:48 +00:00
/// 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
skip_std_references : bool = false ,
2022-09-29 00:30:26 +01:00
2022-12-11 11:10:48 +00:00
/// The detail field of completions is truncated to be no longer than this (in bytes)
max_detail_length : usize = 1048576 ,
2022-09-29 00:30:26 +01:00
2023-02-14 21:02:37 +00:00
/// Can be used in conjuction with `enable_ast_check_diagnostics` to favor using `zig ast-check` instead of ZLS's fork
prefer_ast_check_as_child_process : bool = true ,
2022-12-31 06:45:45 +00:00
/// When true, zls will record all request is receives and write in into `record_session_path`, so that they can replayed with `zls replay`
record_session : bool = false ,
/// Output file path when `record_session` is set. The recommended file extension *.zlsreplay
record_session_path : ? [ ] const u8 = null ,
/// 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.
replay_session_path : ? [ ] const u8 = null ,
2022-12-11 11:10:48 +00:00
/// Path to 'builtin;' useful for debugging, automatically set if let null
builtin_path : ? [ ] const u8 = null ,
2022-09-29 00:30:26 +01:00
2022-12-11 11:10:48 +00:00
/// Zig library path, e.g. `/path/to/zig/lib/zig`, used to analyze std library imports
zig_lib_path : ? [ ] const u8 = null ,
2022-09-29 00:30:26 +01:00
2022-12-11 11:10:48 +00:00
/// Zig executable path, e.g. `/path/to/zig/zig`, used to run the custom build runner. If `null`, zig is looked up in `PATH`. Will be used to infer the zig standard library path if none is provided
zig_exe_path : ? [ ] const u8 = null ,
2022-09-29 00:30:26 +01:00
2022-12-11 11:10:48 +00:00
/// Path to the `build_runner.zig` file provided by zls. null is equivalent to `${executable_directory}/build_runner.zig`
build_runner_path : ? [ ] const u8 = null ,
2022-10-01 01:47:40 +01:00
2023-03-17 06:27:35 +00:00
/// Path to a directory that will be used as zig's cache. null is equivalent to `${KnownFolders.Cache}/zls`
2022-12-11 11:10:48 +00:00
global_cache_path : ? [ ] const u8 = null ,
2022-10-01 01:47:40 +01:00
2023-02-17 20:26:03 +00:00
/// 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`
build_runner_global_cache_path : ? [ ] const u8 = null ,
2022-12-11 11:10:48 +00:00
// DO NOT EDIT