Visual Studio Code 中的 PowerShell

Name: Visual Studio Code
Author: Microsoft

PowerShell 是一种基于任务的命令行 shell 和脚本语言，构建于 .NET 之上，为任何平台上的管理员提供了强大的工具集。

用于 Visual Studio Code (VS Code) 的 Microsoft PowerShell 扩展提供了丰富的语言支持和功能，例如 PowerShell 的语法补全、定义跟踪和代码检查。只要 VS Code 本身和 PowerShell Core 7.2 或更高版本受支持，该扩展就应该可以在任何地方工作。对于 Windows PowerShell，仅支持 5.1 版本，并且仅尽最大努力提供支持。PowerShell Core 6、7.0 和 7.1 已停止支持。我们测试以下配置

Windows Server 2022，带 Windows PowerShell 5.1 和 PowerShell 7.2
Windows Server 2019，带 Windows PowerShell 5.1 和 PowerShell 7.2
macOS 11，带 PowerShell Core 7.2
Ubuntu 20.04，带 PowerShell Core 7.2

安装 PowerShell 扩展

可以通过单击安装按钮从 Visual Studio Code Marketplace 安装 PowerShell 扩展。您还可以通过以下方式在 VS Code 中安装 PowerShell 扩展：使用键盘快捷键 ⇧⌘X (Windows, Linux Ctrl+Shift+X) 打开扩展视图，键入PowerShell，然后选择 PowerShell 扩展

PowerShell extension

主要功能

语法高亮显示
高级内置代码片段
适用于 cmdlet 等的IntelliSense
PowerShell 脚本分析器报告的问题
cmdlet、变量、类等的转到定义
cmdlet、变量、类等的查找引用
文档和工作区符号导航
基于符号的大纲视图
使用 F8 在当前终端中运行选定的 PowerShell 代码
使用 Ctrl + F1 启动光标下符号的在线帮助
PowerShell 调试器集成
可以与调试器交互的扩展终端（尝试 Set-PSBreakpoint！）
可以在主题选择器中找到的 PowerShell ISE 主题
还可以使用 ⇧⌘P (Windows, Linux Ctrl+Shift+P)，然后搜索“启用 ISE 模式”，尝试 ISE 模式

调试

PowerShell 扩展使用 VS Code 的内置调试接口来调试 PowerShell 脚本和模块。有关调试 PowerShell 的更多信息，请参阅使用 VS Code。

多版本支持

您可以按照这些说明，配置 PowerShell 扩展以使用计算机上安装的任何受支持的 PowerShell 版本。

或者从命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 运行PowerShell: 显示会话菜单命令。

CodeLens 支持

CodeLens 是 VS Code 的一项功能，可在源代码中显示可操作的上下文信息。

CodeLens 功能包括

Pester 运行测试和调试测试。
Pester 符号支持
函数、变量、类和其他符号引用

CodeLens 引用支持显示符号在代码中被引用的次数，并允许您跳转到特定的引用。

PSScriptAnalyzer 集成

PSScriptAnalyzer 是一个 PowerShell 模块，它为模块和脚本提供静态源代码检查器。 PSScriptAnalyzer 具有验证 PowerShell 代码质量的规则。这些规则基于 PowerShell 团队和社区确定的 PowerShell 最佳实践。 PSScriptAnalyzer 生成诊断记录（错误和警告），以告知用户潜在的代码缺陷，并为改进提出可能的解决方案。

PowerShell 扩展默认包含 PSScriptAnalyzer，并自动对您在 VS Code 中编辑的 PowerShell 脚本文件执行分析。

PSScriptAnalyzer 附带了一系列内置规则，这些规则检查 PowerShell 源代码的各个方面，例如是否存在未初始化的变量、使用 PSCredential 类型、使用 Invoke-Expression 等。该模块还允许您包含或排除特定的规则。

要禁用 PSScriptAnalyzer，请打开你的设置（⌘,（Windows，Linux Ctrl+,）），浏览扩展，选择 PowerShell 扩展，并取消选中 脚本分析: 启用 (powershell.scriptAnalysis.enable) 的复选框。

PSScriptAnalyzer Settings

