new setting Lua.diagnostics.workspaceEvent

set the time to trigger workspace diagnostics.
resolve #1626

Author: sumneko

changelog.md

@@ -3,6 +3,7 @@
 ## 3.6.0
 * `NEW` settings:
   * `Lua.misc.executablePath`: [#1557] specify the executable path in VSCode
+  * `Lua.diagnostics.workspaceEvent`: [#1626] set the time to trigger workspace diagnostics.
 * `NEW` CLI `--doc [path]` to make docs.  
 server will generate `doc.json` and `doc.md` in `LOGPATH`.  
 `doc.md` is generated by `doc.json` by example code `script/cli/doc2md.lua`.
@@ -54,6 +55,7 @@ server will generate `doc.json` and `doc.md` in `LOGPATH`.
 [#1599]: https://github.com/sumneko/lua-language-server/issues/1599
 [#1606]: https://github.com/sumneko/lua-language-server/issues/1606
 [#1608]: https://github.com/sumneko/lua-language-server/issues/1608
+[#1626]: https://github.com/sumneko/lua-language-server/issues/1626
 [#1637]: https://github.com/sumneko/lua-language-server/issues/1637
 
 ## 3.5.6

locale/en-us/setting.lua

@@ -77,8 +77,16 @@ Modify the diagnostic needed file status in a group.
 `Fallback` means that diagnostics in this group are controlled by `diagnostics.neededFileStatus` separately.
 Other settings will override individual settings without end of `!`.
 ]]
+config.diagnostics.workspaceEvent =
+"Set the time to trigger workspace diagnostics."
+config.diagnostics.workspaceEvent.OnChange =
+"Trigger workspace diagnostics when the file is changed."
+config.diagnostics.workspaceEvent.OnSave =
+"Trigger workspace diagnostics when the file is saved."
+config.diagnostics.workspaceEvent.None =
+"Disable workspace diagnostics."
 config.diagnostics.workspaceDelay =
-"Latency (milliseconds) for workspace diagnostics. When you start the workspace, or edit any file, the entire workspace will be re-diagnosed in the background. Set to negative to disable workspace diagnostics."
+"Latency (milliseconds) for workspace diagnostics."
 config.diagnostics.workspaceRate  =
 "Workspace diagnostics run rate (%). Decreasing this value reduces CPU usage, but also reduces the speed of workspace diagnostics. The diagnosis of the file you are currently editing is always done at full speed and is not affected by this setting."
 config.diagnostics.libraryFiles   =

locale/pt-br/setting.lua

@@ -77,8 +77,16 @@ Modify the diagnostic needed file status in a group.
 `Fallback` means that diagnostics in this group are controlled by `diagnostics.neededFileStatus` separately.
 Other settings will override individual settings without end of `!`.
 ]]
+config.diagnostics.workspaceEvent = -- TODO: need translate!
+"Set the time to trigger workspace diagnostics."
+config.diagnostics.workspaceEvent.OnChange = -- TODO: need translate!
+"Trigger workspace diagnostics when the file is changed."
+config.diagnostics.workspaceEvent.OnSave = -- TODO: need translate!
+"Trigger workspace diagnostics when the file is saved."
+config.diagnostics.workspaceEvent.None = -- TODO: need translate!
+"Disable workspace diagnostics."
 config.diagnostics.workspaceDelay = -- TODO: need translate!
-"Latency (milliseconds) for workspace diagnostics. When you start the workspace, or edit any file, the entire workspace will be re-diagnosed in the background. Set to negative to disable workspace diagnostics."
+"Latency (milliseconds) for workspace diagnostics."
 config.diagnostics.workspaceRate  = -- TODO: need translate!
 "Workspace diagnostics run rate (%). Decreasing this value reduces CPU usage, but also reduces the speed of workspace diagnostics. The diagnosis of the file you are currently editing is always done at full speed and is not affected by this setting."
 config.diagnostics.libraryFiles   = -- TODO: need translate!

locale/zh-cn/setting.lua

@@ -76,8 +76,16 @@ config.diagnostics.groupFileStatus =
 设置为 `Fallback` 意味着组中的诊断由 `diagnostics.neededFileStatus` 单独设置。
 其他设置将覆盖单独设置，但是不会覆盖以 `!` 结尾的设置。
 ]]
+config.diagnostics.workspaceEvent =
+"设置触发工作区诊断的时机。"
+config.diagnostics.workspaceEvent.OnChange =
+"当文件发生变化时触发工作区诊断。"
+config.diagnostics.workspaceEvent.OnSave =
+"当文件保存时触发工作区诊断。"
+config.diagnostics.workspaceEvent.None =
+"关闭工作区诊断。"
 config.diagnostics.workspaceDelay =
-"进行工作区诊断的延迟（毫秒）。当你启动工作区，或编辑了任意文件后，将会在后台对整个工作区进行重新诊断。设置为负数可以禁用工作区诊断。"
+"进行工作区诊断的延迟（毫秒）。"
 config.diagnostics.workspaceRate  =
 "工作区诊断的运行速率（百分比）。降低该值会减少CPU占用，但是也会降低工作区诊断的速度。你当前正在编辑的文件的诊断总是全速完成，不受该选项影响。"
 config.diagnostics.libraryFiles   =

locale/zh-tw/setting.lua

@@ -76,8 +76,16 @@ config.diagnostics.groupFileStatus =
 設定為 `Fallback` 意味著組中的診斷由 `diagnostics.neededFileStatus` 單獨設定。
 其他設定將覆蓋單獨設定，但是不會覆蓋以 `!` 結尾的設定。
 ]]
