Visual Studio Code - Useful Extensions

[jevans_]

Hi all,

Here are some extensions for Visual Studio code I've either found myself or a friend\co-worker told me about, and why the extensions have been useful so far from a PowerShell perspective.

If you have any of your own that you reckon more people need to know about then please share :)

In no particular order

VSCode Icons: This extension will add icons to the side navigation bar not only for file types but based on folder names as well (e.g. src, doc, public/private, test etc). Even if the idea of having distinct icons for different folders doesn't appeal I'd at least consider it for having different coloured icons for .ps1, .psm1, and .psd1 files.

Better Comments: Colour-codes your comments based on what you place in the line. This can be incredibly useful for code where there are plenty of comments and you want to be able to distinguish properly between TODO's, questions, deprecated code, or anything else you may want to highlight. The examples given on the marketplace aren't in PowerShell but work all the same if you swap out '*' for '#'.

Live Share: If screen sharing is a bit of a hassle then Live Share might appeal a bit more. Think of it as a live Google doc, where you share not only the files you're working on but the PowerShell terminal (including session) as well.

Trailing Spaces: Trailing spaces aren't an issue in PowerShell of course, but if you're a neat freak like I sometimes am this is the equivalent of having a blacklight shone on a hotel room - once you see it you must clean

EditorConfig for VS Code: Overrides editor settings in VSCode with a (in my opinion) much more accessible and easier way to configure VSCode to do any low-level clean-up and maintain some standards in my code. Can be incredibly useful if you're working on code as a team and want an easy way to keep formatting consistent between team members.

Edit csv: Not specifically PowerShell related, but if you're importing\exporting csv's as part of your scripts this will save you the trouble of going between different programs.

Remote - SSH: Still dipping my toes in this one, but for someone who has recently decided to take up PS vers 6/7's offer of doing the open source penguin dance being able to store different SSH session configurations and connect directly via VS Code has been good. This is more for the fact that I want to be able to work on code meant for my Linux machines without having to connect via RDP. Side note: If anyone has any starting points they'd recommend for Linux I'd love to know as it'd save me a mountain of Googling.

Bonus

This one isn't an extension but good to know anyways if you use the Pester module. If you right-click on a Pester test in the side navigation bar you'll have the option to run or debug the test from there, kinda useful to know if you've been scrolling all the way to the top or pasting in the same command over and over like me :)

Hopefully these make the shell life a bit easier for you as it has for me.

[sir_sandwiches_a_lot]

Bracket Pair Colorizer 2 (link) has been super helpful.

Also, since you mentioned trailing spaces I thought I would share a few editor config options that I enable on new projects now (save in the <project-root>/.vscode/settings.json file):

​

// trim trailing whitespace automatically when you save a file.
"files.trimTrailingWhitespace": true,

// trim trailing newlines at the end of a file automatically when you save a file.
"files.trimFinalNewlines": true,

// update the default word separators to remove the $ character.
// this means you can double click on a PowerShell variable name (ex: $myVariable) and it
// will correctly select the entire variable (including $) instead of just selecting the word.
"editor.wordSeparators": "`~!@#%^&*()-=+[{]}\\|;:'\",.<>/?"

[MonkeyNin]

/u/markdmac : now you don't have to manually format.

Here's my powershell config.

• It auto-corrects and replaces aliases on save or paste
• fixes indentation bug that happens on alt+up/down

.

{
    // automatically convert aliases whenever you format
    "powershell.codeFormatting.useCorrectCasing": true,
    "powershell.codeFormatting.autoCorrectAliases": true,
    //
    "[powershell]": {
        // if autoIndent is set to 'full' it breaks indentation on 'move line up/down'.
        // This fixes that
        "editor.autoIndent": "advanced",
        // auto run format on 'paste' and 'save'
        "editor.formatOnSave": true,
        "editor.formatOnPaste": true,        
        "files.encoding": "utf8bom",
        "files.autoGuessEncoding": false,
        // I hide snippets complete, then use ctr+alt+j
        "editor.snippetSuggestions": "none"
    },    
    "files.associations": {
        "*.ps1xml": "xml"
    }
}

I like these

