schema.json

{
    "$schema": "http://json-schema.org/schema",
    "title": "ZLS Config",
    "description": "Configuration file for the zig language server (ZLS)",
    "type": "object",
    "properties": {
        "enable_snippets": {
            "description": "Enables snippet completions when the client also supports them",
            "type": "boolean",
            "default": true
        },
        "enable_argument_placeholders": {
            "description": "Whether to enable function argument placeholder completions",
            "type": "boolean",
            "default": true
        },
        "enable_build_on_save": {
            "description": "Whether to enable build-on-save diagnostics. Will be automatically enabled if the `build.zig` has declared a 'check' step.",
            "type": "boolean",
            "default": null
        },
        "build_on_save_args": {
            "description": "Specify which arguments should be passed to Zig when running build-on-save.\n\nIf the `build.zig` has declared a 'check' step, it will be preferred over the default 'install' step.",
            "type": "array",
            "items": {
                "type": "string"
            },
            "default": []
        },
        "enable_autofix": {
            "description": "Whether to automatically fix errors on save. Currently supports adding and removing discards.",
            "type": "boolean",
            "default": false
        },
        "semantic_tokens": {
            "description": "Set level of semantic tokens. `partial` only includes information that requires semantic analysis.",
            "type": "string",
            "enum": [
                "none",
                "partial",
                "full"
            ],
            "default": "full"
        },
        "inlay_hints_show_variable_type_hints": {
            "description": "Enable inlay hints for variable types",
            "type": "boolean",
            "default": true
        },
        "inlay_hints_show_struct_literal_field_type": {
            "description": "Enable inlay hints for fields in struct and union literals",
            "type": "boolean",
            "default": true
        },
        "inlay_hints_show_parameter_name": {
            "description": "Enable inlay hints for parameter names",
            "type": "boolean",
            "default": true
        },
        "inlay_hints_show_builtin": {
            "description": "Enable inlay hints for builtin functions",
            "type": "boolean",
            "default": true
        },
        "inlay_hints_exclude_single_argument": {
            "description": "Don't show inlay hints for single argument calls",
            "type": "boolean",
            "default": true
        },
        "inlay_hints_hide_redundant_param_names": {
            "description": "Hides inlay hints when parameter name matches the identifier (e.g. foo: foo)",
            "type": "boolean",
            "default": false
        },
        "inlay_hints_hide_redundant_param_names_last_token": {
            "description": "Hides inlay hints when parameter name matches the last token of a parameter node (e.g. foo: bar.foo, foo: &foo)",
            "type": "boolean",
            "default": false
        },
        "warn_style": {
            "description": "Enables warnings for style guideline mismatches",
            "type": "boolean",
            "default": false
        },
        "highlight_global_var_declarations": {
            "description": "Whether to highlight global var declarations",
            "type": "boolean",
            "default": false
        },
        "skip_std_references": {
            "description": "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",
            "type": "boolean",
            "default": false
        },
        "prefer_ast_check_as_child_process": {
            "description": "Favor using `zig ast-check` instead of ZLS's fork",
            "type": "boolean",
            "default": true
        },
        "builtin_path": {
            "description": "Path to 'builtin;' useful for debugging, automatically set if let null",
            "type": "string",
            "default": null
        },
        "zig_lib_path": {
            "description": "Zig library path, e.g. `/path/to/zig/lib/zig`, used to analyze std library imports",
            "type": "string",
            "default": null
        },
        "zig_exe_path": {
            "description": "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",
            "type": "string",
            "default": null
        },
        "build_runner_path": {
            "description": "Path to the `build_runner.zig` file provided by ZLS. null is equivalent to `${executable_directory}/build_runner.zig`",
            "type": "string",
            "default": null
        },
        "global_cache_path": {
            "description": "Path to a directory that will be used as zig's cache. null is equivalent to `${KnownFolders.Cache}/zls`",
            "type": "string",
            "default": null
        },
        "completion_label_details": {
            "description": "When false, the function signature of completion results is hidden. Improves readability in some editors",
            "type": "boolean",
            "default": true
        }
    }
}