+config.diagnostics.workspaceEvent = -- TODO: need translate!
+"Set the time to trigger workspace diagnostics."
+config.diagnostics.workspaceEvent.OnChange = -- TODO: need translate!
+"Trigger workspace diagnostics when the file is changed."
+config.diagnostics.workspaceEvent.OnSave = -- TODO: need translate!
+"Trigger workspace diagnostics when the file is saved."
+config.diagnostics.workspaceEvent.None = -- TODO: need translate!
+"Disable workspace diagnostics."
 config.diagnostics.workspaceDelay =
-"進行工作區診斷的延遲（毫秒）。當你啟動工作區，或編輯了任何檔案後，將會在背景對整個工作區進行重新診斷。設定為負數可以停用工作區診斷。"
+"進行工作區診斷的延遲（毫秒）。"
 config.diagnostics.workspaceRate  =
 "工作區診斷的執行速率（百分比）。降低該值會減少CPU使用率，但是也會降低工作區診斷的速度。你目前正在編輯的檔案的診斷總是全速完成，不受該選項影響。"
 config.diagnostics.libraryFiles   =

script/config/template.lua

@@ -290,6 +290,11 @@ local template = {
                                             )
                                             >> util.deepCopy(define.DiagnosticDefaultGroupFileStatus),
     ['Lua.diagnostics.disableScheme']       = Type.Array(Type.String) >> { 'git' },
+    ['Lua.diagnostics.workspaceEvent']      = Type.String >> 'OnSave' << {
+                                                'OnChange',
+                                                'OnSave',
+                                                'None',
+                                            },
     ['Lua.diagnostics.workspaceDelay']      = Type.Integer >> 3000,
     ['Lua.diagnostics.workspaceRate']       = Type.Integer >> 100,
     ['Lua.diagnostics.libraryFiles']        = Type.String  >> 'Opened' << {

script/provider/diagnostic.lua

@@ -391,23 +391,22 @@ function m.pullDiagnostic(uri, isScopeDiag)
     return full
 end
 
+---@param event string
 ---@param uri uri
-function m.refresh(uri)
+function m.refreshScopeDiag(event, uri)
     if not ws.isReady(uri) then
         return
     end
-
-    await.close('diag:' .. uri)
-    ---@async
-    await.call(function ()
-        await.setID('diag:' .. uri)
-        await.sleep(0.1)
-        xpcall(m.doDiagnostic, log.error, uri)
-    end)
-
     local scp     = scope.getScope(uri)
     local scopeID = 'diagnosticsScope:' .. scp:getName()
     await.close(scopeID)
+
+    local eventConfig = config.get(uri, 'Lua.diagnostics.workspaceEvent')
+
+    if eventConfig ~= event then
+        return
+    end
+
     ---@async
     await.call(function ()
         local delay = config.get(uri, 'Lua.diagnostics.workspaceDelay') / 1000
@@ -419,6 +418,21 @@ function m.refresh(uri)
     end)
 end
 
+---@param uri uri
+function m.refresh(uri)
+    if not ws.isReady(uri) then
+        return
+    end
+
+    await.close('diag:' .. uri)
+    ---@async
+    await.call(function ()
+        await.setID('diag:' .. uri)
+        await.sleep(0.1)
+        xpcall(m.doDiagnostic, log.error, uri)
+    end)
+end
+
 ---@async
 local function askForDisable(uri)
     if m.dontAskedForDisable then
@@ -613,6 +627,7 @@ files.watch(function (ev, uri) ---@async
         m.refresh(uri)
     elseif ev == 'update' then
         m.refresh(uri)
+        m.refreshScopeDiag('OnChange', uri)
     elseif ev == 'open' then
         if ws.isReady(uri) then
             m.resendDiagnostic(uri)
@@ -623,6 +638,8 @@ files.watch(function (ev, uri) ---@async
         or ws.isIgnored(uri) then
             m.clear(uri)
         end
+    elseif ev == 'save' then
+        m.refreshScopeDiag('OnSave', uri)
     end
 end)
 

script/provider/provider.lua

@@ -312,6 +312,22 @@ m.register 'textDocument/didChange' {
     end
 }
 
+m.register 'textDocument/didSave' {
+    capability = {
+        textDocumentSync = {
+            save = {
+                includeText = false,
+            },
+        }
+    },
+    ---@async
+    function (params)
+        local doc    = params.textDocument
+        local uri    = files.getRealUri(doc.uri)
+        files.onWatch('save', uri)
+    end
+}
+
 m.register 'textDocument/hover' {
     capability = {
         hoverProvider = true,