介绍

一般团队中都会制定不同的编码风格,但是在实施时没有强制性的措施,无法保持统一。

在这一方面,Go 与 Rust 做得就很好,分别有一个 gofmt 与 rustfmt 工具负责在保存时格式化代码。

环境

  • macOS 10.14.5
  • cmake 3.15.0
  • Xcode 10.2.1
  • Visual Studio Code 1.31.1

工具

其实 Lua 也可以使用格式化工具。经过在网上搜索比较之后,个人觉得 Koihik/LuaFormatter: Code formatter for Lua 比较合适。

由于作者未提供二进制可执行文件,因此需要手动编译:

1
2
3
4
5
6
7
brew install cmake

git clone https://github.com/Koihik/LuaFormatter.git
cd LuaFormatter
cmake .
make
make install

配置

wiki 中提供了所有选项及其参数解释,建议在实际使用时将所有选项及对应的值都保存到文件中,这样就算是默认值发生了变化,也不会有任何影响。

使用

首先需要安装 vscode-lua-format - Visual Studio Marketplace

然后就可以打开一个 Lua 文件试试格式化的效果。