LuaLS / LuaLS/lua-language-server

feature: @since/@deprecated/@removed annotations for 3rd party libraries

Abierto
#1,132 0 comentarios 4 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

enhancement feat/LuaCats Annotations
Lenguaje dominante
Lua
Estrellas
4.4k
Forks
442
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

I'd love it if we were able to use version markers for 3rd party libraries. OpenResty annotations would benefit from this.

## annotation example

```lua
---@meta
local lib = {}

--- This function was added in lib 1.1.3
---
---@param a string
---@param b string
---@since 1.1.3
function lib.new(a, b) end

--- This function was added in lib 1.1.0 but has been deprecated since 2.0
---
---@param a string
---@param b string
---@since 1.1.0
---@deprecated 2.0
function lib.deprecated(a, b) end

--- This function was added in lib 1.1.0 but has been deprecated since 2.0 and removed in 3.0
---
---@param a string
---@param b string
---@since 1.1.0
---@deprecated 2.0
---@removed 3.0
function lib.removed(a, b) end

--- This function was added in lib 1.0
---
---@param a string
---@param b string
---@since 1.0
function lib.updated(a, b) end

--- ...and the signature was changed in lib 2.0 to add a 3rd param
---
---@param a string
---@param b string
---@param c string
---@since 2.0
function lib.updated(a, b, c) end

return lib
```

Initially, the language server could just add these things to the function's documentation.

Once this feature is in place, the next stage would be to make the language server aware of which version of $library is being used. Then, the language server could use this contextual info:

* provide type hints, docs, etc that are specific for the version being used (see `lib.updated` from my example)
* provide diagnostics
* "warning: `lib.deprecated` has been deprecated in version 2.0 (your version: 2.1)"
* "error: `lib.removed` was removed in version 3.0 (your version: 4.7)"

## discovering the library version

Here are some ideas I have:

### explicitly-configured by the user

`.luarc.json`

```json
{
"workspace": {
"library.version": {
"OpenResty": "1.2.3",
},
}
}
```

### discoverable from meta/3rd/$lib/config.lua

#### top-level `version` declaration

```lua
version = function(workspace_dir)
-- do something to determine the version
return require("my_library").meta.version
end
```

#### using config actions

```lua
configs = {
{
key = 'Lua.workspace.library.version.OpenResty',
action = 'set',
value = (function()
return require("my_library").meta.version
end)(),
},
}
```

### per-module annotation

#### by library author, from table key

```lua
-- lib.lua

---@version-from-field _VERSION
local lib = {
_VERSION = "1.2.3",
}
return lib
````

```lua
-- main.lua

local lib = require "lib" -- version is 1.2.3
```

#### by library author, from annotation

```lua
-- lib.lua

---@version 1.2.3
local lib = {}
return lib
```

```lua
-- main.lua

local lib = require "lib" -- version is 1.2.3
```

#### by library user

```lua
---@version 1.2.3
local lib = require "lib"
```

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Read the annotation examples first, then compare the proposed .luarc.json, meta/3rd/$lib/config.lua, and per-module version sources. The issue does not name implementation files or tests and describes several possible stages, so first agree on the scope for exposing @since, @deprecated, and @removed in library documentation. Done should include defined annotation syntax and version-source behavior.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
lua
Área
tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.