LuaFormatter 使用教程

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

LuaFormatter 是一个用于格式化 Lua 代码的开源工具。以下是其基本的目录结构：

LuaFormatter/
├── CMakeLists.txt
├── LICENSE
├── README.md
├── bin/
├── cmake/
├── config/
├── doc/
├── include/
├── src/
├── test/
└── tools/

• CMakeLists.txt: 用于构建项目的 CMake 配置文件。
• LICENSE: 项目的许可证文件，采用 Apache-2.0 许可证。
• README.md: 项目的基本介绍和使用说明。
• bin/: 存放编译后的可执行文件。
• cmake/: 包含 CMake 构建过程中需要的额外模块。
• config/: 存放项目的配置文件。
• doc/: 存放项目的文档文件。
• include/: 存放项目的头文件。
• src/: 存放项目的源代码文件。
• test/: 存放项目的测试代码文件。
• tools/: 存放项目相关的工具文件。

2. 项目的启动文件介绍

LuaFormatter 的启动文件是 bin 目录下的可执行文件。通常，编译后会在 bin 目录下生成一个名为 lua-format 的可执行文件。

使用方法如下：

./lua-format [Lua scripts] [OPTIONS]

• Lua scripts: 需要格式化的 Lua 脚本文件。
• OPTIONS: 可选参数，例如 -h 显示帮助信息，-v 开启详细模式等。

3. 项目的配置文件介绍

LuaFormatter 的配置文件通常位于 config 目录下，或者可以通过 --config=[file] 选项指定配置文件路径。配置文件的格式为 JSON 或 YAML。

以下是一个示例配置文件的内容：

{
  "column_limit": 80,
  "indent_width": 2,
  "use_tab": false,
  "tab_width": 2,
  "continuation_indent_width": 4,
  "spaces_before_call": 1
}

• column_limit: 每行的最大字符数。
• indent_width: 缩进的宽度。
• use_tab: 是否使用制表符进行缩进。
• tab_width: 制表符的宽度。
• continuation_indent_width: 续行缩进的宽度。
• spaces_before_call: 函数调用前的空格数。

通过修改配置文件，可以自定义 LuaFormatter 的格式化规则。