StyLua 使用教程

StyLua 使用教程

StyLuaAn opinionated Lua code formatter项目地址:https://gitcode.com/gh_mirrors/st/StyLua

1. 项目介绍

StyLua 是一个基于 Lua 的强力代码格式化工具，它采用全解析重写的方式，确保你的 Lua 和 Luau 代码风格一致。灵感来源于 Prettier，StyLua 遵循 Roblox Lua 风格指南，同时也允许进行一些自定义设置。这个工具通过解析代码库并重新打印，强制执行一致的编码风格，使得团队合作时代码风格统一变得轻松。

2. 项目快速启动

安装

GitHub 发布版

你可以从 GitHub 的发布页面获取预编译的二进制文件：

curl -LJO https://github.com/JohnnyMorganz/StyLua/releases/download/v0.20.0/stylua_$(uname -s)_$(uname -m).tar.gz
tar xvf stylua_$(uname -s)_$(uname -m).tar.gz
sudo mv stylua /usr/local/bin/

Cargo（Rust 包管理器）

如果你已经安装了 Rust 工具链，可以通过 Cargo 来安装 StyLua：

cargo install stylua --features lua54

格式化代码

安装完成后，使用以下命令来格式化 Lua 或 Luau 代码：

stylua path/to/your/file.lua

或者，一次性格式化整个目录下的所有 .lua 文件：

stylua src/

3. 应用案例和最佳实践

在大型项目中，推荐将 StyLua 整合到你的持续集成（CI）流程中，确保每次提交都经过代码格式检查。你还可以通过配置 .prettierrc 或其他支持的配置文件来自定义格式规则。

对于团队协作，建议在版本控制系统如 Git 中添加 .gitattributes 文件，指定使用 StyLua 进行自动格式化：

*.lua text diff=lua eol=lf

然后在 pre-commit 脚本中添加 StyLua，以在提交前自动格式化所有变动的 Lua 文件。

4. 典型生态项目

• VSCode 扩展: 在 Visual Studio Code 中，可以安装 StyLua 扩展，实现快捷的代码格式化。
• Neovim 集成: 对于 Vim 用户，可以使用 stylua-nvim 提供无缝的 Vim 内部整合。
• Sublime Text 插件: 可以在 Sublime Text 中通过包管理器安装对应的插件，让格式化功能触手可及。

以上就是 StyLua 的基本使用教程，更多详细信息和高级配置，建议查阅 项目官方文档。

StyLuaAn opinionated Lua code formatter项目地址:https://gitcode.com/gh_mirrors/st/StyLua