psake 项目技术文档

1. 安装指南

1.1 下载与解压项目

首先，从项目仓库下载 psake 项目的压缩包。下载完成后，右键点击压缩包，选择“属性”，然后点击“解除锁定”按钮，以确保 PowerShell 能够运行从互联网下载的文件。

1.2 进入项目目录

解压项目后，进入解压后的目录，该目录中应包含 psake.psm1 文件。

1.3 导入模块

在 PowerShell 中运行以下命令导入 psake 模块：

Import-Module .\psake.psm1

如果遇到以下错误：

Import-Module : ...psake.psm1 cannot be loaded because the execution of scripts is disabled on this system.

请参考以下步骤解决：

1. 以管理员身份运行 PowerShell。
2. 设置执行策略为 RemoteSigned：

   Set-ExecutionPolicy RemoteSigned
   

1.4 设置 PATH 变量

如果希望在安装目录之外使用 psake 命令，可以将安装目录添加到系统的 PATH 变量中。

1.5 安装 VSSetup 依赖（可选）

如果使用 Visual Studio 2017，psake 需要依赖 VSSetup 模块来定位 msbuild。请按照相关文档安装 VSSetup 模块。

2. 项目使用说明

2.1 运行示例

进入 examples 目录，运行以下命令执行默认任务：

Invoke-psake

这将执行 psakefile.ps1 中的默认任务。

如果要执行特定任务，可以使用以下命令：

Invoke-psake .\psakefile.ps1 Clean

这将执行 psakefile.ps1 中的 Clean 任务。

2.2 获取帮助

可以通过以下命令获取 psake 的帮助信息：

Get-Help Invoke-psake -Full

3. 项目 API 使用文档

3.1 Invoke-psake

Invoke-psake 是 psake 的核心命令，用于执行构建任务。其基本语法如下：

Invoke-psake [-buildFile] <String> [-taskList] <String[]> [-framework] <String> [-parameters] <Hashtable> [-properties] <Hashtable>

• -buildFile：指定构建文件的路径。
• -taskList：指定要执行的任务列表。
• -framework：指定目标框架。
• -parameters：传递给任务的参数。
• -properties：传递给任务的属性。

3.2 示例

执行 psakefile.ps1 中的 Clean 任务：

Invoke-psake .\psakefile.ps1 Clean

4. 项目安装方式

4.1 从 PowerShell Gallery 安装

可以通过以下命令从 PowerShell Gallery 安装 psake：

Install-Module -Name psake

4.2 从 Chocolatey 安装

也可以通过 Chocolatey 安装 psake：

choco install psake

4.3 从 NuGet 安装

通过 NuGet 安装 psake：

Install-Package psake

通过以上步骤，您可以顺利安装并使用 psake 项目进行构建自动化。