LuaLS / LuaLS/lua-language-server

@overload does not cooperate with @alias

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

还没有人认领这个 Issue。

enhancement feat/LuaCats Annotations
主要语言
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?

Annotations, Diagnostics/Syntax Checking

Expected Behaviour

When I define an @alias, an @overload command should be able to use it.

Actual Behaviour

I receive the error:

`fun` expected. Lua Syntax Check.(luadoc-miss-fun-after-overload)
Reproduction steps
---@alias what fun():"ok"

---@class huh
---@overload what
local huh = {}

贡献指南

打开贡献指南

从这里开始

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

调研方向

从 @alias 和 @overload 的 Lua 文档注解处理开始,使用 issue 中的复现作为第一个运行的用例。跟踪 @overload 产生诊断 luadoc-miss-fun-after-overload 的原因。完成的标准是:基于 alias 的 overload 在没有该诊断的情况下被接受,同时现有的 overload 语法仍然有效。

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

评估

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

把新 issue 发到你的邮箱

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