Add setting to find globals using regex

doc/en-us/config.md

@@ -406,6 +406,22 @@ Array<string>
 []
 ```
 
+# diagnostics.globalsRegex
+
+Find defined global variables using regex.
+
+## type
+
+```ts
+Array<string>
+```
+
+## default
+
+```jsonc
+[]
+```
+
 # diagnostics.groupFileStatus
 
 Modify the diagnostic needed file status in a group.

doc/pt-br/config.md

@@ -406,6 +406,22 @@ Array<string>
 []
 ```
 
+# diagnostics.globalsRegex
+
+Find defined global variables using regex.
+
+## type
+
+```ts
+Array<string>
+```
+
+## default
+
+```jsonc
+[]
+```
+
 # diagnostics.groupFileStatus
 
 Modify the diagnostic needed file status in a group.

doc/zh-cn/config.md

@@ -406,6 +406,22 @@ Array<string>
 []
 ```
 
+# diagnostics.globalsRegex
+
+Find defined global variables using regex.
+
+## type
+
+```ts
+Array<string>
+```
+
+## default
+
+```jsonc
+[]
+```
+
 # diagnostics.groupFileStatus
 
 批量修改一个组中的文件状态。

doc/zh-tw/config.md

@@ -406,6 +406,22 @@ Array<string>
 []
 ```
 
+# diagnostics.globalsRegex
+
+Find defined global variables using regex.
+
+## type
+
+```ts
+Array<string>
+```
+
+## default
+
+```jsonc
+[]
+```
+
 # diagnostics.groupFileStatus
 
 批量修改一個組中的檔案狀態。

locale/en-us/setting.lua

@@ -48,6 +48,8 @@ config.diagnostics.disable        =
 "Disabled diagnostic (Use code in hover brackets)."
 config.diagnostics.globals        =
 "Defined global variables."
