LuaLS / LuaLS/lua-language-server

Feature Request: Deprecate fields and parameters

Open
#1,313 7 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Could really use a clean way to mark specific field and parameters as deprecated. Currently I'm adding @\*\*[DEPRECATED]\*\* to the start of the comments for the field/parameter, but this doesn't change the name with a strike-through (as happens with functions).

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 locating the annotation handling for fields and parameters, then compare it with the existing function deprecation behavior. Done means a field or parameter marked as deprecated is displayed with a strikethrough, rather than requiring a comment containing [DEPRECATED].

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.