sbt-typelevel 项目教程

sbt-typelevel 项目教程

sbt-typelevelLet sbt work for you.项目地址:https://gitcode.com/gh_mirrors/sb/sbt-typelevel

项目介绍

sbt-typelevel 是一个为 Scala 库开发、测试、跨平台构建、发布和文档生成提供配置的 sbt 插件集合。它专注于语义版本控制和二进制兼容性，旨在简化在 GitHub 上开发 Scala 库的流程。sbt-typelevel 包含多个插件，这些插件既可以单独使用，也可以组合使用以提供更强大的功能。

项目快速启动

安装 sbt-typelevel

首先，在你的 project/plugins.sbt 文件中添加以下内容：

addSbtPlugin("org.typelevel" % "sbt-typelevel" % "0.7.2")

配置你的构建

在你的 build.sbt 文件中，添加以下配置：

ThisBuild / organization := "com.example"
ThisBuild / scalaVersion := "2.13.6"
ThisBuild / version := "0.1.0-SNAPSHOT"

lazy val root = (project in file("."))
  .settings(
    name := "MyProject",
    libraryDependencies ++= Seq(
      "org.typelevel" %% "cats-core" % "2.6.1"
    )
  )

启动项目

在终端中运行以下命令来启动你的项目：

sbt run

应用案例和最佳实践

应用案例

sbt-typelevel 被广泛应用于 Typelevel 和 http4s 等活跃的开源项目中。这些项目利用 sbt-typelevel 提供的自动化工作流程和最佳实践，简化了开发和发布流程。

最佳实践

1. 自动化工作流程：利用 sbt-typelevel 自动生成的 GitHub Actions 工作流程，可以并行化 Scala 版本和平台的构建。
2. 语义版本控制：通过 sbt-typelevel 的动态版本控制和二进制兼容性检查，确保项目的版本管理符合语义版本规范。
3. 文档生成：使用 sbt-typelevel-site 插件，结合 mdoc 和 Laika 生成项目文档，并自动部署到 GitHub Pages。

典型生态项目

sbt-typelevel-site

sbt-typelevel-site 是一个可选插件，用于生成带有 mdoc 和 Laika 的网站，并从 CI 自动部署到 GitHub Pages。你可以将其与 sbt-typelevel 或 sbt-typelevel-ci-release 插件一起使用，或单独使用。

sbt-typelevel-ci-release

sbt-typelevel-ci-release 插件包含了 sbt-typelevel 的核心功能，并添加了 CI 发布功能，支持将发布和快照版本自动发布到 Sonatype/Maven。

sbt-typelevel-settings

sbt-typelevel-settings 提供了一些良好的（或是有主见的）默认设置，如 scalacOptions 和其他配置，以简化项目的构建配置。

通过这些插件的组合使用，sbt-typelevel 提供了一个全面的解决方案，帮助开发者高效地管理和发布 Scala 项目。

sbt-typelevelLet sbt work for you.项目地址:https://gitcode.com/gh_mirrors/sb/sbt-typelevel