Invoke-Build 项目技术文档

1. 安装指南

1.1 通过 PowerShell Gallery 安装

Invoke-Build 可以通过 PowerShell Gallery 安装。执行以下命令即可：

Install-Module InvokeBuild

1.2 通过 Chocolatey 安装

如果你使用 Chocolatey，可以运行以下命令进行安装：

choco install invoke-build

1.3 通过 Scoop 安装

如果你使用 Scoop，可以运行以下命令进行安装：

scoop install invoke-build

1.4 通过 NuGet 安装

Invoke-Build 也可以通过 NuGet 安装。下载包后，将其重命名为 zip 文件，解压其中的 tools 目录，并将其重命名为 InvokeBuild。你可以将该目录添加到系统路径中，或者将其复制到 PowerShell 模块目录中以作为模块使用。

1.5 通过 dotnet 工具安装

Invoke-Build 还可以作为 dotnet 工具安装。你可以选择全局安装或本地安装：

• 全局安装：

dotnet tool install --global ib

• 本地安装：

dotnet new tool-manifest # 仅在设置工具的仓库时执行一次
dotnet tool install --local ib

2. 项目的使用说明

Invoke-Build 是一个用于 PowerShell 的构建和测试自动化工具，支持 PowerShell v3.0 及以上版本。它类似于 psake，但使用起来更简单且功能更强大。Invoke-Build 支持以下特性：

• 增量任务：有效处理输入和输出。
• 持久化构建：可以在中断后恢复。
• 并行构建：在不同的工作空间中并行执行构建，并共享统计信息。
• 批量测试任务：将测试任务组合成批量执行。
• 自定义任务类：允许定义新的任务类。

Invoke-Build 支持跨平台运行，并且可以与 VSCode 和 ISE 集成使用。

3. 项目 API 使用文档

3.1 基本命令

• Invoke-Build.ps1：调用构建脚本，这是构建引擎的核心脚本。
• Build-Checkpoint.ps1：调用持久化构建，使用构建引擎。
• Build-Parallel.ps1：调用并行构建，使用构建引擎。
• Resolve-MSBuild.ps1：查找指定的或最新的 MSBuild。
• Show-TaskHelp.ps1：显示任务帮助信息，通常在 WhatIf 调用时使用。

3.2 额外工具

• Invoke-Build.ArgumentCompleters：为 PowerShell v5 提供参数补全功能。
• Invoke-TaskFromVSCode：从 VSCode 中调用构建脚本中的任务。
• Show-BuildGraph：使用 Graphviz Viz.js 或 dot 显示任务图。
• New-VSCodeTask：生成绑定到构建脚本任务的 VSCode 任务。
• Invoke-TaskFromISE：从 ISE 中调用构建脚本中的任务。

3.3 其他工具

• ib.cmd 和 ib.sh：cmd 和 bash 的辅助脚本。
• Build-JustTask.ps1：在不引用其他任务的情况下调用任务。
• Convert-psake.ps1：将 psake 构建脚本转换为 Invoke-Build 脚本。
• Show-BuildTree.ps1：以文本形式显示任务树。
• Show-BuildDgml.ps1：以 DGML 格式显示任务图。
• Show-BuildMermaid.ps1：使用 Mermaid 显示任务图。

4. 项目安装方式

4.1 作为模块安装

Invoke-Build 可以作为 PowerShell 模块安装，使用以下命令：

Install-Module InvokeBuild

4.2 作为脚本安装

Invoke-Build 也可以作为脚本安装。你可以通过 Scoop 或手动下载 NuGet 包进行安装。

4.3 作为 dotnet 工具安装

Invoke-Build 还可以作为 dotnet 工具安装，支持全局或本地安装。

5. 获取帮助

如果你在使用模块时遇到问题，或者脚本不在系统路径中，可以使用完整路径调用 Invoke-Build.ps1 来获取帮助：

help Invoke-Build -full

对于内部命令的帮助，可以执行以下命令：

. Invoke-Build
help task -full
help exec -full

6. 在线资源

• 基本概念：了解构建脚本的优势。
• 脚本教程：快速熟悉构建脚本。
• 逐步教程：从“Hello world”到复杂脚本。
• 项目 Wiki：详细教程、辅助工具、笔记等。
• 示例：在各种项目中使用的构建脚本。
• 任务：示例、模式和各种技术。
• 设计笔记：为贡献者提供的技术细节。
• 发布说明

7. 致谢

• 项目灵感来自 psake。
• 部分概念来自 MSBuild。