Add Swift: Capture VSCode Swift Diagnostic Logs command #830
Conversation
plemarquand
force-pushed
the
capture-diagnostics
branch
from
e1a0d24 to
efef4df
Compare
plemarquand
requested review from
adam-fowler,
matthewbastien,
daveyc123 and
award999
|
I have virtually never needed the diagnostics in the problems page when someone is submitting an issue. Things that are useful are swift log (which already includes swift version and paths), sourcekit-lsp log, user settings. |
plemarquand
force-pushed
the
capture-diagnostics
branch
2 times, most recently
from
adc0356 to
db4d1b8
Compare
|
@adam-fowler I've added sourcekit-lsp logs and user settings to the diagnostics. Sourcekit-lsp logs will only be captured if the user has the |
plemarquand
force-pushed
the
capture-diagnostics
branch
2 times, most recently
from
953bbae to
f1245e6
Compare
There was a problem hiding this comment.
Great stuff! I expect this will really help us diagnose issues more quickly. Do you want to add instructions to run the diagnose command to the GitHub issue template as well? We should probably only do that once a version of the extension with the diagnose command has been released.
There was a problem hiding this comment.
One more question. Do you think the following from #842 would be possible to implement?
As an added bonus, when sourcekitd crashes and SourceKit-LSP shows the
SourceKit-LSP: Restoring functionality: Please run 'sourcekit-lsp diagnose' to file an issuestatus (you can reproduce this by runningkillall SourceKitServicewhen having a project open), it would be great if there was a button to runsourcekit-lsp diagnose. I can add some indication to the work done progress that SourceKit-LSP sends for this.
plemarquand
force-pushed
the
capture-diagnostics
branch
from
f1245e6 to
6322a02
Compare
|
@ahoppen it looks like it should be pretty straightforward to watch the work done progress events. However, there is only |
|
I can totally add an ID for this to the work done progress that we can check for. Just wanted to verify that it’s possible on the VS Code side before I extend LSP. Let’s do this in a follow-up PR. |
|
@swift-server-bot test this please |
plemarquand
force-pushed
the
capture-diagnostics
branch
2 times, most recently
from
bc86a08 to
e923a90
Compare
plemarquand
force-pushed
the
capture-diagnostics
branch
from
e923a90 to
923af4e
Compare
plemarquand
force-pushed
the
capture-diagnostics
branch
from
923af4e to
b2f195c
Compare
Adds a new command that users can use to help generate bug reports for the extension itself. The Capture VSCode Swift Diagnostic Logs command will create a new folder in a temporary directory that contains: - Swift version and path information - Extension logs - Any diagnostics in the Problems pane Users can copy the folder path or, if they're on macOS, open it in Finder. From there they can zip and attach these files to a GitHub issue. We'll want to update the New Issue Template with instructions on how to capture and attach these logs.
plemarquand
force-pushed
the
capture-diagnostics
branch
from
b2f195c to
60979e2
Compare
Adds a new command that users can use to help generate bug reports for the extension itself. The Capture VSCode Swift Diagnostic Logs command will create a new folder in a temporary directory that contains:
Users can copy the folder path or, if they're on macOS, open it in Finder. From there they can zip and attach these files to a GitHub issue. We'll want to update the New Issue Template with instructions on how to capture and attach these logs.
Fixes #842