Feat: Running truffle debug with appropriate flag (--vscode) triggers debugger to launch / run in VS Code

[xhulz]

PR description

ref: #203

Running truffle debug with appropriate flag (--vscode) triggers debugger to launch / run in VS Code

The command line to execute the vscode debugger:

open 'vscode://trufflesuite-csi.truffle-vscode/debug?{"txHash":"0x97a81dbca1ea95263bb75b0147c99f263fe21cf702abe8974c310c9fa834d9b9","workingDirectory":"/Users/xhulz/Documents/xpto","providerUrl":"http://127.0.0.1:8545"}'

This command line is basically formed by: open 'app://extension_id/command_name?args'.

Important: If the Truffle vscode extension is not installed, vscode will ask if the user wants to install it. So, there is no reason to validate it earlier.

Breaking the command line:

• App: vscode
• Extension ID: trufflesuite-csi.truffle-vscode
• Command name: debug
• Args: {txHash: string, workingDirectory: string, providerUrl: string}

Example: {"txHash":"0x97a81dbca1ea95263bb75b0147c99f263fe21cf702abe8974c310c9fa834d9b9","workingDirectory":"/Users/xhulz/Documents/xpto","providerUrl":"http://127.0.0.1:8545"}

Documentation

• I thought about documentation and added the doc-change-required label to this PR if documentation updates are required.

[kevinbluer]

cc @gnidan for 👀

[gnidan]

Whoa! How does this work? You can tell VS Code to intercept a command given to the in-IDE shell? So VS Code will observe that you typed truffle debug --vscode and it'll override the default behavior and do its own thing?

[michaeljohnbennett]

LGTM!

[xhulz]

Hey @gnidan,

The vscode has a URI controller class like the apps have on mobile. It's a listener that listen to this protocol: vscode://. For example, if you put this line on web browser vscode://trufflesuite-csi.truffle-vscode/debug?{"txHash":"0x97a81dbca1ea95263bb75b0147c99f263fe21cf702abe8974c310c9fa834d9b9","workingDirectory":"/Users/xhulz/Documents/xpto","providerUrl":"http://127.0.0.1:8545"} it will call the vscode. I'd like to send you more information about that class, but unfortunately, vscode does not have a good documentation, so every time we need to dig on the vscode repo to discover this things...

In the Truffle case, we will have to receive (on Truffle CLI) the command truffle debug --vscode and execute an internal CLI command calling open 'vscode://trufflesuite-csi.truffle-vscode/debug?{"txHash":"0x97a81dbca1ea95263bb75b0147c99f263fe21cf702abe8974c310c9fa834d9b9","workingDirectory":"/Users/xhulz/Documents/xpto","providerUrl":"http://127.0.0.1:8545"}' or even doing some like window.open('vscode://trufflesuite-csi.truffle-vscode/debug?{"txHash":"0x97a81dbca1ea95263bb75b0147c99f263fe21cf702abe8974c310c9fa834d9b9","workingDirectory":"/Users/xhulz/Documents/xpto","providerUrl":"http://127.0.0.1:8545"}').

If i can help, just let me know :)

Cheers!

[acuarica]

lgtm

[xhulz]

Ok @acuarica,

Your suggestions have been implemented

Thank you

[gnidan]

Oh, just to clarify: ideally we can interface with the extension from any terminal. I was just asking the question in case that's not easy.