LuaLS / LuaLS/lua-language-server

The `set` pattern for `single range char` is not working in glob

Open
#2,754 2 comments 0 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

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Windows

What is the issue affecting?

Diagnostics/Syntax Checking

Expected Behaviour

I am testing the glob like pattern used in Lua.doc.<scope>Name, and the set pattern seems not working for single character.

  • .luarc.jsonc
{
    "doc.privateName": [
        "_[aeiouA-Z]"   // underscore followed by any upper letter, or lower letters a|e|i|o|u
    ]
}
  • test.lua
---@class A
local A = {}
A._A = 1
A._Z = 1
A._a = 1
A._e = 1
A._z = 1
A._AA = 1
A._aa = 1

---@type A
local t = {}
print(t._A)     -- warning
print(t._Z)     -- warning
print(t._a)     -- warning
print(t._e)     -- warning
print(t._z)     -- ok
print(t._AA)    -- ok
print(t._aa)    -- ok
Actual Behaviour
---@type A
local t = {}
print(t._A)     -- warning
print(t._Z)     -- warning
print(t._a)     -- ok (false negative)
print(t._e)     -- ok (false negative)
print(t._z)     -- ok
print(t._AA)    -- ok
print(t._aa)    -- ok
  • the single range word aeiou is not working as expected
Reproduction steps

Use the provided snippet

Additional Notes

I know that the glob pattern syntax in defined using LPeg: https://github.com/LuaLS/lua-language-server/blob/ddc96bd1ec0be95a985ab82531763578bf7eb793/script/glob/glob.lua#L19-L46
I am not familiar with LPeg, but by adding a print(#range, range[1], range[2]) inside mt:range() here, those single range word seems don't even get parsed. 😕 https://github.com/LuaLS/lua-language-server/blob/ddc96bd1ec0be95a985ab82531763578bf7eb793/script/glob/matcher.lua#L99-L100

With a bit of testing, the RangeUnit definition seems should be changed from:

    ['RangeUnit']   = m.Ct(m.C(m.V'RangeWord') * m.P'-' * m.C(m.V'RangeWord'))
                    + m.V'RangeWord',

to =>

    ['RangeUnit']   = m.Ct(m.C(m.V'RangeWord') * m.P'-' * m.C(m.V'RangeWord'))
                    + m.Ct(m.C(m.V'RangeWord')),

Then the set logic for single range character starts to work 🎉
But I don't know why it works this way 🙈


Can anyone comment on my above suggested change?
If this is correct, I am going to open a PR. 🙂

Log File

No response

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 with script/glob/glob.lua and script/glob/matcher.lua, especially the RangeUnit grammar and mt:range(). Reproduce the behavior with the provided .luarc.jsonc and test.lua snippets, then verify that single-character ranges match the expected uppercase and vowel cases without changing multi-character behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.