PSScriptAnalyzer 还提供代码格式化功能。你可以使用 格式化文档 命令或 (⇧⌥F （Windows Shift+Alt+F，Linux Ctrl+Shift+I）) 键盘快捷键来调用自动文档格式化。

Pester 集成

Pester 是一个用于运行单元测试的框架，可以执行 Windows PowerShell 5.1 预装了 Pester 3.40 版本。要更新 Pester 或在其他平台上安装最新版本，请按照 Pester 安装说明进行操作。

Plaster 集成

Plaster 是一个用 PowerShell 编写的基于模板的文件和项目生成器。它的目的是简化 PowerShell 模块项目、Pester 测试、DSC 配置等的创建。

PowerShell 扩展允许使用命令面板中的 PowerShell: 从 Plaster 模板创建新项目 命令（⇧⌘P （Windows，Linux Ctrl+Shift+P））创建新的 Plaster 项目。

Plaster Project

PowerShell 扩展设置

你可以通过文件 > 首选项 > 设置菜单项自定义 VS Code 设置。

你还可以选择位于活动栏左下角的齿轮图标。

codeGear

你还可以使用键盘快捷键 ⌘,（Windows，Linux Ctrl+,）打开你的设置。你仍然可以使用命令面板中的 首选项: 打开用户设置 (JSON) 命令（⇧⌘P （Windows，Linux Ctrl+Shift+P）），或通过使用 "workbench.settings.editor" 设置更改默认设置编辑器来打开 settings.json 文件。

有关配置 VS Code 设置的更多信息，请访问用户和工作区设置。

Types.ps1xml 和 Format.ps1xml 文件

PowerShell .ps1xml 文件用于扩展类型系统并定义输出格式。有关这些文件的更多信息，请参阅关于 Types.ps1xml 和 Format.ps1xml 的官方 PowerShell 文档。当创作 .ps1xml 文件时，可以通过安装 Red Hat 的 XML 扩展来获得 IntelliSense 功能。安装后，将此配置添加到你的用户设置中

"xml.fileAssociations": [
  {
    "systemId": "https://raw.githubusercontent.com/PowerShell/PowerShell/master/src/Schemas/Format.xsd",
    "pattern": "**/*.Format.ps1xml"
  },
  {
    "systemId": "https://raw.githubusercontent.com/PowerShell/PowerShell/master/src/Schemas/Types.xsd",
    "pattern": "**/*.Types.ps1xml"
  }
]

此配置告诉 XML 扩展对所有 .ps1xml 文件使用来自 PowerShell 存储库的官方 XML 架构。配置这些架构可以在 ps1xml 文件中启用以下功能

语法错误报告
架构验证
标签和属性完成
自动关闭标签
符号高亮显示
文档折叠
文档符号和大纲
重命名支持
文档格式化

示例脚本

示例脚本包含在扩展中，可以在以下路径中找到。

~/.vscode/extensions/ms-vscode.PowerShell-<版本>/examples

要在 VS Code 中打开或查看示例，请从你的 PowerShell 命令提示符运行以下命令

code (Get-ChildItem ~\.vscode\extensions\ms-vscode.PowerShell-*\examples)[-1]

你还可以通过命令面板（⇧⌘P（Windows，Linux Ctrl+Shift+P））使用 PowerShell: 打开示例文件夹 命令打开示例。

Open PowerShell Examples

其他资源

PowerShell 文档中有更详细的文章。首先从使用 VS Code 开始。

查看故障排除指南以获取常见问题的答案。

有关调试的更多信息，请查看由 @keithHill 编写的关于使用 PowerShell 扩展进行调试的 Hey, Scripting Guy! 两部分博客文章系列

测试新功能并提供反馈

我们鼓励你尽可能尝试 _预发行_ 版本。当 _预发行版_ 可用时，可以使用 切换到预发行版 按钮从市场中安装。你可以使用将出现的 切换到发行版 按钮切换回扩展的稳定版本。你还可以使用卸载按钮旁边的箭头并选择 安装其他版本... 来降级到扩展的其他版本。

Screenshot showing the button to switch to a pre-release version.

如果你发现错误，请打开一个问题，并在我们修复错误时恢复到稳定版本。

12/11/2024