LuaLS / LuaLS/lua-language-server

Workspace is loaded with fallback config then user config is partially loaded

未关闭
#3,092 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Linux

What is the issue affecting?

Other

Expected Behaviour

Upon opening a project when LuaLS is loading if the user have a .luarc.json with content :

{
  "$schema": "https://raw.githubusercontent.com/LuaLS/vscode-lua/master/setting/schema.json",
  "runtime": {
    "version": "Lua 5.1",
    "fileEncoding": "utf8",
    "builtin": {
      "basic": "disable",
      "bit": "disable",
      "bit32": "disable",
      "builtin": "disable",
      "coroutine": "disable",
      "debug": "disable",
      "ffi": "disable",
      "io": "disable",
      "jit": "disable",
      "math": "disable",
      "os": "disable",
      "package": "disable",
      "string": "disable",
      "table": "disable",
      "table.clear": "disable",
      "table.new": "disable",
      "utf8": "disable"
    }
  },
  "workspace": {
    "maxPreload": 2048,
    "library": ["Annotations"]
  }
}

The language server should :

  • Not prepare any hover documentation for any standard lua library
  • Preload files that exceed 500kb
  • Read definitions files from Annotations folder create entries for hover documentations.
Actual Behaviour

Upon opening the project LuaLS will :

In the case of hover documentations :
LuaLS will prepare all lua 5.4 documentation and start serving them. When definitions files in Annotations if one define for example table.foreach the documentation will be added to the current context
Image
(first documentation block come from Annotations, second come from LuaLS embedded definitions files for the standard libraries for lua 5.4)

In the case there is an 500+ kb file display directly :
Too large file: Lua/bigfile.lua skipped. The currently set size limit is: 500 KB, and the file size is: 627.979 KB.
(Upon opening Lua/bigfile.lua the file will be treated correctly without any error)

Reproduction steps
  1. Create a project folder with content as follow :
root-directory/
  - Annotations/
    - table.d.lua
  - Lua/
    - main.lua
    - bigfile.lua
  - .luarc.json

table.d.lua content :

---@meta table

---@class tablelib
table = {}

---
---Deprecated in favor of pairs
---@see pairs
---
---[View documents](http://www.lua.org/manual/5.4/manual.html#pdf-table.foreach)
---
---@generic T
---@param list any
---@param callback fun(key: string, value: any):T|nil
---@return T|nil
---@deprecated
function table.foreach(list, callback) end

main.lua content:

local t = {}
table.foreach(t, function ()
    
end)

bigfile.lua content : Anything to make the file be bigger than 500kb

.luarc.json content

{
  "$schema": "https://raw.githubusercontent.com/LuaLS/vscode-lua/master/setting/schema.json",
  "runtime": {
    "version": "Lua 5.1",
    "fileEncoding": "utf8",
    "builtin": {
      "basic": "disable",
      "bit": "disable",
      "bit32": "disable",
      "builtin": "disable",
      "coroutine": "disable",
      "debug": "disable",
      "ffi": "disable",
      "io": "disable",
      "jit": "disable",
      "math": "disable",
      "os": "disable",
      "package": "disable",
      "string": "disable",
      "table": "disable",
      "table.clear": "disable",
      "table.new": "disable",
      "utf8": "disable"
    }
  },
  "workspace": {
    "maxPreload": 2048,
    "library": ["Annotations"]
  }
}
  1. Open project with vscode
  2. See warning notification appear directly or upon opening main.lua file
  3. Hover above striked table.foreach and see both documentation aggregated together
Additional Notes

This behavior can also be reproduced in current zed stable version 0.174.6
In both editor I only installed the extension and run the default provided configuration. I only configured misc.parameters : [ "--loglevel=trace" ] in vscode settings only for the following logs as misc.parameters in .luarc.json was not picked-up.

Log File

file_home_skyy_Workspace_issue.log
service.log

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

在 VS Code 中使用 .luarc.json、Annotations/table.d.lua、Lua/main.lua 和 Lua/bigfile.lua 重现该行为,然后检查附加的日志文件以了解加载顺序。检查为什么用户配置加载后,Lua 5.4 的回退定义和 500 KB 限制仍处于活动状态。完成的标准是应用 Lua 5.1 设置、Annotations 定义仍然可用,并且较大的文件已预加载。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
devtools, tooling
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。