Dfmt 项目使用教程

Dfmt 项目使用教程

dfmtDfmt is a formatter for D source code项目地址:https://gitcode.com/gh_mirrors/df/dfmt

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

Dfmt 项目的目录结构如下：

dfmt/
├── bin/
│   └── dfmt (生成的二进制文件)
├── source/
│   ├── dfmt/
│   │   ├── main.d (主程序文件)
│   │   └── ... (其他源代码文件)
│   └── ... (其他子模块)
├── dub.sdl (DUB 配置文件)
├── Makefile (构建脚本)
├── README.md (项目说明文档)
└── ... (其他项目文件)

目录结构介绍

• bin/: 存放生成的二进制文件。
• source/: 存放项目的源代码文件。
  • dfmt/: 包含主程序文件 main.d 和其他相关源代码文件。
• dub.sdl: DUB 配置文件，用于项目的依赖管理和构建配置。
• Makefile: 构建脚本，用于编译项目。
• README.md: 项目说明文档，包含项目的基本信息和使用说明。

2. 项目的启动文件介绍

Dfmt 项目的启动文件是 source/dfmt/main.d。该文件包含了程序的主入口点，负责读取输入、格式化代码并输出结果。

启动文件介绍

• main.d: 主程序文件，负责处理命令行参数、读取输入文件或标准输入，并调用格式化逻辑。

3. 项目的配置文件介绍

Dfmt 项目使用 EditorConfig 文件进行配置。配置文件通常命名为 .editorconfig，并放置在项目的根目录下。

配置文件介绍

• .editorconfig: 配置文件，用于定义代码格式化的规则。Dfmt 支持的配置项包括：
  • dfmt_brace_style: 控制大括号风格。
  • dfmt_soft_max_line_length: 设置软行长度限制。
  • dfmt_align_switch_statements: 控制是否对齐 switch 语句中的标签。
  • dfmt_outdent_attributes: 控制是否减少属性的缩进级别。
  • dfmt_split_operator_at_line_end: 控制是否在行尾拆分操作符。
  • dfmt_space_after_cast: 控制是否在类型转换后添加空格。
  • dfmt_space_after_keywords: 控制是否在关键字后添加空格。
  • dfmt_space_before_named_arg_colon: 控制是否在命名参数前添加空格。
  • dfmt_keep_line_breaks: 控制是否保留现有的换行符。
  • dfmt_single_indent: 控制是否使用单个缩进。
  • dfmt_reflow_property_chains: 控制是否重新计算属性链的拆分。

示例配置文件

# .editorconfig 示例
[*.d]
dfmt_brace_style = allman
dfmt_soft_max_line_length = 80
dfmt_align_switch_statements = true
dfmt_space_after_cast = true
dfmt_space_after_keywords = true

通过以上配置，可以自定义 Dfmt 的代码格式化行为，以满足项目的特定需求。

dfmtDfmt is a formatter for D source code项目地址:https://gitcode.com/gh_mirrors/df/dfmt