LuaLS / LuaLS/lua-language-server

[Feature Request] @mixin - @class specific syntax to define applied mixins

Aberta
#2,618 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
Lua
Estrelas
4.4k
Forks
442
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

# What
A way to indicate that the members of a `@class` type are applied to a subject `@class` outside of the inheritance chain

# Technical
`@mixin type, ...`
Adds the values of `type, ...` to the subject class' definition. Mixins are applied in the order they are specified; values of the same key are overwrote as each mixin is processed

### Example
This:
```lua
---@class Mixin1
---@field foo number
---@field bar number

---@class Mixin2
---@field bar string
---@field baz string

---@class Subject
---@field key boolean
---@field foo boolean
---@mixin Mixin1, Mixin2
```

Would get interpreted as
```lua
---@class Subject
---@field key boolean (defined by field; wasn't altered by mixins)
---@field foo number (defined by field, overwrote by mixin1, not overwrite by mixin2)
---@field bar string (defined by mixin1, overwrite by mixin2)
---@field baz string (defined by mixin2)
```

# Use case
I currently have sub-classes that get assigned valves from reusable dictionary tables outside their inheritance chain. The only way to document those modifications is to statically define the fields each time a mixin is applied

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Nenhum arquivo ou teste é especificado. Comece rastreando como o language server analisa as anotações @class existentes e a herança; em seguida, determine onde se encaixariam a aplicação ordenada de @mixin e a sobrescrita de campos. Considera-se concluído quando a sintaxe é analisada com as regras de precedência declaradas e coberta por testes para múltiplos mixins e colisões.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
lua
Domínio
devtools
Tipo de issue
Funcionalidade
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.