Standard-Project 技术文档

1. 安装指南

1.1 环境准备

在开始使用 standard-project 之前，请确保您的开发环境已经安装了以下工具：

• sbt：Scala 构建工具，版本建议为 1.x 或更高。
• Java：JDK 8 或更高版本。

1.2 添加插件

要使 standard-project 插件对您的项目可用，您需要在项目的 project/plugins 目录下创建一个名为 Plugins.scala 的文件。文件内容如下：

import sbt._

class Plugins(info: ProjectInfo) extends PluginDefinition(info) {
  val twitterRepo = "twitter-repo" at "http://maven.twttr.com/"
  val standardProject = "com.twitter" % "standard-project" % "0.11.16"
}

1.3 配置项目

在项目的根目录下创建一个 build.sbt 文件，并根据您的项目需求进行配置。例如：

import sbt._
import com.twitter.sbt._

class MyProject(info: ProjectInfo) extends StandardServiceProject(info) {
  val utilCore = "com.twitter" % "util-core" % "1.2.4"
  override def mainClass = Some("com.example.awesome.MyClass")
}

2. 项目的使用说明

2.1 项目结构

standard-project 提供了一组扩展，帮助您遵循最佳实践来构建项目。项目结构通常包括以下部分：

• src/main/scala：主代码目录。
• src/test/scala：测试代码目录。
• project：包含项目的构建配置文件。

2.2 项目扩展

您可以根据项目类型选择扩展 StandardServiceProject 或 StandardLibraryProject：

• StandardServiceProject：适用于应用程序项目。
• StandardLibraryProject：适用于库项目。

2.3 依赖管理

在项目中指定依赖项，例如：

val utilCore = "com.twitter" % "util-core" % "1.2.4"

2.4 主类配置

如果您的项目是一个应用程序，您可以指定主类：

override def mainClass = Some("com.example.awesome.MyClass")

3. 项目API使用文档

3.1 可扩展类

standard-project 提供了多个可扩展的类，您可以根据项目需求选择合适的类进行扩展：

• StandardProject：扩展自 SBT 的 DefaultProject，并混合了多个实用特性。
• StandardParentProject：适用于多子项目的父项目。
• StandardLibraryProject：适用于库项目。
• StandardServiceProject：适用于服务项目。

3.2 特性

standard-project 提供了多个特性（Traits），您可以根据需要混合到项目中：

• AdhocInlines：允许指定本地源代码依赖。
• BuildProperties：生成包含构建信息的对象。
• CorrectDependencies：强制进行依赖检查。
• DefaultRepos：设置标准仓库。
• DependencyChecking：检查依赖库目录是否存在。
• EnsimeGenerator：生成 .ensime 文件。
• Environmentalist：设置环境变量的映射。
• FileFilter：简单的文件内容替换工具。
• GitHelpers：提供 Git 操作的实用工具。
• GithubPublisher：支持将工件发布到 GitHub。
• PackageDist：打包并分发项目。
• Ramdiskable：支持将编译输出到 RAM 磁盘。
• ReleaseManagement：版本管理工具。

4. 项目安装方式

4.1 通过 sbt 安装

1. 在项目根目录下运行 sbt 命令启动 sbt 控制台。
2. 运行 update 命令下载依赖项。
3. 运行 compile 命令编译项目。

4.2 通过环境变量配置

您可以通过设置环境变量来配置 standard-project 的行为，例如：

• SBT_CACHE：指定 Ivy 缓存目录。
• NO_TESTS：设置为 1 以禁用测试。
• SBT_ADHOC_INLINE：启用 AdhocInlines 功能。

通过以上步骤，您可以顺利安装并使用 standard-project，并根据项目需求进行配置和扩展。