erlfmt 项目使用教程

erlfmt 项目使用教程

erlfmt An automated code formatter for Erlang 项目地址: https://gitcode.com/gh_mirrors/er/erlfmt

1. 项目目录结构及介绍

erlfmt 是一个针对 Erlang 代码的自动化格式化工具。它的目的是通过自动化代码格式化过程，让开发团队更专注于代码的功能实现，而非外观格式。

项目目录结构如下：

erlfmt/
├── .github/              # GitHub 工作流和模板文件
├── doc/                  # 文档文件夹
├── src/                  # 源代码文件夹
├── test/                 # 测试代码文件夹
├── .gitignore            # Git 忽略文件列表
├── CHANGELOG.md          # 项目更新日志
├── CODE_OF_CONDUCT.md    # 项目行为准则
├── LICENSE               # 项目许可证文件
├── Makefile              # Makefile 文件
├── README.md             # 项目介绍文件
├── RELEASE.md            # 项目发布说明
├── StyleGuide.md         # 代码风格指南
├── erlang_ls.config      # erlang_ls 配置文件
├── rebar.config          # rebar 配置文件
├── rebar.lock            # rebar 锁文件

主要文件夹说明：

• .github/: 包含 GitHub 工作流和 issue 模板等。
• doc/: 包含项目的文档。
• src/: 包含 erlfmt 的源代码。
• test/: 包含项目的测试代码。
• Makefile: 包含构建项目的指令。

2. 项目的启动文件介绍

erlfmt 的启动主要是通过 rebar3 插件来完成的。在项目的根目录下，通过以下命令可以启动 rebar3：

rebar3

如果要构建一个独立的 escript，可以运行：

rebar3 as release escriptize

构建完成后，可以在 _build/release/bin/ 目录下找到 erlfmt 脚本文件，直接运行它即可：

./_build/release/bin/erlfmt

3. 项目的配置文件介绍

erlfmt 的配置主要通过 rebar.config 文件来进行。以下是一个基本的 rebar.config 文件示例：

{project_plugins, [
    erlfmt
]}.

{erlfmt, [
    {write, true}  % 是否直接写入文件
]}.

在这个配置文件中，{project_plugins, [erlfmt]} 指定了 rebar3 使用 erlfmt 插件。{erlfmt, [{write, true}]} 则配置了 erlfmt 在格式化代码后直接写入文件。

erlfmt 还支持其他配置选项，例如设置最大行长度等，具体可以参考项目的官方文档。

通过以上介绍，您应该对如何使用 erlfmt 项目有了基本的了解。使用 erlfmt 可以帮助您的团队保持代码风格的一致性，提高代码的可读性。

erlfmt An automated code formatter for Erlang 项目地址: https://gitcode.com/gh_mirrors/er/erlfmt