vs code on Cory Knox

Run PowerShell no matter what

Fri, 23 Feb 2024 00:00:00 +0000

VS Code is pretty amazing. Having the ability to edit virtually all of your files, and launch debugging sessions of them. But what if you have a codebase that has a .vscode/launch.json file and want to debug a PowerShell script?

Unfortunately, by default, F5 will only debug PowerShell if there are no debugger configurations. This means that pressing F5 will attempt to run the configured debugger for your workspace regardless of if you’re in a PowerShell file.

Fear not! Although by default you’re not able to run PowerShell code with F5 when a debugger configuration exists, you are able to tell VS Code you want to do this!

Doing it through the GUI 🔗

If you’d like to add this through the VS Code GUI, you can follow these steps:

Open the Keyboard Shortcuts UI (Ctrl + K, Ctrl + S by default, or search for Preferences: Keyboard Shortcuts with the Command Palette), then search for PowerShell: Run.
Locate and double click the entry for PowerShell: Run
Press F5 followed by Enter
Right click the entry and choose Change When Expression
Enter the following for the expression: editorTextFocus && debugState == 'inactive' && editorLangId == 'powershell'
Bask in the glory that is pressing F5 in a PowerShell script and always having it do what you expect it to do.

Doing it through the `keybindings.json` file 🔗

If you’d prefer to just copy/paste something into the settings files, you can add the below to your keybindings.json file:

[
    {
        "key": "f5",
        "command": "PowerShell.Debug.Start",
        "when": "editorTextFocus && debugState == 'inactive' && editorLangId == 'powershell'"
    }
]

You can locate your keybindings.json file through the Command Palette Preferences: Open Keyboard Shortcuts (JSON).

A Foray into vscode-powershell

Mon, 03 Sep 2018 00:00:00 +0000

This is a foray into getting started with the vscode-powershell extension. In particular noting some of the perhaps less obvious things I needed to do in order to get it to build on Ubuntu 18.04.

First thing you’ll need to do of course is to fork the repository. There are two repositories that we want to fork to our github account: PowerShellEditorService and vscode-powershell. Once you’ve forked them (and perhaps made hours of work that Tiler and Rob keep harrassing you as not being good enough…) you need to clone them to your local machine. I highly recommend keeping them side by side and so I clone them into a repos directory. On my Windows machine all of my git repos are stored at C:\repos\ on my fresh install of Ubuntu Linux 18.04 they’re stored at ~/git/.

System software to install 🔗

Now after freshly installing Ubuntu 18.04, I have installed the following software on top of the base:

PowerShell-Preview - PowerShell 6.1 is in Release Candidate, and is the only “Supported” version for Ubuntu 18.04
npm - Not entirely sure if I installed this one, or if it’s just installed as part of Ubuntu… It’s definitely installed though.
VS Code Insiders

Once this is installed, and the repos are cloned. I opened vscode-powershell in vscode-insiders. I then selected Debug > Start Debugging This greeted me with the message: “The preLaunchTask ‘BuildAll’ terminated with exit code 1.” Clearly we’re missing some pre-requisites… Looking in the terminal we see:

> Executing task: Invoke-Build BuildAll <

execvp(3) failed.: No such file or directory
The terminal process terminated with exit code: 1

Terminal will be reused by tasks, press any key to close it.

This initially felt like we were missing InvokeBuild from the PowerShell Gallery. Unfortunately, after installing that, the error is still present. The build appears to work if we do Invoke-Build from pwsh-preview.

It turns out that this is the trick here. We’re using a preview build of pwsh on Ubuntu 18.04, because that is what’s available. To resolve this, we can simply create a symlink from pwsh to pwsh-preview… This may need to be resolved once pwsh 6.1 leaves Release Candidate, or the installation of pwsh may resolve it for us. To create the symlink: sudo ln -s /usr/bin/pwsh-preview /usr/bin/pwsh. Once this symlink is created, debugging of both vscode-powershell and PowerShellEditorServices seems to go off without a hitch.

Conclusion 🔗

Once getting over the hurdle of pwsh not being available outside of a preview on Ubuntu 18.04, getting vscode-powershell and PowerShellEditorServices development going in Ubuntu 18.04 is actually really easy, and dare I say may be even easier than doing the same thing on Windows 10…

I did note while investigating the pwsh-preview issue that there are already documents that may provide more information (and will at least be more up to date than this document) here: vscode-powershell Development Document and here: PowerShellEditorServices ReadMe.

So you want to make a VS Code extension

Tue, 03 Jul 2018 00:00:00 +0000

So, you have this great idea for a VS Code extension? But perhaps you’re thinking “where do I start?” Well, fear not! for I have written this post to tell you the answer!

Oh? Were you expecting me to have the answer? Well, you see the truth is I have no idea. I just took some code, put some other code in it, and it worked (well sorta).

But for reals: Decide if you want to use TypeScript or JavaScript (I picked TypeScript because all the samples were in TypeScript). Then take a look at https://code.visualstudio.com/docs/extensions/example-hello-world to get your first example done.

If like me you have little experience with TypeScript, it is worth reading through this one to try and understand what it is doing. Also take a look at the examples: https://github.com/Microsoft/vscode-extension-samples I went here to look at the tree-view-sample for the one I’m working on.