Skip to content

Commit

Permalink
tip: Add tip for Inline Values VS Code extension
Browse files Browse the repository at this point in the history
  • Loading branch information
deadlydog committed Feb 18, 2024
1 parent c13e756 commit 849de83
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 2 deletions.
5 changes: 3 additions & 2 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
"dictionaryDefinitions": [],
"dictionaries": [],
"words": [
"colours", // Canadian spelling
"gifs", // Plural of GIF
"colours",
"gifs",
"unshown"
],
"ignoreWords": [
Expand All @@ -19,6 +19,7 @@
"hashtable", // PowerShell Hashtable
"Hmmss", // Time format
"jacoco", // Java code coverage
"Leonhardt", // Person's name
"madrapps", // GitHub action author
"netstandard", // .NET Standard project target
"nunit", // .NET unit testing framework
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
$tip = [tiPS.PowerShellTip]::new()
$tip.CreatedDate = [DateTime]::Parse('2024-02-18')
$tip.Title = 'See variable values inline while debugging'
$tip.TipText = @'
The Visual Studio Code extension "Inline Values support for PowerShell" by Tyler Leonhardt is great. While you are debugging and stepping through your PowerShell code, it shows the values of variables inline in the editor.
Without this extension, to see a variable's value you would need to hover your mouse over the variable, type it into your debug prompt,look for it in the Locals debug pane, or add it to the Watch list debug pane. Being able to see the variable values without having to take any additional steps is a huge time saver and makes debugging much easier.
If you try the extension and love it, show your appreciation by giving it a rating and review on the Visual Studio Code Marketplace.
'@
$tip.Example = ''
$tip.Urls = @(
'https://marketplace.visualstudio.com/items?itemName=TylerLeonhardt.vscode-inline-values-powershell'
)
$tip.Category = [tiPS.TipCategory]::Editor # Community, Editor, Module, NativeCmdlet, Performance, Security, Syntax, Terminal, or Other.
#$tip.ExpiryDate = [DateTime]::Parse('2024-10-30') # Optional. If the tip is not relevant after a certain date, set the expiration date. e.g. Announcing a conference or event.

# Category meanings:
# Community: Social events and community resources. e.g. PowerShell Summit, podcasts, etc.
# Editor: Editor tips and extensions. e.g. VSCode, ISE, etc.
# Module: Modules and module tips. e.g. PSScriptAnalyzer, Pester, etc.
# NativeCmdlet: Native cmdlet tips. e.g. Get-Process, Get-ChildItem, Get-Content, etc.
# Performance: Tips to improve runtime performance. e.g. foreach vs ForEach-Object, ForEach-Object -Parallel, etc.
# Security: Security tips. e.g. ExecutionPolicy, Constrained Language Mode, passwords, etc.
# Syntax: Syntax tips. e.g. splatting, pipeline, etc.
# Terminal: Terminal shortcuts and tips. e.g. PSReadLine, Windows Terminal, ConEmu, etc.
# Other: Tips that don't fit into any of the other categories.
11 changes: 11 additions & 0 deletions src/tiPS/PowerShellTips.json
Original file line number Diff line number Diff line change
Expand Up @@ -530,6 +530,17 @@
"Category": 0,
"ExpiryDate": "9999-12-31T23:59:59.9999999"
},
{
"CreatedDate": "2024-02-18T00:00:00",
"Title": "See variable values inline while debugging",
"TipText": "The Visual Studio Code extension \"Inline Values support for PowerShell\" by Tyler Leonhardt is great. While you are debugging and stepping through your PowerShell code, it shows the values of variables inline in the editor.\r\n\r\nWithout this extension, to see a variable's value you would need to hover your mouse over the variable, type it into your debug prompt,look for it in the Locals debug pane, or add it to the Watch list debug pane. Being able to see the variable values without having to take any additional steps is a huge time saver and makes debugging much easier.\r\n\r\nIf you try the extension and love it, show your appreciation by giving it a rating and review on the Visual Studio Code Marketplace.",
"Example": "",
"Urls": [
"https://marketplace.visualstudio.com/items?itemName=TylerLeonhardt.vscode-inline-values-powershell"
],
"Category": 1,
"ExpiryDate": "9999-12-31T23:59:59.9999999"
},
{
"CreatedDate": "2024-02-18T00:00:00",
"Title": "Use Get-Help -Online to view the help in your web browser",
Expand Down

0 comments on commit 849de83

Please sign in to comment.