Getting Started with Powershell in VS Code

Ok, it is time. Time to understand scripting.

I have been using Scratch Org for a while now and it is tedious to set them up. But I’ve been scared of scripting.

1. because most devs are mac users

2. because most devs think you just know about bash and how to use bash

3. because admitting you don’t know about scripting is like admitting you don’t know how to breathe to some devs

4. because powershell seems like it’s own coding language

Now, at least I have touched unix in a previous life and know about some unix commands and have used vi back in the dim dark distant past, so at least I would know how to quit vim these days, or at least know that there is a trick to quitting it and why that trick exists.

End Result:

• I want to have a few aliases to shortcut DX commands

• I want to have a script that I can create a scratch org with

That’s about it.

Trailhead

This module might be helpful https://trailhead.salesforce.com/content/learn/modules/cli-basics

But you DO NOT NEED NODE OR NPM! (Yet). So ignore the Mac specific bits in the third module.

Getting Started

Well, you need to start at the begining… and gee is that hard. First of all just how many versions of Powershell are there? And does it need to be stand-alone or can it run in VS Code?

So keeping thing simple I started using the Integrated Powershell Terminal in VS Code - I don’t want a separate terminal.

When googling, you are not writing Powershell Scripts in VS Code, so it’s quite confusing.

The Integrated terminal in VS Code defaults to Powershell in Windows 10. See integrated terminal docs.

Use the Command Terminal: Select Default Shell to set Powershell as the default shell.

When you open Terminal PS then the folder name should be shown as the prompt

PS C:\Users\JodieM>

Set the Profile

I started with Peter Chittum’s Apply the Salesforce CLI to Everyday Problems. Thankfully Peter is talking about Powershell and Bash these days. I went to the Github repo and all of a sudden was stuck. What is the ISE? Wh do I need to know about that? What is a profile? And everything past about half way in that video is a bit over my head - when he starts talking about “tail”, then I know he’s not talking to me. It’s like devs who just say “touch” the file. You know you are talking to a Mac dev and you know to just ignore and walk away and try to find someone that can speak your language.

So I think what he’s doing is trying to get you to have a default set of commands that open up each time you open VS Code. This is stored in a profile it seems. I could not work out Peter’s instructions though.

I found a simple set of instructions that were basically the same as Peter’s instructions… the trick is to start in VS Code and don’t leave VS Code. And don’t install the Powershell VS Code Extension.

I found this article to be helpful.

Test-Path $profile

This returns false

New-Item -path $profile -type file –force

this returns the folder where the profile is stored. I opened the folder in my file explorer then opened the profile file in vscode.

The file is Microsoft.PowerShell_profile.ps1 and is created in C:\Users\<username>\Documents\PowerShell\

You may also need to do the following. “If the Execution Policy is set to RemoteSigned, you can run only foreign scripts from Trusted Publisher, but you can also run your own scripts (that are not signed).” From this article.

 Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Paste the contents of Peter Chittum’s sample profile into that file https://github.com/pchittum/everyday-sfcli/blob/master/utils/powershell-profile/Set-RecommendedProfileItems.ps1. But remove the cd~ at the top as that changes the directory out of your current working SFDX directory and you don’t want that.

Save, then Reload VS Code.

Open the terminal and type:

dxlist

A list of your scratch orgs appear! Magic!

We now have aliases!

dxlist --all

still works too!

Extending Functions

Now we can see in Peter’s example that functions can be a bit more interactive.

Function dxopen ([string]$u) {
    If ($u -ne '') {
        sfdx force:org:open -u $u     
    } Else {
        sfdx force:org:open
    }
}

so now we can see we can add parameters to functions. The $u is saying whatever is entered directly after dxopen then stick it after the command sfdx force:org:open -u

So I want to add another command like that to set default org.

sfdx force:config:set defaultusername=

Function dxdefault ([string]$u) {
    If ($u -ne '') {
        sfdx force:config:set defaultusername=$u     
    } Else {
        Return ''
    }
}

Reload VS Code

Type

dxdefault yourOrgAlias

The default org is now set.

Now you can use the window icon in the status bar to open that org.

That’s enough for now. At least we have some simple aliases.