np 项目技术文档

本文档旨在帮助用户了解和使用 np 项目，一个用于在 Simple Build Tool (sbt) 中快速创建新项目的简单工具。

1. 安装指南

sbt 0.12 或更低版本

全局安装

如果已经创建了 ~/.sbt 目录，在 ~/.sbt/plugins/build.sbt 文件中添加以下内容：

addSbtPlugin("me.lessis" % "np" % "0.2.0")
resolvers += Resolver.url("sbt-plugin-releases",
  url("http://scalasbt.artifactoryonline.com/scalasbt/sbt-plugin-releases/"))(
    Resolver.ivyStylePatterns)

或者，如果您更愿意，可以通过 git 仓库依赖项目。

import sbt._

object Plugins extends Build {
  lazy val root = Project("root", file(".")) dependsOn(
    uri("git://github.com/softprops/np.git#0.2.0")
  )
}

确保明确地将 np 的设置混合到您的构建定义中。

seq(npSettings: _*)

在全局 .sbt 文件下（如 ~/.sbt/np.sbt）这样做将使 np 的设置对所有 sbt 项目可用。

局部安装

如果有一个 ~/project 目录，在 ~/project/build.sbt 文件中添加以下内容：

addSbtPlugin("me.lessis" % "np" % "0.2.0")
resolvers += Resolver.url("sbt-plugin-releases",
  url("http://scalasbt.artifactoryonline.com/scalasbt/sbt-plugin-releases/"))(
    Resolver.ivyStylePatterns)

sbt 0.13 及以上版本

如果没有，创建一个 ~/.sbt/0.13/plugins 目录。在其中，创建一个名为 np.sbt 的文件（文件名无关紧要），包含以下内容：

addSbtPlugin("me.lessis" % "np" % "0.2.0")

这将使 npSettings 在项目定义中全局可见。

如果您希望全局混合 npSettings，在 ~/.sbt/0.13 下创建一个名为 np.sbt 的文件，包含以下内容：

seq(npSettings: _*)

定制化

如果您有很多项目使用相同的 ivy 组织 ID（您自己的）或者总是以相同的版本约定开始项目（SNAPSHOT），您可能想要定义自己的全局覆盖。

在 sbt 0.12 中的 ~/.sbt/np.sbt 文件或在 sbt 0.13 中的 ~/.sbt/0.13/np.sbt 文件中添加以下内容：

seq(npSettings:_*)

(NpKeys.defaults in (Compile, NpKeys.np)) ~= {
  _.copy(org="me.lessis", version="0.1.0-SNAPSHOT")
}

查看下文的 np 选项参考部分，了解所有可用选项。

2. 项目的使用说明

在 sbt 中使用以下命令来创建新项目：

sbt
np name:np

如果您已经有了一个项目并且想要创建一个子项目，也可以：

sbt
np name:my-sub-project dir:sub-project-dir

这将在相对于项目基本目录的 sub-project-dir 目录下创建一个新的 sbt 项目源树。在主构建配置中，您可以将其作为存根使用，并引用为：

lazy val sub = Project("my-sub-project", file("sub-project-dir"))

或者删除生成的存根 build.sbt，只使用生成的源树。

3. 项目API使用文档

np 命令生成 sbt 项目，给定 key:value 选项。以下是当前选项的列表：

• org：项目组织。默认为 sbt 内置默认值。
• name：项目名称。默认为 sbt 内置默认值。
• version：项目版本。默认为 sbt 内置默认值。
• plugin：布尔指标，指示项目是否为插件项目。默认为 false。
• dir：np 应生成项目的目录路径。默认为 '.'。

4. 项目安装方式

请参考上文中的安装指南进行项目安装。