LuaLS / LuaLS/lua-language-server

Multiline definitions bug in @meta files

Open
#2,370 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

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?

Diagnostics/Syntax Checking

Expected Behaviour

Not throwing a warning

Actual Behaviour

Throws a warning for this piece of code: for missing return

---@meta

-- bunch of other definitions

---Create a new RotMatrix.
---Available in worker threads.
---@param x1 number
---@param y1 number
---@param z1 number
---@param x2 number
---@param y2 number
---@param z2 number
---@param x3 number
---@param y3 number
---@param z3 number
---@return RotMatrix rotMatrix The created rotation matrix.
function RotMatrix(
	x1, y1, z1,
	x2, y2, z2,
	x3, y3, z3
) end

But not for the same code, with the RotMatrix shortened to 1 line;

function RotMatrix(x1, y1, z1, x2, y2, z2, x3, y3, z3) end
Reproduction steps
  1. Check code sample in editor
Additional Notes

No response

Log File

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the Lua sample in the Visual Studio Code extension and tracing the diagnostics/syntax-checking report for the multiline RotMatrix definition. Compare it with the one-line definition; done when the multiline @meta definition no longer reports a missing-return warning while the reported behavior remains correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.