LuaLS / LuaLS/lua-language-server

Properties (getter/setter) support

Abierto
#2,874 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Lua
Estrellas
4.4k
Forks
442
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Lua's variables can act as C#-like properties by setting __newindex appropriately.

Getters and setters occasionally have different type signatures. However, the @field annotation can only represent one type.

-- hoge.meta.lua

---@meta

---@class Point
---@field x number
---@field y number
Point = {}

---@class Hoge
---@field position Point ⚠️ actually a property
Hoge = {}

---@return Hoge
function new_hoge() end
-- main.lua

local hoge = new_hoge()
hoge.position = { 3, 7 } -- emits "Missing required fields in type `Point`: `x`, `y`"
print(hoge.position.x)   -- 3.0
print(hoge.position.y)   -- 7.0

(Full sample program is here)

It should be annotated as "position's setter receives a table<number, number>, and its getter returns a Point."

How about adding a new syntax to describe this?

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

Comienza con los ejemplos de anotaciones en hoge.meta.lua y main.lua, y luego reproduce el diagnóstico de asignar una tabla a hoge.position. El issue no menciona archivos ni pruebas del repositorio, por lo que deben localizarse los puntos de entrada relevantes de las anotaciones y la comprobación de tipos. Se considera terminado cuando la sintaxis de anotaciones puede expresar tipos de setter y getter distintos y la asignación de ejemplo ya no informa de que faltan campos de Point.

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

Evaluación

Stack tecnológico
lua
Área
devtools
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.