idea-sbt-plugin 技术文档

1. 安装指南

1.1 通过 IntelliJ IDEA 插件管理器安装

1. 打开 IntelliJ IDEA。
2. 进入 File -> Settings -> Plugins。
3. 在插件市场中搜索 idea-sbt-plugin。
4. 点击 Install 按钮进行安装。
5. 安装完成后，重启 IntelliJ IDEA。

1.2 手动安装

1. 下载插件的 ZIP 文件（例如从项目的 sbt-dist/target/ 目录中获取）。
2. 打开 IntelliJ IDEA。
3. 进入 File -> Settings -> Plugins。
4. 点击 Install Plugin from Disk，选择下载的 ZIP 文件。
5. 安装完成后，重启 IntelliJ IDEA。

2. 项目的使用说明

2.1 基本设置

1. 在 IntelliJ IDEA 中加载一个 Scala 项目。
2. 进入 Settings -> SBT，配置 VM 参数。
3. 从插件版本 1.4.0 开始，不再需要指定 sbt-launch.jar 的路径，插件自带了 0.13.0 版本的启动器。

2.2 交互式 SBT 控制台

1. 在 IntelliJ IDEA 中打开 SBT 控制台。
2. 可以使用 SBT 进行交互式操作，例如运行 ~compile 命令。
3. 控制台支持有限的自动补全功能（使用 CTRL-SPACE 键）。
4. 控制台历史记录可以通过上下箭头进行查看。

2.3 运行配置设置

1. 在 Run Configurations 中，可以替换 IntelliJ 内置的 Make 功能为 SBT。
2. 在 Before Launch 动作中添加 SBT 命令，例如 compile 和 copy-resources。
3. 这对于 Application、ScalaTest 和 Specs2 的默认运行配置非常有用。

2.4 构建失败的通知

1. 如果构建失败，SBT 控制台会弹出并显示超链接的错误信息。
2. 点击链接后，可以使用 CTRL-ALT-UP/DOWN 键滚动查看错误列表。

2.5 在当前模块中运行

1. 选择 Run in Current Module 选项，可以在活动模块中运行构建。
2. 这可以避免不必要的重新编译与当前类无关的模块。

3. 项目API使用文档

由于 idea-sbt-plugin 主要是一个集成插件，其 API 使用文档较为简单，主要涉及 SBT 控制台的交互和运行配置的设置。具体 API 使用方法可以参考上述的“交互式 SBT 控制台”和“运行配置设置”部分。

4. 项目安装方式

4.1 通过 Maven 构建

1. 确保已安装 Maven。
2. 在项目根目录下运行以下命令：

   mvn -Didea.home="/Applications/IntelliJ Idea 15.app/Contents" install
   

3. 构建完成后，插件的 ZIP 文件将位于 sbt-dist/target/ 目录中。

4.2 在 IntelliJ IDEA 中打开项目

1. 打开 IntelliJ IDEA。
2. 导入项目并设置 Project SDK 为 IntelliJ Plugin SDK。
3. 使用 Run Configuration 中的 plugin 配置，启动一个带有修改后插件的 IntelliJ 子进程。

通过以上步骤，您可以成功安装并使用 idea-sbt-plugin 插件，轻松地在 IntelliJ IDEA 中构建 Scala 项目。