From 659034009a61c51b9309bba54068386d1c3b206d Mon Sep 17 00:00:00 2001 From: Andy Jordan Date: Thu, 8 Dec 2022 10:14:34 -0800 Subject: [PATCH 1/2] Add badges, keywords, etc. to package manifest And update readme(s) a bit. --- README.md | 18 ++++++------ .../README_FOR_MARKETPLACE.md | 17 +++++------ package.json | 28 ++++++++++++++++++- 3 files changed, 45 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index a1abde5d28..7f1475e05c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -# PowerShell Language Support for Visual Studio Code +# PowerShell for Visual Studio Code [![Build Status](https://dev.azure.com/powershell/vscode-powershell/_apis/build/status/PowerShell.vscode-powershell?branchName=main)](https://dev.azure.com/powershell/vscode-powershell/_build/latest?definitionId=51&branchName=main) [![Version](https://vsmarketplacebadge.apphb.com/version/ms-vscode.PowerShell.svg)](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell) [![Installs](https://vsmarketplacebadge.apphb.com/installs-short/ms-vscode.PowerShell.svg)](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell) -[![Discord](https://img.shields.io/discord/180528040881815552.svg?label=%23vscode&logo=discord&logoColor=white)](https://aka.ms/powershell-vscode-discord) -[![Join the chat at https://gitter.im/PowerShell/vscode-powershell](https://badges.gitter.im/PowerShell/vscode-powershell.svg)](https://gitter.im/PowerShell/vscode-powershell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Join the chat on Discord](https://img.shields.io/discord/180528040881815552.svg?label=%23vscode&logo=discord&logoColor=white)](https://aka.ms/powershell-vscode-discord) +[![Join the chat on Gitter](https://badges.gitter.im/PowerShell/vscode-powershell.svg)](https://gitter.im/PowerShell/vscode-powershell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) This extension provides rich PowerShell language support for [Visual Studio Code](https://github.com/Microsoft/vscode) (VS Code). Now you can write and debug PowerShell scripts using the excellent IDE-like interface -that Visual Studio Code provides. +that VS Code provides. This extension is powered by the PowerShell language server, [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices). @@ -23,15 +23,15 @@ select "PowerShell ISE" for a fun and familiar experience. ## Platform Support -The extension _should_ work anywhere VS Code itself and PowerShell Core 7 or higher is +The extension _should_ work anywhere VS Code itself and PowerShell Core 7.2 or higher is [supported][]. For Windows PowerShell, only version 5.1 is supported. Please note that PowerShell Core 6 is end-of-life and so not supported. Our test matrix includes the following: -- **Windows Server 2022** with Windows PowerShell 5.1 and PowerShell Core 7.2.5 -- **Windows Server 2019** with Windows PowerShell 5.1 and PowerShell Core 7.2.5 -- **macOS 11** with PowerShell Core 7.2.5 -- **Ubuntu 20.04** with PowerShell Core 7.2.5 +- **Windows Server 2022** with Windows PowerShell 5.1 and PowerShell Core 7.2.7 +- **Windows Server 2019** with Windows PowerShell 5.1 and PowerShell Core 7.2.7 +- **macOS 11** with PowerShell Core 7.2.7 +- **Ubuntu 20.04** with PowerShell Core 7.2.7 [supported]: https://docs.microsoft.com/en-us/powershell/scripting/powershell-support-lifecycle diff --git a/docs/azure_data_studio/README_FOR_MARKETPLACE.md b/docs/azure_data_studio/README_FOR_MARKETPLACE.md index c8cc698da5..7ecea003f9 100644 --- a/docs/azure_data_studio/README_FOR_MARKETPLACE.md +++ b/docs/azure_data_studio/README_FOR_MARKETPLACE.md @@ -1,14 +1,14 @@ -# PowerShell Language Support for Azure Data Studio +# PowerShell for Azure Data Studio [![Build Status](https://dev.azure.com/powershell/vscode-powershell/_apis/build/status/PowerShell.vscode-powershell?branchName=main)](https://dev.azure.com/powershell/vscode-powershell/_build/latest?definitionId=51&branchName=main) [![Version](https://vsmarketplacebadge.apphb.com/version/ms-vscode.PowerShell.svg)](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell) [![Installs](https://vsmarketplacebadge.apphb.com/installs-short/ms-vscode.PowerShell.svg)](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell) -[![Discord](https://img.shields.io/discord/180528040881815552.svg?label=%23vscode&logo=discord&logoColor=white)](https://aka.ms/powershell-vscode-discord) -[![Join the chat at https://gitter.im/PowerShell/vscode-powershell](https://badges.gitter.im/PowerShell/vscode-powershell.svg)](https://gitter.im/PowerShell/vscode-powershell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Join the chat on Discord](https://img.shields.io/discord/180528040881815552.svg?label=%23vscode&logo=discord&logoColor=white)](https://aka.ms/powershell-vscode-discord) +[![Join the chat on Gitter](https://badges.gitter.im/PowerShell/vscode-powershell.svg)](https://gitter.im/PowerShell/vscode-powershell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) This extension provides rich PowerShell language support for [Azure Data Studio](https://github.com/Microsoft/azuredatastudio) (ADS). Now you can write and run PowerShell scripts using the excellent IDE-like interface -that Azure Data Studio provides. +that ADS provides. This extension is powered by the PowerShell language server, [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices). @@ -23,14 +23,15 @@ select "PowerShell ISE" for a fun and familiar experience. ## Platform Support -The extension _should_ work anywhere ADS itself and PowerShell Core 7 or higher is +The extension _should_ work anywhere ADS itself and PowerShell Core 7.2 or higher is [supported][]. For Windows PowerShell, only version 5.1 is supported. Please note that PowerShell Core 6 is end-of-life and so not supported. Our test matrix includes the following: -- **Windows Server 2019** with Windows PowerShell 5.1 and PowerShell Core 7.2.4 -- **macOS 10.15** with PowerShell Core 7.2.5 -- **Ubuntu 20.04** with PowerShell Core 7.2.4 +- **Windows Server 2022** with Windows PowerShell 5.1 and PowerShell Core 7.2.7 +- **Windows Server 2019** with Windows PowerShell 5.1 and PowerShell Core 7.2.7 +- **macOS 11** with PowerShell Core 7.2.7 +- **Ubuntu 20.04** with PowerShell Core 7.2.7 [supported]: https://docs.microsoft.com/en-us/powershell/scripting/powershell-support-lifecycle?view=powershell-7.1#supported-platforms diff --git a/package.json b/package.json index 10a7859a01..8ed84c79d8 100644 --- a/package.json +++ b/package.json @@ -8,6 +8,7 @@ "engines": { "vscode": "^1.67.0" }, + "author": "Microsoft Corporation", "license": "SEE LICENSE IN LICENSE.txt", "homepage": "https://github.com/PowerShell/vscode-powershell/blob/main/README.md", "categories": [ @@ -15,17 +16,42 @@ "Formatters", "Programming Languages", "Snippets", - "Linters" + "Linters", + "Themes" + ], + "keywords": [ + "PowerShell", + "pwsh" ], "icon": "media/PowerShell_Preview_Icon.png", "galleryBanner": { "color": "#ACD1EC", "theme": "light" }, + "badges": [ + { + "url": "https://dev.azure.com/powershell/vscode-powershell/_apis/build/status/PowerShell.vscode-powershell?branchName=main", + "href": "https://dev.azure.com/powershell/vscode-powershell/_build/latest?definitionId=51&branchName=main", + "description": "Build Status" + }, + { + "url": "https://img.shields.io/discord/180528040881815552.svg?label=%23vscode&logo=discord&logoColor=white", + "href": "https://aka.ms/powershell-vscode-discord", + "description": "Join the chat on Discord" + }, + { + "url": "https://badges.gitter.im/PowerShell/vscode-powershell.svg", + "href": "https://gitter.im/PowerShell/vscode-powershell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge", + "description": "Join the chat on Gitter" + } + ], "repository": { "type": "git", "url": "https://github.com/PowerShell/vscode-powershell.git" }, + "bugs": { + "url": "https://github.com/PowerShell/vscode-powershell/issues" + }, "activationEvents": [ "onDebugResolve:PowerShell", "onLanguage:powershell", From d8e8ee20ee644d90ea02776d4fc30cb647c53b8a Mon Sep 17 00:00:00 2001 From: Andy Jordan Date: Thu, 8 Dec 2022 16:15:47 -0800 Subject: [PATCH 2/2] Enhance (and correct) our settings' descriptions using markdown --- package.json | 185 ++++++++++++++++++++++++++++----------------------- 1 file changed, 102 insertions(+), 83 deletions(-) diff --git a/package.json b/package.json index 8ed84c79d8..5408eac2ec 100644 --- a/package.json +++ b/package.json @@ -195,25 +195,20 @@ { "command": "PowerShell.RefreshCommandsExplorer", "title": "Refresh Command Explorer", - "icon": "$(sync)", - "category": "PowerShell" + "category": "PowerShell", + "icon": "$(sync)" }, { "command": "PowerShell.InsertCommand", "title": "Insert Command", - "icon": "$(pencil)", - "category": "PowerShell" - }, - { - "command": "PowerShell.OnlineHelp", - "title": "Get Online Help for Command (Deprecated)", - "category": "PowerShell" + "category": "PowerShell", + "icon": "$(pencil)" }, { "command": "PowerShell.ShowHelp", "title": "Get Help for Command", - "icon": "$(question)", - "category": "PowerShell" + "category": "PowerShell", + "icon": "$(question)" }, { "command": "PowerShell.Debug.Start", @@ -229,7 +224,7 @@ }, { "command": "PowerShell.RestartSession", - "title": "Restart Current Session", + "title": "Restart Session", "category": "PowerShell" }, { @@ -566,13 +561,12 @@ } ], "configuration": { - "type": "object", "title": "PowerShell", "properties": { "powershell.sideBar.CommandExplorerVisibility": { "type": "boolean", "default": true, - "description": "Specifies the visibility of the Command Explorer in the PowerShell Side Bar." + "markdownDescription": "Specifies the visibility of the Command Explorer in the side bar." }, "powershell.sideBar.CommandExplorerExcludeFilter": { "type": "array", @@ -580,12 +574,12 @@ "type": "string" }, "default": [], - "description": "Specify array of Modules to exclude from Command Explorer listing." + "markdownDescription": "Specifies an array of modules to exclude from Command Explorer listing." }, "powershell.powerShellAdditionalExePaths": { "type": "object", "default": {}, - "description": "Specifies a list of versionName / exePath pairs where exePath points to a non-standard install location for PowerShell and versionName can be used to reference this path with the powershell.powerShellDefaultVersion setting.", + "markdownDescription": "Specifies a list of Item / Value pairs where the **Item** is a user-chosen name and the **Value** is an absolute path to a PowerShell executable. The name appears in the [Session Menu Command](command:PowerShell.ShowSessionMenu) and is used to reference this executable in the `#powershell.powerShellDefaultVersion#` setting.", "additionalProperties": { "type": "string" } @@ -593,258 +587,276 @@ "powershell.powerShellDefaultVersion": { "type": "string", "default": "", - "description": "Specifies the PowerShell version name, as displayed by the 'PowerShell: Show Session Menu' command, used when the extension loads e.g \"Windows PowerShell (x86)\" or \"PowerShell Core 7 (x64)\". You can specify additional PowerShell executables by using the \"powershell.powerShellAdditionalExePaths\" setting." + "markdownDescription": "Specifies the default PowerShell version started by the extension. The name must match what is displayed in the [Session Menu command](command:PowerShell.ShowSessionMenu), for example, `Windows PowerShell (x86)`. You can specify additional PowerShell executables with the `#powershell.powerShellAdditionalExePaths#` setting." }, "powershell.powerShellExePath": { "type": "string", "default": "", "scope": "machine", - "description": "REMOVED: Please use the \"powershell.powerShellAdditionalExePaths\" setting instead.", - "deprecationMessage": "Please use the \"powershell.powerShellAdditionalExePaths\" setting instead." + "markdownDescription": "**Deprecated:** Specifies the path to the PowerShell executable.", + "markdownDeprecationMessage": "**Deprecated:** Please use the `#powershell.powerShellAdditionalExePaths#` setting instead." }, "powershell.promptToUpdatePowerShell": { "type": "boolean", - "description": "Specifies whether you should be prompted to update your version of PowerShell.", - "default": true + "default": true, + "markdownDescription": "Specifies whether you may be prompted to update your version of PowerShell." }, "powershell.promptToUpdatePackageManagement": { "type": "boolean", - "description": "REMOVED: Specifies whether you should be prompted to update your version of PackageManagement if it's under 1.4.6.", "default": false, - "deprecationMessage": "This prompt has been removed as it's no longer strictly necessary to upgrade the PackageManagement module." + "markdownDescription": "**Deprecated:** Specifies whether you should be prompted to update your version of `PackageManagement` if it's under 1.4.6.", + "markdownDeprecationMessage": "**Deprecated:** This prompt has been removed as it's no longer strictly necessary to upgrade the `PackageManagement` module." }, "powershell.startAsLoginShell.osx": { "type": "boolean", "default": true, - "description": "Starts the PowerShell extension's underlying PowerShell process as a login shell, if applicable." + "markdownDescription": "Starts the PowerShell extension's underlying PowerShell process as a login shell, if applicable." }, "powershell.startAsLoginShell.linux": { "type": "boolean", "default": false, - "description": "Starts the PowerShell extension's underlying PowerShell process as a login shell, if applicable." + "markdownDescription": "Starts the PowerShell extension's underlying PowerShell process as a login shell, if applicable." }, "powershell.startAutomatically": { "type": "boolean", "default": true, - "description": "Starts PowerShell extension features automatically when a PowerShell file opens. If false, to start the extension, use the 'PowerShell: Restart Current Session' command. IntelliSense, code navigation, Extension Terminal, code formatting, and other features are not enabled until the extension starts." + "markdownDescription": "Starts the PowerShell extension automatically when a PowerShell file is opened. If `false`, to start the extension use the [Restart Session command](command:PowerShell.RestartSession). **IntelliSense, code navigation, the Extension Terminal, code formatting, and other features are not enabled until the extension starts.**" }, "powershell.useX86Host": { "type": "boolean", "default": false, - "description": "REMOVED: Uses the 32-bit language service on 64-bit Windows. This setting has no effect on 32-bit Windows or on the PowerShell extension debugger, which has its own architecture configuration.", - "deprecationMessage": "This setting was removed when the PowerShell installation searcher was added. Please use the \"powershell.powerShellAdditionalExePaths\" setting instead." + "markdownDescription": "**Deprecated:** Uses the 32-bit language service on 64-bit Windows. This setting has no effect on 32-bit Windows or on the PowerShell extension debugger, which has its own architecture configuration.", + "markdownDeprecationMessage": "**Deprecated:** This setting was removed when the PowerShell installation searcher was added. Please use the `#powershell.powerShellAdditionalExePaths#` setting instead." }, "powershell.enableProfileLoading": { "type": "boolean", "default": true, - "description": "Loads user and system-wide PowerShell profiles (profile.ps1 and Microsoft.VSCode_profile.ps1) into the PowerShell session. This affects IntelliSense and interactive script execution, but it does not affect the debugger." + "markdownDescription": "Specifies whether the extension loads [PowerShell profiles](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles). Note that the extension's \"Current Host\" profile is `Microsoft.VSCode_profile.ps1`, which will be loaded instead of the default \"Current Host\" profile of `Microsoft.PowerShell_profile.ps1`. Use the \"All Hosts\" profile `profile.ps1` for common configuration." }, "powershell.enableReferencesCodeLens": { "type": "boolean", "default": true, - "description": "Displays a code lens above function definitions showing the number of times the function is referenced in the workspace. Large workspaces should disable this setting due to high performance impact." + "markdownDescription": "Specifies if Code Lenses are displayed above function definitions, used to show the number of times the function is referenced in the workspace and navigate to those references. Large workspaces may want to disable this setting if performance is compromised. See also `#powershell.analyzeOpenDocumentsOnly#`." }, "powershell.analyzeOpenDocumentsOnly": { "type": "boolean", "default": false, - "description": "Only search for references within open documents. Enable this in large workspaces if memory is limited." + "markdownDescription": "Specifies to search for references only within open documents instead of all workspace files. An alternative to `#powershell.enableReferencesCodeLens#` that allows large workspaces to support some references without the performance impact." }, "powershell.bugReporting.project": { "type": "string", "default": "https://github.com/PowerShell/vscode-powershell", - "description": "Specifies the URL of the GitHub project in which to generate bug reports.", - "deprecationMessage": "This setting was never meant to be changed!" + "markdownDescription": "**Deprecated:** Specifies the URL of the GitHub project in which to generate bug reports.", + "markdownDeprecationMessage": "**Deprecated:** This setting was never meant to be changed!" }, "powershell.helpCompletion": { "type": "string", + "default": "BlockComment", "enum": [ "Disabled", "BlockComment", "LineComment" ], - "default": "BlockComment", - "description": "Controls the comment-based help completion behavior triggered by typing '##'. Set the generated help style with 'BlockComment' or 'LineComment'. Disable the feature with 'Disabled'." + "markdownEnumDescriptions": [ + "Disables the feature.", + "Inserts a block style help comment, for example:\n\n`<#`\n\n`.`\n\n``\n\n`#>`", + "Inserts a line style help comment, for example:\n\n`# .`\n\n`# `" + ], + "markdownDescription": "Specifies the [comment based help](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help) completion style triggered by typing ` ##`." }, "powershell.cwd": { "type": "string", "default": "", - "description": "An explicit start path where the PowerShell Extension Terminal will be launched. Both the PowerShell process's and the shell's location will be set to this directory. A fully resolved path must be provided!" + "markdownDescription": "An explicit start path where the Extension Terminal will be launched. Both the PowerShell process's and the shell's location will be set to this directory. **Path must be fully resolved: variables are not supported!**" }, "powershell.scriptAnalysis.enable": { "type": "boolean", "default": true, - "description": "Enables real-time script analysis from PowerShell Script Analyzer. Uses the newest installed version of the PSScriptAnalyzer module or the version bundled with this extension, if it is newer." + "markdownDescription": "Enables real-time script analysis using [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) that populates the [Problems view](command:workbench.panel.markers.view.focus)." }, "powershell.scriptAnalysis.settingsPath": { "type": "string", "default": "PSScriptAnalyzerSettings.psd1", - "description": "Specifies the path to a PowerShell Script Analyzer settings file. To override the default settings for all projects, enter an absolute path, or enter a path relative to your workspace." + "markdownDescription": "Specifies the path to a [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) settings file. **This setting may not work as expected currently!**" }, "powershell.codeFolding.enable": { "type": "boolean", "default": true, - "description": "Enables syntax based code folding. When disabled, the default indentation based code folding is used." + "markdownDescription": "Enables syntax based code folding. When disabled, the default indentation based code folding is used." }, "powershell.codeFolding.showLastLine": { "type": "boolean", "default": true, - "description": "Shows the last line of a folded section similar to the default VSCode folding style. When disabled, the entire folded region is hidden." + "markdownDescription": "Shows the last line of a folded section similar to the default VS Code folding style. When disabled, the entire folded region is hidden." }, "powershell.codeFormatting.autoCorrectAliases": { "type": "boolean", "default": false, - "description": "Replaces aliases with their aliased name." + "markdownDescription": "Replaces aliases with their aliased name." }, "powershell.codeFormatting.avoidSemicolonsAsLineTerminators": { "type": "boolean", "default": false, - "description": "Removes redundant semicolon(s) at the end of a line where a line terminator is sufficient." + "markdownDescription": "Removes redundant semicolon(s) at the end of a line where a line terminator is sufficient." }, "powershell.codeFormatting.preset": { "type": "string", + "default": "Custom", "enum": [ "Custom", "Allman", "OTBS", "Stroustrup" ], - "default": "Custom", - "description": "Sets the codeformatting options to follow the given indent style in a way that is compatible with PowerShell syntax. For more information about the brace styles please refer to https://github.com/PoshCode/PowerShellPracticeAndStyle/issues/81." + "markdownEnumDescriptions": [ + "The three brace settings are respected as-is.", + "Sets `#powershell.codeFormatting.openBraceOnSameLine#` to `false`, `#powershell.codeFormatting.newLineAfterOpenBrace#` to `true`, and `#powershell.codeFormatting.newLineAfterCloseBrace#` to `true`.", + "Sets `#powershell.codeFormatting.openBraceOnSameLine#` to `true`, `#powershell.codeFormatting.newLineAfterOpenBrace#` to `true`, and `#powershell.codeFormatting.newLineAfterCloseBrace#` to `false`.", + "Sets `#powershell.codeFormatting.openBraceOnSameLine#` to `true`, `#powershell.codeFormatting.newLineAfterOpenBrace#` to `true`, and `#powershell.codeFormatting.newLineAfterCloseBrace#` to `true`." + ], + "markdownDescription": "Sets the code formatting options to follow the given indent style in a way that is compatible with PowerShell syntax. Any setting other than `Custom` will configure (and override) the settings:\n\n* `#powershell.codeFormatting.openBraceOnSameLine#`\n\n* `#powershell.codeFormatting.newLineAfterOpenBrace#`\n\n* `#powershell.codeFormatting.newLineAfterCloseBrace#`\n\nFor more information about the brace styles, please see [PoshCode's discussion](https://github.com/PoshCode/PowerShellPracticeAndStyle/issues/81)." }, "powershell.codeFormatting.openBraceOnSameLine": { "type": "boolean", "default": true, - "description": "Places open brace on the same line as its associated statement." + "markdownDescription": "Places open brace on the same line as its associated statement." }, "powershell.codeFormatting.newLineAfterOpenBrace": { "type": "boolean", "default": true, - "description": "Adds a newline (line break) after an open brace." + "markdownDescription": "Adds a newline (line break) after an open brace." }, "powershell.codeFormatting.newLineAfterCloseBrace": { "type": "boolean", "default": true, - "description": "Adds a newline (line break) after a closing brace." + "markdownDescription": "Adds a newline (line break) after a closing brace." }, "powershell.codeFormatting.pipelineIndentationStyle": { "type": "string", + "default": "NoIndentation", "enum": [ "IncreaseIndentationForFirstPipeline", "IncreaseIndentationAfterEveryPipeline", "NoIndentation", "None" ], - "default": "NoIndentation", - "description": "Multi-line pipeline style settings (default: NoIndentation)." + "markdownEnumDescriptions": [ + "Indent once after the first pipeline and keep this indentation.", + "Indent more after the first pipeline and keep this indentation.", + "Do not increase indentation.", + "Do not change any existing pipeline indentation (disables feature)." + ], + "markdownDescription": "Whether to increase indentation after a pipeline for multi-line statements. See [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer/blob/a94d9f5666bba9f569cdf9c1bc99556934f2b8f4/docs/Rules/UseConsistentIndentation.md#pipelineindentation-string-default-value-is-increaseindentationforfirstpipeline) for examples. It is suggested to use `IncreaseIndentationForFirstPipeline` instead of the default `NoIndentation`. **This default may change in the future,** please see the [Request For Comment](https://github.com/PowerShell/vscode-powershell/issues/4296)." }, "powershell.codeFormatting.whitespaceBeforeOpenBrace": { "type": "boolean", "default": true, - "description": "Adds a space between a keyword and its associated scriptblock expression." + "markdownDescription": "Adds a space between a keyword and its associated script-block expression." }, "powershell.codeFormatting.whitespaceBeforeOpenParen": { "type": "boolean", "default": true, - "description": "Adds a space between a keyword (if, elseif, while, switch, etc) and its associated conditional expression." + "markdownDescription": "Adds a space between a keyword (`if`, `elseif`, `while`, `switch`, etc.) and its associated conditional expression." }, "powershell.codeFormatting.whitespaceAroundOperator": { "type": "boolean", "default": true, - "description": "Adds spaces before and after an operator ('=', '+', '-', etc.)." + "markdownDescription": "Adds spaces before and after an operator (`=`, `+`, `-`, etc.)." }, "powershell.codeFormatting.whitespaceAfterSeparator": { "type": "boolean", "default": true, - "description": "Adds a space after a separator (',' and ';')." + "markdownDescription": "Adds a space after a separator (`,` and `;`)." }, "powershell.codeFormatting.whitespaceInsideBrace": { "type": "boolean", "default": true, - "description": "Adds a space after an opening brace ('{') and before a closing brace ('}')." + "markdownDescription": "Adds a space after an opening brace (`{`) and before a closing brace (`}`)." }, "powershell.codeFormatting.whitespaceBetweenParameters": { "type": "boolean", "default": false, - "description": "Removes redundant whitespace between parameters." + "markdownDescription": "Removes redundant whitespace between parameters." }, "powershell.codeFormatting.whitespaceAroundPipe": { "type": "boolean", "default": true, - "description": "REMOVED. Please use the \"powershell.codeFormatting.addWhitespaceAroundPipe\" setting instead. If you've used this setting before, we have moved it for you automatically.", - "deprecationMessage": "Please use the \"powershell.codeFormatting.addWhitespaceAroundPipe\" setting instead. If you've used this setting before, we have moved it for you automatically." + "markdownDescription": "**Deprecated:** Please use the `#powershell.codeFormatting.addWhitespaceAroundPipe#` setting instead. If you've used this setting before, we have moved it for you automatically.", + "markdownDeprecationMessage": "**Deprecated:** Please use the `#powershell.codeFormatting.addWhitespaceAroundPipe#` setting instead. If you've used this setting before, we have moved it for you automatically." }, "powershell.codeFormatting.addWhitespaceAroundPipe": { "type": "boolean", "default": true, - "description": "Adds a space before and after the pipeline operator ('|') if it is missing." + "markdownDescription": "Adds a space before and after the pipeline operator (`|`) if it is missing." }, "powershell.codeFormatting.trimWhitespaceAroundPipe": { "type": "boolean", "default": false, - "description": "Trims extraneous whitespace (more than 1 character) before and after the pipeline operator ('|')." + "markdownDescription": "Trims extraneous whitespace (more than one character) before and after the pipeline operator (`|`)." }, "powershell.codeFormatting.ignoreOneLineBlock": { "type": "boolean", "default": true, - "description": "Does not reformat one-line code blocks, such as \"if (...) {...} else {...}\"." + "markdownDescription": "Does not reformat one-line code blocks, such as: `if (...) {...} else {...}`." }, "powershell.codeFormatting.alignPropertyValuePairs": { "type": "boolean", "default": true, - "description": "Align assignment statements in a hashtable or a DSC Configuration." + "markdownDescription": "Align assignment statements in a hashtable or a DSC Configuration." }, "powershell.codeFormatting.useConstantStrings": { "type": "boolean", "default": false, - "description": "Use single quotes if a string is not interpolated and its value does not contain a single quote." + "markdownDescription": "Use single quotes if a string is not interpolated and its value does not contain a single quote." }, "powershell.codeFormatting.useCorrectCasing": { "type": "boolean", "default": false, - "description": "Use correct casing for cmdlets." + "markdownDescription": "Use correct casing for cmdlets." }, "powershell.integratedConsole.showOnStartup": { "type": "boolean", "default": true, - "description": "Shows the Extension Terminal when the PowerShell extension is initialized. When disabled, the pane is not opened on startup, but the Extension Terminal is still created in order to power the extension's features." + "markdownDescription": "Shows the Extension Terminal when the PowerShell extension is initialized. When disabled, the pane is not opened on startup, but the Extension Terminal is still created in order to power the extension's features." }, "powershell.integratedConsole.startInBackground": { "type": "boolean", "default": false, - "description": "Starts the Extension Terminal in the background. WARNING: If this is enabled, to access the terminal you must run the 'Show Extension Terminal' command, and once shown it cannot be put back into the background. This option completely hides the Extension Terminal from the terminals pane. You are probably looking for the 'showOnStartup' option instead." + "markdownDescription": "Starts the Extension Terminal in the background. **If this is enabled, to access the terminal you must run the [Show Extension Terminal command](command:PowerShell.ShowSessionConsole), and once shown it cannot be put back into the background.** This option completely hides the Extension Terminal from the terminals view. You are probably looking for the `#powershell.integratedConsole.showOnStartup#` option instead." }, "powershell.integratedConsole.focusConsoleOnExecute": { "type": "boolean", "default": true, - "description": "Switches focus to the console when a script selection is run or a script file is debugged. This is an accessibility feature. To disable it, set to false." + "markdownDescription": "Switches focus to the console when a script selection is run or a script file is debugged." }, "powershell.integratedConsole.useLegacyReadLine": { "type": "boolean", "default": false, - "description": "Falls back to the legacy ReadLine experience. This will disable the use of PSReadLine in the PowerShell Extension Terminal." + "markdownDescription": "This will disable the use of PSReadLine in the PowerShell Extension Terminal and use a legacy implementation. **This setting is not recommended and likely to be deprecated!**" }, "powershell.integratedConsole.forceClearScrollbackBuffer": { "type": "boolean", "default": false, - "description": "Use the vscode API to clear the terminal since that's the only reliable way to clear the scrollback buffer. Turn this on if you're used to 'Clear-Host' clearing scroll history as well as clear-terminal-via-lsp." + "markdownDescription": "Use the VS Code API to clear the terminal since that's the only reliable way to clear the scrollback buffer. Turn this on if you're used to `Clear-Host` clearing scroll history. **This setting is not recommended and likely to be deprecated!**" }, "powershell.integratedConsole.suppressStartupBanner": { "type": "boolean", "default": false, - "description": "Do not show the PowerShell Extension Terminal banner on launch." + "markdownDescription": "Do not show the startup banner in the PowerShell Extension Terminal." }, "powershell.debugging.createTemporaryIntegratedConsole": { "type": "boolean", "default": false, - "description": "Determines whether a temporary PowerShell Extension Terminal is created for each debugging session. Useful for debugging PowerShell classes and binary modules." + "markdownDescription": "Creates a temporary PowerShell Extension Terminal for each debugging session. This is useful for debugging PowerShell classes and binary modules." }, "powershell.developer.bundledModulesPath": { "type": "string", "default": "../../PowerShellEditorServices/module", - "description": "Specifies an alternate path to the folder containing modules that are bundled with the PowerShell extension (i.e. PowerShell Editor Services, PSScriptAnalyzer, Plaster)" + "markdownDescription": "Specifies an alternative path to the folder containing modules that are bundled with the PowerShell extension, that is: PowerShell Editor Services, PSScriptAnalyzer, Plaster, and PSReadLine. **This setting is only meant for extension developers and requires the extension to be run in development mode!**" }, "powershell.developer.editorServicesLogLevel": { "type": "string", + "default": "Normal", "enum": [ "Diagnostic", "Verbose", @@ -853,13 +865,20 @@ "Error", "None" ], - "default": "Normal", - "description": "Sets the logging verbosity level for the PowerShell Editor Services host executable. Valid values are 'Diagnostic', 'Verbose', 'Normal', 'Warning', 'Error', and 'None'" + "markdownEnumDescriptions": [ + "Enables all logging possible, please use this setting when submitting logs for bug reports!", + "Enables more logging than normal.", + "The default logging level.", + "Only log warnings and errors.", + "Only log errors.", + "Disable all logging possible. No log files will be written!" + ], + "markdownDescription": "Sets the log verbosity for both the extension and its LSP server, PowerShell Editor Services. **Please set to `Diagnostic` when recording logs for a bug report!**" }, "powershell.developer.editorServicesWaitForDebugger": { "type": "boolean", "default": false, - "description": "Launches the language service with the /waitForDebugger flag to force it to wait for a .NET debugger to attach before proceeding." + "markdownDescription": "Launches the LSP server with the `/waitForDebugger` flag to force it to wait for a .NET debugger to attach before proceeding, and emit its PID until then. **This setting is only meant for extension developers and requires the extension to be run in development mode!**" }, "powershell.developer.featureFlags": { "type": "array", @@ -867,25 +886,26 @@ "type": "string" }, "default": [], - "description": "An array of strings that enable experimental features in the PowerShell extension." + "markdownDescription": "An array of strings that enable experimental features in the PowerShell extension. **No flags are currently available!**" }, "powershell.developer.waitForSessionFileTimeoutSeconds": { "type": "number", "default": 240, - "description": "When the PowerShell extension is starting up, it checks for a session file in order to connect to the language server. This setting determines how long until checking for the session file times out. (default is 240 seconds or 4 minutes)" + "markdownDescription": "Specifies how many seconds the extension will wait for the LSP server, PowerShell Editor Services, to connect. The default is four minutes; try increasing this value if your computer is particularly slow (often caused by overactive anti-malware programs)." }, "powershell.pester.useLegacyCodeLens": { "type": "boolean", "default": true, - "description": "Use a CodeLens that is compatible with Pester 4. Disabling this will show 'Run Tests' on all It, Describe and Context blocks, and will correctly work only with Pester 5 and newer." + "markdownDescription": "Use a CodeLens that is compatible with Pester 4. Disabling this will show `Run Tests` on all `It`, `Describe` and `Context` blocks, and will correctly work only with Pester 5 and newer." }, "powershell.pester.codeLens": { "type": "boolean", "default": true, - "description": "This setting controls the appearance of the 'Run Tests' and 'Debug Tests' CodeLenses that appears above Pester tests." + "markdownDescription": "This setting controls the appearance of the `Run Tests` and `Debug Tests` CodeLenses that appears above Pester tests." }, "powershell.pester.outputVerbosity": { "type": "string", + "default": "FromPreference", "enum": [ "FromPreference", "None", @@ -894,8 +914,7 @@ "Detailed", "Diagnostic" ], - "default": "FromPreference", - "description": "Defines the verbosity of output to be used. For Pester 5 and newer the default value FromPreference, will use the Output settings from the $PesterPreference defined in the caller context, and will default to Normal if there is none. For Pester 4 the FromPreference and Normal options map to All, and Minimal option maps to Fails." + "markdownDescription": "Defines the verbosity of output to be used. For Pester 5 and newer the default value `FromPreference` will use the `Output` settings from the `$PesterPreference` defined in the caller's context, and will default to `Normal` if there is none. For Pester 4 the `FromPreference` and `Normal` options map to `All`, and `Minimal` option maps to `Fails`." }, "powershell.pester.debugOutputVerbosity": { "type": "string", @@ -907,17 +926,17 @@ "Diagnostic" ], "default": "Diagnostic", - "description": "Defines the verbosity of output to be used when debugging a test or a block. For Pester 5 and newer the default value Diagnostic will print additional information about discovery, skipped and filtered tests, mocking and more." + "markdownDescription": "Defines the verbosity of output to be used when debugging a test or a block. For Pester 5 and newer the default value `Diagnostic` will print additional information about discovery, skipped and filtered tests, mocking and more." }, "powershell.buttons.showRunButtons": { "type": "boolean", "default": true, - "description": "Show the Run and Run Selection buttons in the editor title-bar." + "markdownDescription": "Show the `Run` and `Run Selection` buttons in the editor's title bar." }, "powershell.buttons.showPanelMovementButtons": { "type": "boolean", "default": false, - "description": "Show buttons in the editor title-bar for moving the panel around." + "markdownDescription": "Show buttons in the editor's title bar for moving the terminals pane (with the PowerShell Extension Terminal) around." } } },