LuaLS / LuaLS/lua-language-server

[Feature Request] Setting for case-insensitive require resolution?

Aperta
#2,845 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Priority
Low

Description
On Windows and Mac, file systems are case-insensitive by default. Lua's filepath resolution is based on the OS, so I feel like while only the exact spelling for a file should be autocompleted, when actually resolving the type of a module, lua-language-server should have an option to be case-insensitive.

Example

root/
├── myscript.lua
└── mymod.lua
-- myscript.lua --
local myMod = require "myMod"

Currently you can write a plugin similar to the one below using ResolveRequire

local libRoot = fs.current_path() / "library"

local function resolveCaseInsensitive(root, moduleName)
    for file in fs.pairs(root) do
        if fs.is_regular_file(file) then
            local fileName = file:filename():string()
            if fileName:lower() == (moduleName .. ".lua"):lower() then
                return file:string()
            end
        end
    end
end

---@param  uri  string # The URI of file
---@param  name string # Argument of require()
---@return string[]?
function ResolveRequire(uri, name)
    local libModuleFile = resolveCaseInsensitive(libRoot, name)
    local localModuleFile = resolveCaseInsensitive(fs.path(furi.decode(uri)), name)

    local result = {}
    if libModuleFile then
        result[#result+1] = furi.encode(libModuleFile)
    end
    if localModuleFile then
        result[#result+1] = furi.encode(localModuleFile)
    end

    if #result ~= 0 then
        return result
    end
end

Alternatively, I propose that a spellchecking diagnostic could be introduced for resolving module names. If a name matches the name of a known module in all except its case, a blue or yellow squiggly would underline the string, and the message could be something like "did you mean 'otherName'". This could be an opt-in diagnostic if it is considered a breaking change.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con l’hook del plugin ResolveRequire esistente e segui il percorso di risoluzione dei moduli di require(). Determina se il progetto debba implementare un’impostazione senza distinzione tra maiuscole e minuscole oppure una diagnostica opt-in, quindi individua i test pertinenti. Il lavoro è completato quando il comportamento selezionato gestisce le differenze nelle maiuscole e minuscole dei nomi dei moduli su Windows e macOS ed è coperto da test.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
lua
Ambito
devtools
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.