add LS integration

aviatesk · aviatesk · commit 510d5f94c2ab · 2025-07-08T16:43:38.000+09:00
diff --git a/src/JETLS.jl b/src/JETLS.jl
@@ -41,6 +41,7 @@ Analyzer.LSAnalyzer(args...; kwargs...) = LSAnalyzer(ScriptAnalysisEntry(filepat
 include("analysis/resolver.jl")
 
 include("testrunner-types.jl")
+include("report-trim-types.jl")
 include("types.jl")
 
 include("utils/general.jl")
@@ -69,6 +70,7 @@ include("diagnostics.jl")
 include("code-lens.jl")
 include("code-action.jl")
 include("testrunner.jl")
+include("report-trim.jl")
 include("response.jl")
 include("lifecycle.jl")
 
diff --git a/src/code-lens.jl b/src/code-lens.jl
@@ -33,6 +33,7 @@ function handle_CodeLensRequest(server::Server, msg::CodeLensRequest)
     end
     code_lenses = CodeLens[]
     testrunner_code_lenses!(code_lenses, uri, fi)
+    report_trim_code_lens!(code_lenses, uri, fi)
     return send(server,
         CodeLensResponse(;
             id = msg.id,
diff --git a/src/document-synchronization.jl b/src/document-synchronization.jl
@@ -126,6 +126,7 @@ function handle_DidChangeTextDocumentNotification(server::Server, msg::DidChange
     text = last(contentChanges).text
     fi = cache_file_info!(server.state, uri, textDocument.version, text)
     update_testsetinfos!(server, fi)
+    update_entrypoint!(server, fi)
 end
 
 function handle_DidSaveTextDocumentNotification(server::Server, msg::DidSaveTextDocumentNotification)
diff --git a/src/execute-command.jl b/src/execute-command.jl
@@ -6,11 +6,16 @@ const COMMAND_TESTRUNNER_RUN_TESTCASE = "JETLS.TestRunner.run@test"
 const COMMAND_TESTRUNNER_CLEAR_RESULT = "JETLS.TestRunner.clearResult"
 const COMMAND_TESTRUNNER_OPEN_LOGS = "JETLS.TestRunner.openLogs"
 
+const COMMAND_REPORT_TRIM_RUN = "JETLS.ReportTrim.run"
+const COMMAND_REPORT_TRIM_CLEAR_RESULT = "JETLS.ReportTrim.clearResult"
+
 const SUPPORTED_COMMANDS = [
     COMMAND_TESTRUNNER_RUN_TESTSET,
     COMMAND_TESTRUNNER_RUN_TESTCASE,
     COMMAND_TESTRUNNER_OPEN_LOGS,
     COMMAND_TESTRUNNER_CLEAR_RESULT,
+    COMMAND_REPORT_TRIM_RUN,
+    COMMAND_REPORT_TRIM_CLEAR_RESULT,
 ]
 
 function execute_command_options()
@@ -42,6 +47,10 @@ function handle_ExecuteCommandRequest(server::Server, msg::ExecuteCommandRequest
         return execute_testrunner_open_logs_command(server, msg)
     elseif command == COMMAND_TESTRUNNER_CLEAR_RESULT
         return execute_testrunner_clear_result_command(server, msg)
+    elseif command == COMMAND_REPORT_TRIM_RUN
+        return execute_report_trim_run_command(server, msg)
+    elseif command == COMMAND_REPORT_TRIM_CLEAR_RESULT
+        return execute_report_trim_clear_result_command(server, msg)
     end
     return send(server,
         invalid_execute_command_response(msg, "Unknown execution command: $command"))
@@ -140,3 +149,30 @@ function execute_testrunner_clear_result_command(server::Server, msg::ExecuteCom
             id = msg.id,
             result = null))
 end
+
+function execute_report_trim_run_command(server::Server, msg::ExecuteCommandRequest)
+    uri = convert(URI, @tryparsearg server msg[1]::String)
+    error_msg = report_trim_run_from_uri(server, uri)
+    if error_msg !== nothing
+        show_error_message(server, error_msg)
+        return send(server,
+            ExecuteCommandResponse(;
+                id = msg.id,
+                result = nothing,
+                error = request_failed_error(error_msg)))
+    end
+    return send(server,
+        ExecuteCommandResponse(;
+            id = msg.id,
+            result = null))
+end
+
+
+function execute_report_trim_clear_result_command(server::Server, msg::ExecuteCommandRequest)
+    uri = convert(URI, @tryparsearg server msg[1]::String)
+    try_clear_report_trim_result!(server, uri)
+    return send(server,
+        ExecuteCommandResponse(;
+            id = msg.id,
+            result = null))
+end
diff --git a/src/report-trim-types.jl b/src/report-trim-types.jl
@@ -0,0 +1,5 @@
+struct ReportTrimResult
+    filepath::String
+    success::Bool
+    diagnostics::Vector{Diagnostic}
+end
diff --git a/src/report-trim.jl b/src/report-trim.jl
@@ -0,0 +1,294 @@
+const REPORT_TRIM_DIAGNOSTIC_SOURCE = "JETLS - TrimAnalyzer"
+
+const REPORT_TRIM_RUN_TITLE = "▶ Run TrimAnalyzer"
+const REPORT_TRIM_RERUN_TITLE = "▶ Rerun TrimAnalyzer"
+const REPORT_TRIM_CLEAR_RESULT_TITLE = "✓ Clear result"
+
+function update_entrypoint!(server::Server, fi::FileInfo)
+    st0_top = build_tree!(JL.SyntaxTree, fi)
+    entrypoint = find_main_entrypoint(st0_top)
+    prev_entrypointinfo = fi.entrypointinfo
+    any_deleted = false
+
+    if isnothing(entrypoint)
+        if !isnothing(prev_entrypointinfo)
+            if isdefined(prev_entrypointinfo, :result)
+                key = prev_entrypointinfo.result.key
+                any_deleted |= clear_extra_diagnostics!(server, key)
+            end
+            fi.entrypointinfo = nothing
+        end
+    else
+        if !isnothing(prev_entrypointinfo)
+            if isdefined(prev_entrypointinfo, :result)
+                # Preserve the result if the entrypoint hasn't changed
+                fi.entrypointinfo = EntrypointInfo(entrypoint, prev_entrypointinfo.result)
+            else
+                fi.entrypointinfo = EntrypointInfo(entrypoint)
+            end
+        else
+            fi.entrypointinfo = EntrypointInfo(entrypoint)
+        end
+    end
+
+    if any_deleted
+        notify_diagnostics!(server)
+    end
+
+    return fi.entrypointinfo
+end
+
+# TODO support `function @main(args::Vector{String}) ... end`
+function find_main_entrypoint(st0_top::SyntaxTree0)
+    for st0 in JS.children(st0_top)
+        if JS.kind(st0) === JS.K"function" && JS.numchildren(st0) >= 2
+            st01 = st0[1]
+            if JS.kind(st01) === JS.K"call" && JS.numchildren(st01) >= 1
+                st011 = st01[1]
+                if JS.kind(st011) === JS.K"macrocall" && JS.numchildren(st011) >= 1
+                    st0111 = st011[1]
+                    if JS.kind(st0111) === JS.K"MacroName" && hasproperty(st0111, :name_val)
+                        if st0111.name_val == "@main"
+                            return st0
+                        end
+                    end
+                end
+            end
+        end
+    end
+    return nothing
+end
+
+function report_trim_code_lens!(code_lenses, uri::URI, fi::FileInfo)
+    entrypointinfo = fi.entrypointinfo
+    if isnothing(entrypointinfo)
+        return
+    end
+
+    range = get_source_range(entrypointinfo.st0)
+    run_arguments = Any[uri]
+
+    if isdefined(entrypointinfo, :result)
+        result = entrypointinfo.result.result
+        summary = result.success ? "✓ No dispatch errors" : "✗ $(length(result.diagnostics)) dispatch error(s)"
+
+        command = Command(;
+            title = "$REPORT_TRIM_RERUN_TITLE $summary",
+            command = COMMAND_REPORT_TRIM_RUN,
+            arguments = run_arguments)
+        push!(code_lenses, CodeLens(; range, command))
+
+        command = Command(;
+            title = REPORT_TRIM_CLEAR_RESULT_TITLE,
+            command = COMMAND_REPORT_TRIM_CLEAR_RESULT,
+            arguments = run_arguments)
+        push!(code_lenses, CodeLens(; range, command))
+    else
+        command = Command(;
+            title = REPORT_TRIM_RUN_TITLE,
+            command = COMMAND_REPORT_TRIM_RUN,
+            arguments = run_arguments)
+        push!(code_lenses, CodeLens(; range, command))
+    end
+
+    return code_lenses
+end
+
+function report_trim_cmd(filepath::String, env_path::Union{Nothing,String})
+    report_trim_exe = Sys.which("report-trim")
+    if isnothing(env_path)
+        return `$report_trim_exe --json $filepath`
+    else
+        return `$report_trim_exe --project=$env_path --json $filepath`
+    end
+end
+
+function report_trim_result_to_diagnostics(result::ReportTrimResult)
+    uri2diagnostics = URI2Diagnostics()
+    uri = filename2uri(result.filepath)
+    isnothing(uri) && return uri2diagnostics
+    uri2diagnostics[uri] = result.diagnostics
+    return uri2diagnostics
+end
+
+function report_trim_run(server::Server, uri::URI, fi::FileInfo, filepath::String;
+                         token::Union{Nothing,ProgressToken}=nothing)
+    if isnothing(Sys.which("report-trim"))
+        show_error_message(server, """
+            `report-trim` executable is not found on the `PATH`.
+            Please install TrimAnalyzer app to use this feature.
+            """)
+        return token !== nothing && end_report_trim_progress(server, token, "TrimAnalyzer not installed")
+    end
+
+    if token !== nothing
+        send(server, ProgressNotification(;
+            params = ProgressParams(;
+                token,
+                value = WorkDoneProgressBegin(;
+                    title = "Running TrimAnalyzer",
+                    cancellable = false))))
+    end
+
+    local result::String
+    try
+        result = _report_trim_run(server, uri, fi, filepath)
+    catch err
+        result = sprint(Base.showerror, err, catch_backtrace())
+        @error "Error from TrimAnalyzer executor" err
+        show_error_message(server, """
+            An unexpected error occurred while running TrimAnalyzer:
+            See the server log for details.
+            """)
+    finally
+        @assert @isdefined(result) "`result` should be defined at this point"
+        if token !== nothing
+            end_report_trim_progress(server, token, result)
+        end
+    end
+end
+
+function _report_trim_run(server::Server, uri::URI, fi::FileInfo, filepath::String)
+    env_path = find_uri_env_path(server.state, uri)
+    cmd = report_trim_cmd(filepath, env_path)
+
+    proc = open(cmd; read=true, write=false)
+    output = read(proc, String)
+    wait(proc)
+
+    result = try
+        JSONRPC.JSON3.read(output, ReportTrimResult)
+    catch err
+        @error "Error parsing TrimAnalyzer output" err output
+        show_error_message(server, """
+            Failed to parse TrimAnalyzer output.
+            See the server log for details.
+            """)
+        return "Analysis failed"
+    end
+
+    if !isnothing(fi.entrypointinfo)
+        key = ReportTrimDiagnosticsKey(fi)
+        report_trim_info = ReportTrimInfo(result, key)
+        fi.entrypointinfo = EntrypointInfo(fi.entrypointinfo.st0, report_trim_info)
+
+        uri2diagnostics = report_trim_result_to_diagnostics(result)
+        if !isempty(result.diagnostics)
+            server.state.extra_diagnostics[key] = uri2diagnostics
+        elseif haskey(server.state.extra_diagnostics, key)
+            delete!(server.state.extra_diagnostics, key)
+        end
+        notify_diagnostics!(server)
+
+        if supports(server, :workspace, :codeLens, :refreshSupport)
+            request_codelens_refresh!(server)
+        end
+    end
+
+    show_report_trim_result_in_message(server, result, fi, uri)
+
+    summary = result.success ? "✓ No dispatch errors found" : "✗ Found $(length(result.diagnostics)) dispatch error(s)"
+    return summary
+end
+
+function show_report_trim_result_in_message(server::Server, result::ReportTrimResult, fi::FileInfo, uri::URI)
+    summary = result.success ? "✓ No dispatch errors found" : "✗ Found $(length(result.diagnostics)) dispatch error(s)"
+    message = "TrimAnalyzer: $summary"
+
+    msg_type = if !result.success
+        MessageType.Error
+    else
+        MessageType.Info
+    end
+
+    actions = MessageActionItem[
+        MessageActionItem(; title = REPORT_TRIM_RERUN_TITLE),
+        MessageActionItem(; title = REPORT_TRIM_CLEAR_RESULT_TITLE)
+    ]
+
+    id = String(gensym(:ShowMessageRequest))
+    server.state.currently_requested[id] = ReportTrimMessageRequestCaller(uri, fi)
+
+    send(server, ShowMessageRequest(;
+        id,
+        params = ShowMessageRequestParams(;
+            type = msg_type,
+            message,
+            actions)))
+end
+
+function end_report_trim_progress(server::Server, token::ProgressToken, message::String)
+    send(server, ProgressNotification(;
+        params = ProgressParams(;
+            token,
+            value = WorkDoneProgressEnd(; message))))
+end
+
+struct ReportTrimMessageRequestCaller <: RequestCaller
+    uri::URI
+    fi::FileInfo
+end
+
+struct ReportTrimProgressCaller <: RequestCaller
+    uri::URI
+    fi::FileInfo
+    filepath::String
+    token::ProgressToken
+end
+
+function report_trim_run_from_uri(server::Server, uri::URI)
+    fi = get_file_info(server.state, uri)
+    if fi === nothing
+        return "File is no longer available in the editor"
+    end
+
+    if isnothing(fi.entrypointinfo)
+        return "No @main function found in this file"
+    end
+
+    sfi = get_saved_file_info(server.state, uri)
+    if sfi === nothing
+        return "The file appears not to exist on disk. Save the file first to run TrimAnalyzer."
+    elseif JS.sourcetext(fi.parsed_stream) ≠ JS.sourcetext(sfi.parsed_stream)
+        return "The editor state differs from the saved file. Save the file first to run TrimAnalyzer."
+    end
+
+    filepath = uri2filepath(uri)
+    if isnothing(filepath)
+        return "Cannot determine file path for the URI"
+    end
+
+    if supports(server, :window, :workDoneProgress)
+        id = String(gensym(:WorkDoneProgressCreateRequest_report_trim))
+        token = String(gensym(:ReportTrimProgress))
+        server.state.currently_requested[id] = ReportTrimProgressCaller(uri, fi, filepath, token)
+        params = WorkDoneProgressCreateParams(; token)
+        send(server, WorkDoneProgressCreateRequest(; id, params))
+    else
+        @async report_trim_run(server, uri, fi, filepath)
+    end
+
+    return nothing
+end
+
+
+function try_clear_report_trim_result!(server::Server, uri::URI)
+    fi = get_file_info(server.state, uri)
+    if fi === nothing || isnothing(fi.entrypointinfo)
+        return nothing
+    end
+
+    if isdefined(fi.entrypointinfo, :result)
+        fi.entrypointinfo = EntrypointInfo(fi.entrypointinfo.st0)
+
+        if clear_extra_diagnostics!(server, ReportTrimDiagnosticsKey(fi))
+            notify_diagnostics!(server)
+        end
+
+        if supports(server, :workspace, :codeLens, :refreshSupport)
+            request_codelens_refresh!(server)
+        end
+    end
+
+    return nothing
+end
diff --git a/src/response.jl b/src/response.jl
diff --git a/src/types.jl b/src/types.jl
