# completion.autoRequire 输入内容看起来是个文件名时，自动 `require` 此文件。 ## type ```ts boolean ``` ## default ```json true ``` # completion.callSnippet 显示函数调用片段。 ## type ```ts string ``` ## enum * ``"Disable"``: 只显示 `函数名`。 * ``"Both"``: 显示 `函数名` 与 `调用片段`。 * ``"Replace"``: 只显示 `调用片段`。 ## default ```json "Disable" ``` # completion.displayContext 预览建议的相关代码片段，可能可以帮助你了解这项建议的用法。设置的数字表示代码片段的截取行数，设置为`0`可以禁用此功能。 ## type ```ts integer ``` ## default ```json 0 ``` # completion.enable 启用自动完成。 ## type ```ts boolean ``` ## default ```json true ``` # completion.keywordSnippet 显示关键字语法片段 ## type ```ts string ``` ## enum * ``"Disable"``: 只显示 `关键字`。 * ``"Both"``: 显示 `关键字` 与 `语法片段`。 * ``"Replace"``: 只显示 `语法片段`。 ## default ```json "Replace" ``` # completion.postfix 用于触发后缀建议的符号。 ## type ```ts string ``` ## default ```json "@" ``` # completion.requireSeparator `require` 时使用的分隔符。 ## type ```ts string ``` ## default ```json "." ``` # completion.showParams 在建议列表中显示函数的参数信息，函数拥有多个定义时会分开显示。 ## type ```ts boolean ``` ## default ```json true ``` # completion.showWord 在建议中显示上下文单词。 ## type ```ts string ``` ## enum * ``"Enable"``: 总是在建议中显示上下文单词。 * ``"Fallback"``: 无法根据语义提供建议时才显示上下文单词。 * ``"Disable"``: 不显示上下文单词。 ## default ```json "Fallback" ``` # completion.workspaceWord 显示的上下文单词是否包含工作区中其他文件的内容。 ## type ```ts boolean ``` ## default ```json true ``` # diagnostics.disable 禁用的诊断（使用浮框括号内的代码）。 ## type ```ts Array ``` ## default ```json [] ``` # diagnostics.disableScheme 不诊断使用以下 scheme 的lua文件。 ## type ```ts Array ``` ## default ```json ["git"] ``` # diagnostics.enable 启用诊断。 ## type ```ts boolean ``` ## default ```json true ``` # diagnostics.globals 已定义的全局变量。 ## type ```ts Array ``` ## default ```json [] ``` # diagnostics.groupFileStatus 批量修改一个组中的文件状态。 * Opened: 只诊断打开的文件 * Any: 诊断任何文件 * None: 禁用此诊断 设置为 `Fallback` 意味着组中的诊断由 `diagnostics.neededFileStatus` 单独设置。 其他设置将覆盖单独设置，但是不会覆盖以 `!` 结尾的设置。 ## type ```ts object ``` ## enum * ``"Any"`` * ``"Opened"`` * ``"None"`` * ``"Fallback"`` ## default ```json { "ambiguity": "Fallback", "await": "Fallback", "codestyle": "Fallback", "duplicate": "Fallback", "global": "Fallback", "luadoc": "Fallback", "no-unknown": "Fallback", "redefined": "Fallback", "strict": "Fallback", "type-check": "Fallback", "unbalanced": "Fallback", "unused": "Fallback" } ``` # diagnostics.groupSeverity 批量修改一个组中的诊断等级。 设置为 `Fallback` 意味着组中的诊断由 `diagnostics.severity` 单独设置。 其他设置将覆盖单独设置，但是不会覆盖以 `!` 结尾的设置。 ## type ```ts object ``` ## enum * ``"Error"`` * ``"Warning"`` * ``"Information"`` * ``"Hint"`` * ``"Fallback"`` ## default ```json { "ambiguity": "Fallback", "await": "Fallback", "codestyle": "Fallback", "duplicate": "Fallback", "global": "Fallback", "luadoc": "Fallback", "no-unknown": "Fallback", "redefined": "Fallback", "strict": "Fallback", "type-check": "Fallback", "unbalanced": "Fallback", "unused": "Fallback" } ``` # diagnostics.ignoredFiles 如何诊断被忽略的文件。 ## type ```ts string ``` ## enum * ``"Enable"``: 总是诊断这些文件。 * ``"Opened"``: 只有打开这些文件时才会诊断。 * ``"Disable"``: 不诊断这些文件。 ## default ```json "Opened" ``` # diagnostics.libraryFiles 如何诊断通过 `Lua.workspace.library` 加载的文件。 ## type ```ts string ``` ## enum * ``"Enable"``: 总是诊断这些文件。 * ``"Opened"``: 只有打开这些文件时才会诊断。 * ``"Disable"``: 不诊断这些文件。 ## default ```json "Opened" ``` # diagnostics.neededFileStatus * Opened: 只诊断打开的文件 * Any: 诊断任何文件 * None: 禁用此诊断 以 `!` 结尾的设置优先级高于组设置 `diagnostics.groupFileStatus`。 ## type ```ts object ``` ## enum * ``"Any"`` * ``"Opened"`` * ``"None"`` * ``"Any!"`` * ``"Opened!"`` * ``"None!"`` ## default ```json { "ambiguity-1": "Any", "assign-type-mismatch": "Opened", "await-in-sync": "None", "cast-local-type": "Opened", "cast-type-mismatch": "Any", "circle-doc-class": "Any", "close-non-object": "Any", "code-after-break": "Opened", "codestyle-check": "None", "count-down-loop": "Any", "deprecated": "Any", "different-requires": "Any", "discard-returns": "Any", "doc-field-no-class": "Any", "duplicate-doc-alias": "Any", "duplicate-doc-field": "Any", "duplicate-doc-param": "Any", "duplicate-index": "Any", "duplicate-set-field": "Any", "empty-block": "Opened", "global-in-nil-env": "Any", "lowercase-global": "Any", "missing-parameter": "Any", "need-check-nil": "Opened", "newfield-call": "Any", "newline-call": "Any", "no-unknown": "None", "not-yieldable": "None", "param-type-mismatch": "Opened", "redefined-local": "Opened", "redundant-parameter": "Any", "redundant-return": "Opened", "redundant-value": "Any", "spell-check": "None", "trailing-space": "Opened", "unbalanced-assignments": "Any", "undefined-doc-class": "Any", "undefined-doc-name": "Any", "undefined-doc-param": "Any", "undefined-env-child": "Any", "undefined-field": "Opened", "undefined-global": "Any", "unknown-cast-variable": "Any", "unknown-diag-code": "Any", "unused-function": "Opened", "unused-label": "Opened", "unused-local": "Opened", "unused-vararg": "Opened" } ``` # diagnostics.severity 修改诊断等级。 以 `!` 结尾的设置优先级高于组设置 `diagnostics.groupSeverity`。 ## type ```ts object ``` ## enum * ``"Error"`` * ``"Warning"`` * ``"Information"`` * ``"Hint"`` * ``"Error!"`` * ``"Warning!"`` * ``"Information!"`` * ``"Hint!"`` ## default ```json { "ambiguity-1": "Warning", "assign-type-mismatch": "Warning", "await-in-sync": "Warning", "cast-local-type": "Warning", "cast-type-mismatch": "Warning", "circle-doc-class": "Warning", "close-non-object": "Warning", "code-after-break": "Hint", "codestyle-check": "Warning", "count-down-loop": "Warning", "deprecated": "Warning", "different-requires": "Warning", "discard-returns": "Warning", "doc-field-no-class": "Warning", "duplicate-doc-alias": "Warning", "duplicate-doc-field": "Warning", "duplicate-doc-param": "Warning", "duplicate-index": "Warning", "duplicate-set-field": "Warning", "empty-block": "Hint", "global-in-nil-env": "Warning", "lowercase-global": "Information", "missing-parameter": "Warning", "need-check-nil": "Warning", "newfield-call": "Warning", "newline-call": "Warning", "no-unknown": "Warning", "not-yieldable": "Warning", "param-type-mismatch": "Warning", "redefined-local": "Hint", "redundant-parameter": "Warning", "redundant-return": "Hint", "redundant-value": "Warning", "spell-check": "Information", "trailing-space": "Hint", "unbalanced-assignments": "Warning", "undefined-doc-class": "Warning", "undefined-doc-name": "Warning", "undefined-doc-param": "Warning", "undefined-env-child": "Information", "undefined-field": "Warning", "undefined-global": "Warning", "unknown-cast-variable": "Warning", "unknown-diag-code": "Warning", "unused-function": "Hint", "unused-label": "Hint", "unused-local": "Hint", "unused-vararg": "Hint" } ``` # diagnostics.workspaceDelay 进行工作区诊断的延迟（毫秒）。当你启动工作区，或编辑了任意文件后，将会在后台对整个工作区进行重新诊断。设置为负数可以禁用工作区诊断。 ## type ```ts integer ``` ## default ```json 3000 ``` # diagnostics.workspaceRate 工作区诊断的运行速率（百分比）。降低该值会减少CPU占用，但是也会降低工作区诊断的速度。你当前正在编辑的文件的诊断总是全速完成，不受该选项影响。 ## type ```ts integer ``` ## default ```json 100 ``` # format.defaultConfig 默认的格式化配置，优先级低于工作区内的 `.editorconfig` 文件。 请查阅[格式化文档](https://github.com/CppCXY/EmmyLuaCodeStyle/tree/master/docs)了解用法。 ## type ```ts Object ``` ## default ```json {} ``` # format.enable 启用代码格式化程序。 ## type ```ts boolean ``` ## default ```json true ``` # hint.arrayIndex 在构造表时提示数组索引。 ## type ```ts string ``` ## enum * ``"Enable"``: 所有的表中都提示数组索引。 * ``"Auto"``: 只有表大于3项，或者表是混合类型时才进行提示。 * ``"Disable"``: 禁用数组索引提示。 ## default ```json "Auto" ``` # hint.await 如果调用的函数被标记为了 `---@async` ，则在调用处提示 `await` 。 ## type ```ts boolean ``` ## default ```json true ``` # hint.enable 启用内联提示。 ## type ```ts boolean ``` ## default ```json false ``` # hint.paramName 在函数调用处提示参数名。 ## type ```ts string ``` ## enum * ``"All"``: 所有类型的参数均进行提示。 * ``"Literal"``: 只有字面量类型的参数进行提示。 * ``"Disable"``: 禁用参数提示。 ## default ```json "All" ``` # hint.paramType 在函数的参数位置提示类型。 ## type ```ts boolean ``` ## default ```json true ``` # hint.setType 在赋值操作位置提示类型。 ## type ```ts boolean ``` ## default ```json false ``` # hover.enable 启用悬停提示。 ## type ```ts boolean ``` ## default ```json true ``` # hover.enumsLimit 当值对应多个类型时，限制类型的显示数量。 ## type ```ts integer ``` ## default ```json 5 ``` # hover.expandAlias 是否展开别名。例如 `---@alias myType boolean|number` 展开后显示为 `boolean|number`，否则显示为 `myType`。 ## type ```ts boolean ``` ## default ```json true ``` # hover.previewFields 悬停提示查看表时，限制表内字段的最大预览数量。 ## type ```ts integer ``` ## default ```json 50 ``` # hover.viewNumber 悬停提示查看数字内容（仅当字面量不是十进制时）。 ## type ```ts boolean ``` ## default ```json true ``` # hover.viewString 悬停提示查看字符串内容（仅当字面量包含转义符时）。 ## type ```ts boolean ``` ## default ```json true ``` # hover.viewStringMax 悬停提示查看字符串内容时的最大长度。 ## type ```ts integer ``` ## default ```json 1000 ``` # misc.parameters VSCode中启动语言服务时的[命令行参数](https://github.com/sumneko/lua-language-server/wiki/Command-line)。 ## type ```ts Array ``` ## default ```json [] ``` # runtime.builtin 调整内置库的启用状态，你可以根据实际运行环境禁用掉不存在的库（或重新定义）。 * `default`: 表示库会根据运行版本启用或禁用 * `enable`: 总是启用 * `disable`: 总是禁用 ## type ```ts object ``` ## enum * ``"default"`` * ``"enable"`` * ``"disable"`` ## default ```json { "basic": "default", "bit": "default", "bit32": "default", "builtin": "default", "coroutine": "default", "debug": "default", "ffi": "default", "io": "default", "jit": "default", "math": "default", "os": "default", "package": "default", "string": "default", "table": "default", "utf8": "default" } ``` # runtime.fileEncoding 文件编码，`ansi` 选项只在 `Windows` 平台下有效。 ## type ```ts string ``` ## enum * ``"utf8"`` * ``"ansi"`` * ``"utf16le"`` * ``"utf16be"`` ## default ```json "utf8" ``` # runtime.meta meta文件的目录名称格式。 ## type ```ts string ``` ## default ```json "${version} ${language} ${encoding}" ``` # runtime.nonstandardSymbol 支持非标准的符号。请务必确认你的运行环境支持这些符号。 ## type ```ts Array ``` ## enum * ``"//"`` * ``"/**/"`` * ``"`"`` * ``"+="`` * ``"-="`` * ``"*="`` * ``"/="`` * ``"||"`` * ``"&&"`` * ``"!"`` * ``"!="`` * ``"continue"`` ## default ```json [] ``` # runtime.path 当使用 `require` 时，如何根据输入的名字来查找文件。 此选项设置为 `?/init.lua` 意味着当你输入 `require 'myfile'` 时，会从已加载的文件中搜索 `{workspace}/myfile/init.lua`。 当 `runtime.pathStrict` 设置为 `false` 时，还会尝试搜索 `${workspace}/**/myfile/init.lua`。 如果你想要加载工作区以外的文件，你需要先设置 `Lua.workspace.library`。 ## type ```ts Array ``` ## default ```json ["?.lua","?/init.lua"] ``` # runtime.pathStrict 启用后 `runtime.path` 将只搜索第一层目录，见 `runtime.path` 的说明。 ## type ```ts boolean ``` ## default ```json false ``` # runtime.plugin 插件路径，请查阅[文档](https://github.com/sumneko/lua-language-server/wiki/Plugin)了解用法。 ## type ```ts string ``` ## default ```json "" ``` # runtime.special 将自定义全局变量视为一些特殊的内置变量，语言服务将提供特殊的支持。 下面这个例子表示将 `include` 视为 `require` 。 ```json "Lua.runtime.special" : { "include" : "require" } ``` ## type ```ts Object ``` ## default ```json {} ``` # runtime.unicodeName 允许在名字中使用 Unicode 字符。 ## type ```ts boolean ``` ## default ```json false ``` # runtime.version Lua运行版本。 ## type ```ts string ``` ## enum * ``"Lua 5.1"`` * ``"Lua 5.2"`` * ``"Lua 5.3"`` * ``"Lua 5.4"`` * ``"LuaJIT"`` ## default ```json "Lua 5.4" ``` # semantic.annotation 对类型注解进行语义着色。 ## type ```ts boolean ``` ## default ```json true ``` # semantic.enable 启用语义着色。你可能需要同时将 `editor.semanticHighlighting.enabled` 设置为 `true` 才能生效。 ## type ```ts boolean ``` ## default ```json true ``` # semantic.keyword 对关键字/字面量/运算符进行语义着色。只有当你的编辑器无法进行语法着色时才需要启用此功能。 ## type ```ts boolean ``` ## default ```json false ``` # semantic.variable 对变量/字段/参数进行语义着色。 ## type ```ts boolean ``` ## default ```json true ``` # signatureHelp.enable 启用参数提示。 ## type ```ts boolean ``` ## default ```json true ``` # spell.dict 拼写检查的自定义单词。 ## type ```ts Array ``` ## default ```json [] ``` # telemetry.enable 启用遥测，通过网络发送你的编辑器信息与错误日志。在[此处](https://github.com/sumneko/lua-language-server/wiki/%E9%9A%90%E7%A7%81%E5%A3%B0%E6%98%8E)阅读我们的隐私声明。 ## type ```ts boolean | null ``` ## default ```json null ``` # window.progressBar 在状态栏显示进度条。 ## type ```ts boolean ``` ## default ```json true ``` # window.statusBar 在状态栏显示插件状态。 ## type ```ts boolean ``` ## default ```json true ``` # workspace.checkThirdParty 自动检测与适配第三方库，目前支持的库为： * OpenResty * Cocos4.0 * LÖVE * LÖVR * skynet * Jass ## type ```ts boolean ``` ## default ```json true ``` # workspace.ignoreDir 忽略的文件与目录（使用 `.gitignore` 语法）。 ## type ```ts Array ``` ## default ```json [".vscode"] ``` # workspace.ignoreSubmodules 忽略子模块。 ## type ```ts boolean ``` ## default ```json true ``` # workspace.library 除了当前工作区以外，还会从哪些目录中加载文件。这些目录中的文件将被视作外部提供的代码库，部分操作（如重命名字段）不会修改这些文件。 ## type ```ts Array ``` ## default ```json [] ``` # workspace.maxPreload 最大预加载文件数。 ## type ```ts integer ``` ## default ```json 5000 ``` # workspace.preloadFileSize 预加载时跳过大小大于该值（KB）的文件。 ## type ```ts integer ``` ## default ```json 500 ``` # workspace.supportScheme 为以下 scheme 的lua文件提供语言服务。 ## type ```ts Array ``` ## default ```json ["file","untitled","git"] ``` # workspace.useGitIgnore 忽略 `.gitignore` 中列举的文件。 ## type ```ts boolean ``` ## default ```json true ``` # workspace.userThirdParty 在这里添加私有的第三方库适配文件路径，请参考内置的[配置文件路径](https://github.com/sumneko/lua-language-server/tree/master/meta/3rd) ## type ```ts Array ``` ## default ```json [] ```