LuaFormatter：终极 Lua 代码格式化工具，让你的代码风格统一又美观

LuaFormatter：终极 Lua 代码格式化工具，让你的代码风格统一又美观

【免费下载链接】LuaFormatterCode formatter for Lua项目地址: https://gitcode.com/gh_mirrors/lu/LuaFormatter

LuaFormatter 是一款专业的 Lua 代码格式化工具，能够帮助开发者自动调整代码格式，实现风格统一与视觉美化。无论是个人项目还是团队协作，它都能显著提升代码可读性和维护效率，是 Lua 开发者不可或缺的工具。

🚀 为什么选择 LuaFormatter？

在 Lua 开发过程中，代码风格不一致往往导致协作效率低下、代码难以维护。LuaFormatter 应运而生，它通过自动化的格式处理，解决了以下核心问题：

• 风格统一：消除团队成员间的代码风格差异，减少无意义的格式争论
• 视觉优化：自动调整缩进、换行和空格，使代码结构清晰、层次分明
• 配置灵活：支持多种格式化规则自定义，满足不同项目的风格需求
• 节省时间：告别手动调整格式的繁琐工作，专注于逻辑实现

⚙️ 核心功能与配置选项

LuaFormatter 提供了丰富的格式化选项，通过配置文件可以精确控制代码风格。主要功能包括：

基础格式控制

• indent_width：设置缩进宽度（默认4个空格）
• use_tab：是否使用制表符代替空格（默认false）
• column_limit：行长度限制，超过将自动换行（默认80字符）

代码块优化

• keep_simple_control_block_one_line：简单控制块是否保持单行显示
• keep_simple_function_one_line：简单函数定义是否保持单行显示
• line_breaks_after_function_body：函数体后是否添加空行

函数与参数格式化

• align_parameter：函数参数是否对齐
• chop_down_parameter：参数过长时是否强制每行一个参数
• spaces_inside_functiondef_parens：函数定义括号内是否添加空格

表（Table）格式化

• align_table_field：表字段是否对齐
• chop_down_table：表项过长时是否强制每行一个表项
• column_table_limit：表单行显示的最大长度限制
• spaces_inside_table_braces：表大括号内是否添加空格

完整的配置选项说明可参考项目文档：docs/Style-Config.md

📦 快速安装指南

编译安装步骤

1. 首先克隆项目仓库：

   git clone https://gitcode.com/gh_mirrors/lu/LuaFormatter cd LuaFormatter

2. 使用 CMake 构建项目：

   mkdir build && cd build cmake .. make

3. 安装到系统路径：

   sudo make install

验证安装

安装完成后，通过以下命令验证：

lua-format --version

💻 使用方法详解

基本使用

对单个 Lua 文件进行格式化：

lua-format input.lua -o output.lua

直接修改原文件（谨慎使用）：

lua-format -i input.lua

配置文件使用

创建配置文件.lua-format，添加自定义规则：

column_limit: 100 indent_width: 2 use_tab: false align_table_field: true

使用配置文件格式化：

lua-format -c .lua-format input.lua

项目中提供了多个配置示例，可参考：test/config/

集成到开发环境

VS Code 集成

1. 安装 Lua 插件
2. 在设置中配置格式化工具路径：

   "lua.format.tool": "lua-format", "lua.format.path": "/usr/local/bin/lua-format"

Vim 集成

使用插件管理器安装sbdchd/neoformat，添加配置：

let g:neoformat_lua_luaformat = { \ 'exe': 'lua-format', \ 'args': ['-c', '~/.lua-format'] \} autocmd BufWritePre *.lua Neoformat

🧪 实际应用示例

格式化前代码

local function example(a,b) if a>b then return {name="test",value=a+b} else return nil end end

格式化后代码

local function example(a, b) if a > b then return { name = "test", value = a + b } else return nil end end

通过对比可以看到，格式化后的代码结构更清晰，缩进统一，运算符前后添加了适当空格，表项也进行了合理换行，大大提升了可读性。

🛠️ 高级自定义

自定义配置文件

LuaFormatter 支持通过 YAML 格式的配置文件进行详细设置。以下是一个完整的配置示例：

# 基本设置 column_limit: 100 indent_width: 4 use_tab: false continuation_indent_width: 8 # 函数设置 keep_simple_function_one_line: true align_parameter: true chop_down_parameter: true # 表设置 align_table_field: true chop_down_table: true column_table_limit: 80 table_sep: comma # 引号转换 single_quote_to_double_quote: true # 空格设置 spaces_inside_functioncall_parens: true spaces_inside_table_braces: true

更多配置选项可参考 docs/Style-Config.md 中的详细说明。

命令行参数

除了配置文件外，LuaFormatter 还支持通过命令行参数覆盖配置：

# 设置缩进宽度为2 lua-format --indent_width 2 input.lua # 强制使用单引号 lua-format --double_quote_to_single_quote true input.lua

📝 总结

LuaFormatter 作为一款专业的 Lua 代码格式化工具，凭借其丰富的配置选项和灵活的使用方式，能够满足不同项目和团队的代码风格需求。通过自动化的格式化处理，它不仅可以提升代码的可读性和美观度，还能有效减少团队协作中的格式争议，让开发者更专注于逻辑实现而非格式调整。

无论是个人小型项目还是大型团队开发，LuaFormatter 都能成为你提升开发效率的得力助手。立即尝试使用，体验代码格式化带来的便捷与愉悦！

【免费下载链接】LuaFormatterCode formatter for Lua项目地址: https://gitcode.com/gh_mirrors/lu/LuaFormatter