offline diagnostic

Author: sumneko

.vscode/launch.json

@@ -21,7 +21,7 @@
 			],
 		},
 		{
-			"name": "attach",
+			"name": "🪡attach",
 			"type": "lua",
 			"request": "attach",
 			"stopOnEntry": false,
@@ -36,7 +36,7 @@
 			]
 		},
 		{
-			"name": "build-3rd-meta",
+			"name": "🍉build-3rd-meta",
 			"type": "lua",
 			"request": "launch",
 			"stopOnEntry": false,
@@ -53,5 +53,25 @@
 				"stderr",
 			],
 		},
+		{
+			"name": "🍖cli-check",
+			"type": "lua",
+			"request": "launch",
+			"stopOnEntry": false,
+			"program": "${workspaceRoot}/main.lua",
+			"luaexe": "${workspaceFolder}/bin/lua-language-server.exe",
+			"cpath": null,
+			"arg": [
+				"--check",
+				"${workspaceRoot}",
+			],
+			"luaVersion": "5.4",
+			"consoleCoding": "utf8",
+			"sourceCoding": "utf8",
+			"outputCapture": [
+				"print",
+				"stderr",
+			],
+		},
 	]
 }

changelog.md

@@ -1,6 +1,7 @@
 # changelog
 
 ## 2.6.7
+* `NEW` offline diagnostic, [read more](https://github.com/sumneko/lua-language-server/wiki/Offline-Diagnostic)
 * `FIX` [#965](https://github.com/sumneko/lua-language-server/issues/965)
 
 ## 2.6.6

locale/en-us/script.lua

@@ -511,3 +511,8 @@ PLUGIN_TRUST_NO                  =
 [[
 Don't load this plugin
 ]]
+
+CLI_CHECK_SUCCESS =
+'Diagnosis completed, no problems found'
+CLI_CHECK_RESULTS =
+'Diagnosis complete, {} problems found, see {}'

locale/zh-cn/script.lua

@@ -510,3 +510,8 @@ PLUGIN_TRUST_NO                  =
 [[
 不要加载此插件
 ]]
+
+CLI_CHECK_SUCCESS =
+'诊断完成，没有发现问题'
+CLI_CHECK_RESULTS =
+'诊断完成，共有 {} 个问题，请查看 {}'

main.lua

@@ -64,9 +64,8 @@ log.debug('LOGPATH:', LOGPATH)
 log.debug('METAPATH:', METAPATH)
 log.debug('VERSION:', version.getVersion())
 
-require 'ci'
-
 require 'tracy'
+require 'cli'
 
 xpcall(dofile, log.debug, (ROOT / 'debugger.lua'):string())
 

script/ci/check.lua

@@ -0,0 +1,76 @@
+local lclient = require 'lclient'
+local furi    = require 'file-uri'
+local ws      = require 'workspace'
+local files   = require 'files'
+local diag    = require 'provider.diagnostic'
+local util    = require 'utility'
+local json    = require 'json-beautify'
+local lang    = require 'language'
+local define  = require 'proto.define'
+local config  = require 'config.config'
+
+if type(CHECK) ~= 'string' then
+    print(('The argument of CHECK must be a string, but got %s'):format(type(CHECK)))
+end
+
+local rootUri = furi.encode(CHECK)
+if not rootUri then
+    print(('The argument of CHECK must be a valid uri, but got %s'):format(CHECK))
+end
+
+util.enableCloseFunction()
+
+local lastClock   = os.clock()
+local results = {}
+---@async
+lclient():start(function (client)
+    client:registerFakers()
+
+    client:initialize {
+        rootUri = rootUri,
+    }
+
+    client:register('textDocument/publishDiagnostics', function (params)
+        results[params.uri] = params.diagnostics
+    end)
+
+    ws.awaitReady(rootUri)
+
+    local checkLevel = define.DiagnosticSeverity[CHECKLEVEL] or define.DiagnosticSeverity.Warning
+    local disables   = config.get(rootUri, 'Lua.diagnostics.disable')
+    for name, serverity in pairs(define.DiagnosticDefaultSeverity) do
+        serverity = config.get(rootUri, 'Lua.diagnostics.severity')[name] or 'Warning'
+        if define.DiagnosticSeverity[serverity] > checkLevel then
+            disables[name] = true
+        end
+    end
+    config.set(nil, 'Lua.diagnostics.disable', disables)
+
+    local uris = files.getAllUris(rootUri)
+    local max  = #uris
+    for i, uri in ipairs(uris) do
+        files.open(uri)
+        diag.doDiagnostic(uri, true)
+        if os.clock() - lastClock > 0.2 then
+            lastClock = os.clock()
+            print(('%d/%d'):format(i, max))
+        end
+    end
+end)
+
+local count = 0
+for uri, result in pairs(results) do
+    count = count + #result
+    if #result == 0 then
+        results[uri] = nil
+    end
+end
+
+if count == 0 then
+    print(lang.script('CLI_CHECK_SUCCESS'))
+else
+    local outpath = LOGPATH .. '/check.json'
+    util.saveFile(outpath, json.beautify(results))
+
+    print(lang.script('CLI_CHECK_RESULTS', count, outpath))
+end

script/cli/check.lua

@@ -1,9 +1,9 @@
 if _G['VERSION'] then
-    require 'ci.version'
+    require 'cli.version'
     os.exit(0, true)
 end
 
 if _G['CHECK'] then
-    require 'ci.check'
+    require 'cli.check'
     os.exit(0, true)
 end

script/ci/init.lua script/cli/init.luascript/ci/init.lua renamed to script/cli/init.lua

@@ -389,7 +389,7 @@ function m.isReady()
 end
 
 local function hookPrint()
-    if TEST then
+    if TEST or CLI then
         return
     end
     print = function (...)