don't scan huge directories

* if `rootUri` or `workspaceFolder` is set to `ROOT` or `HOME`, this extension will refuse to load these directories and show an error message.
* show warning message when scanning more than 100,000 files.

Author: sumneko

changelog.md

@@ -5,6 +5,8 @@
   + `workspace.supportScheme`: `["file", "untitled", "git"]`
   + `diagnostics.disableScheme`: `["git"]`
 * `NEW` folding: support folding `---@alias`
+* `CHG` if `rootUri` or `workspaceFolder` is set to `ROOT` or `HOME`, this extension will refuse to load these directories and show an error message.
+* `CHG` show warning message when scanning more than 100,000 files.
 * `FIX` hover: can not union `table` with other basic types
 * `FIX` [#1125](https://github.com/sumneko/lua-language-server/issues/1125)
 * `FIX` [#1131](https://github.com/sumneko/lua-language-server/issues/1131)

locale/en-us/script.lua

@@ -142,6 +142,10 @@ WORKSPACE_DIAGNOSTIC      =
 'Diagnosing workspace'
 WORKSPACE_SKIP_HUGE_FILE  =
 'For performance reasons, the parsing of this file has been stopped: {}'
+WORKSPACE_NOT_ALLOWED     =
+'Your workspace is set to `{}`. Lua language server refused to load this directory. Please check your configuration.[learn more here](https://github.com/sumneko/lua-language-server/wiki/Why-scanning-home-folder)'
+WORKSPACE_SCAN_TOO_MUCH   =
+'More than {} files have been scanned. The current scanned directory is `{}`. Please confirm whether the configuration is correct.'
 
 PARSER_CRASH            =
 'Parser crashed! Last words:{}'

locale/pt-br/script.lua

@@ -142,6 +142,10 @@ WORKSPACE_DIAGNOSTIC      =
 'Diagnóstico de espaço de trabalho.'
 WORKSPACE_SKIP_HUGE_FILE  =
 'Por motivos de desempenho, a análise deste arquivo foi interrompida: {}'
+WORKSPACE_NOT_ALLOWED     = -- TODO: need translate!
+'Your workspace is set to `{}`. Lua language server refused to load this directory. Please check your configuration.[learn more here](https://github.com/sumneko/lua-language-server/wiki/Why-scanning-home-folder)'
+WORKSPACE_SCAN_TOO_MUCH   = -- TODO: need translate!
+'More than {} files have been scanned. The current scanned directory is `{}`. Please confirm whether the configuration is correct.'
 
 PARSER_CRASH            =
 'Parser quebrou! Últimas palavras: {}'

locale/zh-cn/script.lua

@@ -142,6 +142,10 @@ WORKSPACE_DIAGNOSTIC      =
 '正在对工作目录进行诊断'
 WORKSPACE_SKIP_HUGE_FILE  =
 '出于性能考虑，已停止对此文件解析：{}'
+WORKSPACE_NOT_ALLOWED     =
+'你的工作目录被设置为了 `{}`，Lua语言服务拒绝加载此目录，请检查你的配置。[了解更多](https://github.com/sumneko/lua-language-server/wiki/Why-scanning-home-folder)'
+WORKSPACE_SCAN_TOO_MUCH   =
+'已扫描了超过 {} 个文件，当前扫描的目录为 `{}`，请确认配置是否正确。'
 
 PARSER_CRASH            =
 '语法解析崩溃了！遗言：{}'

locale/zh-tw/script.lua

@@ -142,6 +142,10 @@ WORKSPACE_DIAGNOSTIC      =
 '正在對工作目錄進行診斷'
 WORKSPACE_SKIP_HUGE_FILE  =
 '出於效能考慮，已停止對此檔案解析：{}'
+WORKSPACE_NOT_ALLOWED     = -- TODO: need translate!
+'Your workspace is set to `{}`. Lua language server refused to load this directory. Please check your configuration.[learn more here](https://github.com/sumneko/lua-language-server/wiki/Why-scanning-home-folder)'
+WORKSPACE_SCAN_TOO_MUCH   = -- TODO: need translate!
+'More than {} files have been scanned. The current scanned directory is `{}`. Please confirm whether the configuration is correct.'
 
 PARSER_CRASH            =
 '語法解析崩潰了！遺言：{}'

script/glob/gitignore.lua

@@ -164,8 +164,9 @@ function mt:getRelativePath(path)
 end
 
 ---@param callback async fun(path: string)
+---@param hook? async fun(ev: string, ...)
 ---@async
-function mt:scan(path, callback)
+function mt:scan(path, callback, hook)
     local files = {}
     if type(callback) ~= 'function' then
         callback = nil
@@ -203,6 +204,9 @@ function mt:scan(path, callback)
             break
         end
         list[#list] = nil
+        if hook then
+            hook('scan', current)
+        end
         if not self:simpleMatch(current) then
             check(current)
         end

script/workspace/workspace.lua

@@ -13,6 +13,7 @@ local fw         = require 'filewatch'
 local scope      = require 'workspace.scope'
 local loading    = require 'workspace.loading'
 local inspect    = require 'inspect'
+local lang       = require 'language'
 
 ---@class workspace
 local m = {}
@@ -46,6 +47,11 @@ end
 --- 初始化工作区
 function m.create(uri)
     log.info('Workspace create: ', uri)
+    if uri == furi.encode '/'
+    or uri == furi.encode(os.getenv 'HOME') then
+        client.showMessage('Error', lang.script('WORKSPACE_NOT_ALLOWED', furi.decode(uri)))
+        return
+    end
     local path = m.normalize(furi.decode(uri))
     fw.watch(path)
     local scp = scope.createFolder(uri)
@@ -283,22 +289,34 @@ function m.awaitPreload(scp)
 
     if scp.uri then
         log.info('Scan files at:', scp:getName())
+        local count = 0
         ---@async
         native:scan(furi.decode(scp.uri), function (path)
             local uri = files.getRealUri(furi.encode(path))
             scp:get('cachedUris')[uri] = true
             ld:loadFile(uri)
+        end, function () ---@async
+            count = count + 1
+            if count == 100000 then
+                client.showMessage('Warning', lang.script('WORKSPACE_SCAN_TOO_MUCH', count, furi.decode(scp.uri)))
+            end
         end)
     end
 
     for _, libMatcher in ipairs(librarys) do
         log.info('Scan library at:', libMatcher.uri)
+        local count = 0
         scp:addLink(libMatcher.uri)
         ---@async
         libMatcher.matcher:scan(furi.decode(libMatcher.uri), function (path)
             local uri = files.getRealUri(furi.encode(path))
             scp:get('cachedUris')[uri] = true
             ld:loadFile(uri, libMatcher.uri)
+        end, function () ---@async
+            count = count + 1
+            if count == 100000 then
+                client.showMessage('Warning', lang.script('WORKSPACE_SCAN_TOO_MUCH', count, furi.decode(libMatcher.uri)))
+            end
         end)
         scp:gc(fw.watch(furi.decode(libMatcher.uri)))
     end
@@ -353,6 +371,7 @@ function m.normalize(path)
     if platform.OS == 'Windows' then
         path = path:gsub('[/\\]+', '\\')
                    :gsub('[/\\]+$', '')
+                   :gsub('^(%a:)$', '%1\\')
     else
         path = path:gsub('[/\\]+', '/')
                    :gsub('[/\\]+$', '')