LuaLS / LuaLS/lua-language-server

[Feature request]: Cast class fields

Open
#1,253 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement feat/type check
Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

If I have any class, and I get a warning like the following on a function that is being given a class field as a parameter (e.g., tohex(class_name.class_field)):

Cannot assign `string|integer` to parameter `integer`.
[Lua Diagnostics.: param-type-mismatch]

Is there already a way to cast this class field? If not, could it be implemented?

When trying to cast something like ---@cast group.foreground -string, I get the warning:

Unknown type conversion variable `{}`.
[Lua Diagnostics.: unknown-cast-variable]

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 tracing the unknown-cast-variable and param-type-mismatch diagnostics described in the issue, then inspect how casts currently resolve variables and class fields. Done means a cast such as ---@cast group.foreground -string is accepted and removes the reported type warning when the field is passed to an integer-only function.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.