LuaLS / LuaLS/lua-language-server

Question: is there any way to specify version of the platform?

Open
#2,558 1 comment 2 reactions 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

Hello, we heavily use annotations for our database https://tarantool.io/ and we add new functions and parameters with each minor release. Is there any legal way to specify version of the platform (like you use `@version` for Lua) since from which the method (or option of the class) is available?

For example:

```lua
---@meta

---@since 2.10.0
---@param key string
---@param value any
function box.broadcast(key, value) end
```

I think that openresty have the same issue, don't they?

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 reviewing the existing `@version` annotation behavior and the proposed `@since` syntax in the issue. Determine how platform versions such as Tarantool 2.10.0 should be represented and what availability checking should mean; done should include an agreed approach for methods and class options.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.