+config.diagnostics.globalsRegex   =
+"Find defined global variables using regex."
 config.diagnostics.severity       =
 [[
 Modify the diagnostic severity.

locale/pt-br/setting.lua

@@ -48,6 +48,8 @@ config.diagnostics.disable        = -- TODO: need translate!
 "Disabled diagnostic (Use code in hover brackets)."
 config.diagnostics.globals        = -- TODO: need translate!
 "Defined global variables."
+config.diagnostics.globalsRegex   = -- TODO: need translate!
+"Find defined global variables using regex."
 config.diagnostics.severity       = -- TODO: need translate!
 [[
 Modify the diagnostic severity.

locale/zh-cn/setting.lua

@@ -48,6 +48,8 @@ config.diagnostics.disable        =
 "禁用的诊断（使用浮框括号内的代码）。"
 config.diagnostics.globals        =
 "已定义的全局变量。"
+config.diagnostics.globalsRegex   = -- TODO: need translate!
+"Find defined global variables using regex."
 config.diagnostics.severity       =
 [[
 修改诊断等级。

locale/zh-tw/setting.lua

@@ -48,6 +48,8 @@ config.diagnostics.disable        =
 "停用的診斷（使用浮框括號內的程式碼）。"
 config.diagnostics.globals        =
 "已定義的全域變數。"
+config.diagnostics.globalsRegex   = -- TODO: need translate!
+"Find defined global variables using regex."
 config.diagnostics.severity       =
 [[
 修改診斷等級。

script/config/template.lua

@@ -242,6 +242,7 @@ local template = {
                                             >> util.deepCopy(define.BuiltIn),
     ['Lua.diagnostics.enable']              = Type.Boolean >> true,
     ['Lua.diagnostics.globals']             = Type.Array(Type.String),
+    ['Lua.diagnostics.globalsRegex']        = Type.Array(Type.String),
     ['Lua.diagnostics.disable']             = Type.Array(Type.String << util.getTableKeys(diag.getDiagAndErrNameMap(), true)),
     ['Lua.diagnostics.severity']            = Type.Hash(
                                                 Type.String << util.getTableKeys(define.DiagnosticDefaultNeededFileStatus, true),

script/core/diagnostics/global-element.lua

@@ -17,6 +17,20 @@ local function isDocClass(source)
     return false
 end
 
+local function isGlobalRegex(name, definedGlobalRegex)
+    if not definedGlobalRegex then
+        return false
+    end
+
+    for _, pattern in ipairs(definedGlobalRegex) do
+        if name:match(pattern) then
+            return true
+        end
+    end
+
+    return false
+end
+
 -- If global elements are discouraged by coding convention, this diagnostic helps with reminding about that
 -- Exceptions may be added to Lua.diagnostics.globals
 return function (uri, callback)
@@ -26,6 +40,7 @@ return function (uri, callback)
     end
 
     local definedGlobal = util.arrayToHash(config.get(uri, 'Lua.diagnostics.globals'))
+    local definedGlobalRegex = config.get(uri, 'Lua.diagnostics.globalsRegex')
 
     guide.eachSourceType(ast.ast, 'setglobal', function (source)
         local name = guide.getKeyName(source)
@@ -36,6 +51,9 @@ return function (uri, callback)
         if isDocClass(source) then
             return
         end
+        if isGlobalRegex(name, definedGlobalRegex) then
+            return
+        end
         if definedGlobal[name] == nil then
             definedGlobal[name] = false
             local global = vm.getGlobal('variable', name)

script/core/diagnostics/lowercase-global.lua

@@ -17,6 +17,20 @@ local function isDocClass(source)
     return false
 end
 
+local function isGlobalRegex(name, definedGlobalRegex)
+    if not definedGlobalRegex then
+        return false
+    end
+
+    for _, pattern in ipairs(definedGlobalRegex) do
+        if name:match(pattern) then
+            return true
+        end
+    end
+
+    return false
+end
+
 -- 不允许定义首字母小写的全局变量（很可能是拼错或者漏删）
 return function (uri, callback)
     local ast = files.getState(uri)
@@ -25,6 +39,7 @@ return function (uri, callback)
     end
 
     local definedGlobal = util.arrayToHash(config.get(uri, 'Lua.diagnostics.globals'))
+    local definedGlobalRegex = config.get(uri, 'Lua.diagnostics.globalsRegex')
 
     guide.eachSourceType(ast.ast, 'setglobal', function (source)
         local name = guide.getKeyName(source)
@@ -42,6 +57,9 @@ return function (uri, callback)
         if isDocClass(source) then
             return
         end
+        if isGlobalRegex(name, definedGlobalRegex) then
+            return
+        end
         if definedGlobal[name] == nil then
             definedGlobal[name] = false
             local global = vm.getGlobal('variable', name)

script/vm/global.lua

@@ -539,21 +539,60 @@ function vm.hasGlobalSets(suri, cate, name)
     return true
 end
 
+---@param uri uri
+---@param key string
+---@return boolean
+local function checkIsGlobalRegex(uri, key)
+    local dglobalsregex = config.get(uri, 'Lua.diagnostics.globalsRegex')
+    if not dglobalsregex then
+        return false
+    end
+
+    for _, pattern in ipairs(dglobalsregex) do
+        if key:match(pattern) then
+            return true
+        end
+    end
+
+    return false
+end
+
 ---@param src parser.object
 local function checkIsUndefinedGlobal(src)
+    if src.type ~= 'getglobal' then
+        return false
+    end
+
     local key = src[1]
+    if not key then
+        return false
+    end
+
+    local node = src.node
+    if node.tag ~= '_ENV' then
+        return false
+    end
 
     local uri = guide.getUri(src)
-    local dglobals = util.arrayToHash(config.get(uri, 'Lua.diagnostics.globals'))
     local rspecial = config.get(uri, 'Lua.runtime.special')
+    if rspecial[key] then
+        return false
+    end
 
-    local node = src.node
-    return src.type == 'getglobal' and key and not (
-        dglobals[key] or
-        rspecial[key] or
-        node.tag ~= '_ENV' or
-        vm.hasGlobalSets(uri, 'variable', key)
-    )
+    if vm.hasGlobalSets(uri, 'variable', key) then
+        return false
+    end
+
+    local dglobals = config.get(uri, 'Lua.diagnostics.globals')
+    if util.arrayHas(dglobals, key) then
+        return false
+    end
+
+    if checkIsGlobalRegex(uri, key) then
+        return false
+    end
+
+    return true
 end
 
 ---@param src parser.object