Test: Shell integration manual install

[Tyriar]

Refs: #153921

• macOS @tanhakabir
• linux @deepak1556
• windows @hediet
• WSL @joyceerhl (or any remote)

Complexity: 3

Authors: @Tyriar, @meganrogge
Roles: Developer, Engineering Manager

Create Issue

---

Shell integration should be activated manually for the original shell launched in the terminal, but not in sub-shells. To workaround this you can manually install shell integration in your init scripts which will activate it even when launched outside VS Code. To test, read the updated documentation at https://github.com/microsoft/vscode-docs/blob/vnext/docs/terminal/shell-integration.md#manual-installation.

Some things to test in particular:

• Shell integration still works when manually installed and automatic injection is enabled and working
• Manual install doesn't break other terminals (the if condition blocks that)
• Try inlining the script https://github.com/microsoft/vscode-docs/blob/vnext/docs/terminal/shell-integration.md#portability-vs-performance

[hediet]

Shell integration is easily one of the coolest recent VS Code features 🤯

But I don't fully understand what I should test for this testplan-item (I'm a shell noob). Can you give some concrete steps?

[meganrogge]

@hediet https://code.visualstudio.com/docs/terminal/shell-integration#_features should help 😄

[meganrogge]

created #156330 bc was going to ask if you'd seen that there's a learn more about shell integration action in the command decoration's context menu, but that link is wrong ATM

[joyceerhl]

I installed shell activation for bash on WSL and verified that

• automatic script injection continued to work for terminals created in VS Code with Remote-WSL

• manual script injection worked for subshells, i.e. if I ran bash in the integrated terminal, command decorations continued to work (e.g. I could use them to rerun a command)

• I could still create a WSL bash terminal outside of VS Code and the terminal wasn't bricked
• inlining the script path worked (though I didn't see a perf hit in the first place)

Let me know if I missed anything in the setup, as I'm not a terminal power user and went off of the docs that @meganrogge shared 🙂

[hediet]

pwsh

Add the following to your PowerShell profile, replacing with VS Code's installation directory. Run code $Profile in pwsh to open the file in VS Code.

if ($env:TERM_PROGRAM -eq "vscode") {
. "\resources\app\out\vs\workbench\contrib\terminal\browser\media\shellIntegration.ps1"
}

I am missing <InstallDir> here. I think it should be:

if ($env:TERM_PROGRAM -eq "vscode") {
. "<InstallDir>\resources\app\out\vs\workbench\contrib\terminal\browser\media\shellIntegration.ps1"
}

[meganrogge]

@hediet could you pls clarify what you mean above?

[hediet]

I think your confusion also explains my confusion :D
Markdown removed <InstallDir> from the path, both in my comment and probably also in the docs.
I updated my comment.