neo-sbt-scalafmt 使用文档

neo-sbt-scalafmt 使用文档

1. 项目的目录结构及介绍

neo-sbt-scalafmt 是一个用于 SBT（Simple Build Tool）的插件，用于自动格式化 Scala 代码。以下是该项目的目录结构及其介绍：

neo-sbt-scalafmt/
├── build.sbt                # SBT 构建文件
├── project/                 # SBT 项目配置目录
│   ├── Build.scala          # 项目构建配置
│   ├── plugins.sbt          # 插件依赖配置
│   └── ...                  # 其他配置文件
├── src/                     # 源代码目录
│   ├── main/                # 主代码目录
│   │   ├── scala/           # Scala 源代码
│   │   └── ...              # 其他资源文件
│   └── test/                # 测试代码目录
│       ├── scala/           # Scala 测试代码
│       └── ...              # 其他测试资源文件
├── .scalafmt.conf           # Scalafmt 配置文件
└── ...                      # 其他项目文件

主要目录和文件介绍

• build.sbt: SBT 构建文件，定义了项目的依赖、插件和其他构建配置。
• project/: SBT 项目配置目录，包含项目的构建配置和插件依赖配置。
• src/: 源代码目录，包含主代码和测试代码。
• .scalafmt.conf: Scalafmt 配置文件，定义了代码格式化的规则。

2. 项目的启动文件介绍

neo-sbt-scalafmt 项目的启动文件主要是 build.sbt 和 project/plugins.sbt。

build.sbt

build.sbt 是 SBT 项目的核心构建文件，定义了项目的名称、版本、依赖和其他构建配置。以下是一个示例：

name := "neo-sbt-scalafmt"

version := "1.0.0"

scalaVersion := "2.13.6"

libraryDependencies ++= Seq(
  "org.scalameta" %% "scalafmt-core" % "2.7.5"
)

project/plugins.sbt

project/plugins.sbt 文件用于定义项目所需的 SBT 插件。以下是一个示例：

addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.2")

3. 项目的配置文件介绍

neo-sbt-scalafmt 项目的主要配置文件是 .scalafmt.conf，该文件定义了 Scalafmt 的配置规则。

.scalafmt.conf

.scalafmt.conf 文件使用 HOCON（Human-Optimized Config Object Notation）格式，以下是一个示例配置：

version = "2.7.5"
maxColumn = 120
align.preset = more
rewrite.rules = [SortImports, RedundantBraces, RedundantParens]

主要配置项介绍

• version: 指定 Scalafmt 的版本。
• maxColumn: 定义每行的最大字符数。
• align.preset: 定义对齐方式。
• rewrite.rules: 定义重写规则，如排序导入、移除多余的括号等。

通过以上配置，可以自定义代码格式化的规则，以满足项目的具体需求。