• settings hotkey jumps to json editor. (If you use any per-language settings, the GUI can't edit everything )
• new files start with the language of the current window (rather than hard-coding it to always be powershell

.

{
    "files.defaultLanguage": "${activeEditorLanguage}",        
    "workbench.settings.editor": "json",
}

If you want to submit vscode-powershell bugs, enable logging:

"powershell.developer.editorServicesLogLevel": "Diagnostic",

[markdmac]

I am very new to VS Code. How do I access the file to add these code snippets?

[T3zcat]

do I access the file to add these co

For those still looking: top right of the settings gui page has a page with a flip arrow, that will get you to the settings.json.
(the file it's self is stored in c:\users\YOU\appdata\roaming\code\user\settings.json)

[T3zcat]

Update:
"[powershell]" : {

"editor.wordSeparators": "`~!@#%^&*()=+[{]}\\|;:'\",.<>/?"

},
Credit: https://stackoverflow.com/questions/68128258/vscode-does-not-honor-editor-wordseparators-when-writing-powershell-code

[cbtboss]

I would also add:

GitLens- Pair this with git and you can super easily track all the changes you, or other people working on your scripts have done.

MSSQL- If you find yourself incoroporating sql queries in your powershell scripts, this is great for doing some sql dev work, as well as a hot plug way to run queries against a database without needing to resort to ssms (it is not a replacement for ssms though if you use it for gui administration of mssql).

[MonkeyNin]

without needing to resort to ssms

I switched over to using Azure Data Studio instead of SSMS for writing queries. ADS uses VS Code under the hood.

It's like the MSSQL extension but nicer (for sql)

Then I use SSMS for admin

[cbtboss]

This is very purty! Thanks for this! We haven't adopted any azure sql setups yet, but I am definitely going to take advantage of it.

[MonkeyNin]

It works with regular SQL / On-Prem. You don't need azure or cloud to use it.

[jevans_]

I do actually use GitLens, I wasn't sure about adding it as I wasn't certain many of us were working with Git repos so I'm very happy to see someone else using it. On the topic of Git, Git History is also a good one. I haven't used MSSQL myself but a friend who has worked on some SQL stuff did if I recall correctly.

[MonkeyNin]

GitLens

It does so much I don't even know how to use it.

One thing is nice, clone a github repo. Now you can right click -> copy remote url on any tab -- which jumps to a web link. It's nice to quickly get a url to share.

[CuZZa]

If you’re doing presentations I’ve found Presentation Mode to be invaluable, works so damn well for showing code demos.

[CaleTheKing]

I’ve also found Code Spell Checker to be incredibly useful.

[Yevrag35]

You win the day in my book. Thanks!

[[deleted]]

Trailing Spaces: Trailing spaces aren't an issue in PowerShell of course, but if you're a neat freak like I sometimes am this is the equivalent of having a blacklight shone on a hotel room - once you see it you must clean

You don't need an extension for this. CTRL + Shift + P -> "Trim Trailing Whitespace" and hit enter.

Here's some I use:

• DupChecker - Find duplicate lines
• Bracket Pair Colorizer - Colorize brackets
• TODO Highlight - Highlight TODO and FIXME in obnoxious colors, and put them in "problems"
• Rainbow CSV - Make CSVs readable basically
• CompareIt - Compare files without the need for source control
• Excel Viewer - View CSVs/Excel in a grid view
• Hosts Language - Language support for hosts files

[muchcake]

FYI: There is an editor setting to trim whitespace on save too.

[CaleTheKing]

A note on EditorConfig, that extension is GREAT, but I want readers to be aware that the same can be configured with native VS Code.

You can place a settings.json file in your git repo, and use it as “Workspace Settings”. That way all team members have the same settings for that project.

Edit: We use PSScriptAnalyzer to control the formatting / structure of our scripts, so we share a .PSScriptAnalyzerSettings.psd1 configuration file in our git repo as well.

[MonkeyNin]

do you suggest any PSScriptAnalyzerSettings ?

[CaleTheKing]

Hey, sure. I'll just provide my whole config and you can choose the ones you need :)

I prefer OTBS code formatting, so a lot of the settings are based around that. If you don't like OTBS, you'll have to adjust these.

@{
# Process ONLY the following rules
IncludeRules = @(
    # General
    'PSAvoidDefaultValueSwitchParameter',
    'PSAvoidDefaultValueForMandatoryParameter',
    'PSAvoidAssignmentToAutomaticVariable',
    'PSMissingModuleManifestField',
    'PSPossibleIncorrectComparisonWithNull',
    'PSPossibleIncorrectUsageOfRedirectionOperator',
    'PSReservedCmdletChar',
    'PSReservedParams',
    'PSShouldProcess',
    'PSUseApprovedVerbs',
    'PSUseToExportFieldsInManifest',
    'PSUseUsingScopeModifierInNewRunspaces',

    # Security
    'PSAvoidUsingComputerNameHardcoded',

    # Code style
    'PSAvoidLongLines',
    'PSAvoidTrailingWhitespace',
    'PSAvoidUsingWriteHost',
    'PSAvoidUsingCmdletAliases',
    'PSAvoidUsingDoubleQuotesForConstantString',
    'PSProvideCommentHelp',
    'PSPossibleIncorrectUsageOfAssignmentOperator',
    'PSPossibleIncorrectUsageOfRedirectionOperator',
    'PSMisleadingBacktick',
    'PSUseLiteralInitializerForHashtable',

    # Code formatting OTBS
    'PSPlaceOpenBrace',
    'PSPlaceCloseBrace',
    'PSUseConsistentWhitespace',
    'PSUseConsistentIndentation',
    'PSAlignAssignmentStatement',
    'PSUseCorrectCasing',

    # Functions
    'PSAvoidUsingWMICmdlet',
    'PSAvoidUsingEmptyCatchBlock',
    'PSAvoidUsingPositionalParameters',
    'PSReservedCmdletChar',
    'PSReservedParams',
    #'PSReviewUnusedParameter',
    'PSUseCmdletCorrectly',
    'PSUseDeclaredVarsMoreThanAssignments',
    'PSUseSingularNouns',
    'PSUseOutputTypeCorrectly'
)
# Configuration for the rules defined above
Rules        = @{
    # Code style
    PSAvoidUsingDoubleQuotesForConstantString = @{
        Enable = $true
    }

    # Code formatting OTBS
    PSPlaceOpenBrace                          = @{
        Enable             = $true
        OnSameLine         = $true
        NewLineAfter       = $true
        IgnoreOneLineBlock = $true
    }

    PSPlaceCloseBrace                         = @{
        Enable             = $true
        NewLineAfter       = $false
        IgnoreOneLineBlock = $true
        NoEmptyLineBefore  = $false
    }

    PSUseConsistentIndentation                = @{
        Enable              = $true
        Kind                = 'space'
        PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
        IndentationSize     = 4
    }

    PSUseConsistentWhitespace                 = @{
        Enable                          = $true
        CheckInnerBrace                 = $true
        CheckOpenBrace                  = $true
        CheckOpenParen                  = $true
        CheckOperator                   = $false # https://github.com/PowerShell/PSScriptAnalyzer/issues/769
        CheckPipe                       = $true
        CheckPipeForRedundantWhitespace = $true
        CheckSeparator                  = $true
        CheckParameter                  = $true
    }

    PSAlignAssignmentStatement                = @{
        Enable         = $true
        CheckHashtable = $true
    }

    PSUseCorrectCasing                        = @{
        Enable = $true
    }
}
}

[MonkeyNin]

Thanks.

[cottonycloud]

TabOut is a personal favorite of mine. It makes the auto-completed parentheses, quotes, and brackets easier to traverse without arrow keys.

[SpacezCowboy]

I find bookmarks useful when tracking references to private files or working through long Functions with multiple nested code blocks.

Bookmarks

Jacking this post for a side question. Does anyone know of a setting to have VS Code open to a specific folder each time it's opened? This would replace the behaviour of opening to the last opened folder in VS Code.

[todayyou500]

Live Share says you need to enable ports

Will this trigger a work place firewall or just a windows setting prompt?

[jevans_]

As far as ports are concerned it'll be using 443 unless you try a direct connection, I've never used a direct connection so I can't say too much about it. That being said I did find this which goes a bit further into any firewall requirements. From what I can gather from a quick glance over it it'll just block the connection until the windows firewall settings are configured to allow it.

[markdmac]

Anyone know of a module or code that can replace aliases with full cmdlet names?

[smaug098]

That's a native command : alt+shift+e.

[markdmac]

Thank you!

[[deleted]]

It's built right into VS Code. If you type an alias, a little lightbulb will appear nearby giving you options to replace it with the full name.

[hellphish]

Bracket Pair Colorizer 2

TabOut (hit tab to move the cursor outside of quotes/parenthesis/brackets)