LuaLS / LuaLS/lua-language-server

Support for a bottom type for non-returning functions

未关闭
#2,443 1 条评论 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?

Windows

What is the issue affecting?

Type Checking

Expected Behaviour

Have a way to tag the return type of a function as Bottom, i.e., never returns.

Actual Behaviour

I have a snippet like this:


local function abort(err)
	io.stderr:write(err .. "\n")
	os.exit(1)
end

local function stuff()
	local chunk = loadfile("x.lua")
	if not chunk then
		abort("failed to loadfile()")
	end
	chunk()
	return {}
end

stuff()

which triggers the "need-nil-check" diagnostic on "chunk()" because it doesn't understand that abort() never returns, so i would like to tag abort() (or better tag os.exit() and do return os.exit) as never returning function.

obvious work-around is to do "return abort(...)" instead, but that messes up the return type of stuff() from table to table|nil. so i have to write abort() return {} to make the type checker happy which is a bit cumbersome

Reproduction steps
  1. Go to '...'
  2. Click '...'
  3. See error '...'
Additional Notes

No response

Log File

No response

贡献指南

打开贡献指南

从这里开始

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

调研方向

need-nil-check 诊断的类型检查路径以及现有的函数返回类型注解入手。将对 abortos.exit 的所需处理方式,与检查器在调用之后如何推断 stuff() 进行比较。完成的标准是:可以表示一个不返回的函数,从而避免 nil 诊断,而不向 stuff() 的返回类型添加 nil。

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

评估

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

把新 issue 发到你的邮箱

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