StyLua 安装与使用指南

StyLua 安装与使用指南

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

1. 项目目录结构及介绍

在StyLua项目中，主要的目录结构包括：

• src: 该项目的主要源代码所在，包含了实现StyLua功能的 Lua 和 Rust 语言文件。
• tests: 测试用例目录，用于验证StyLua的功能和性能。
• examples: 示例代码，展示如何使用StyLua进行代码格式化。
• .gitignore: Git 忽略文件列表，指定了在版本控制中不需要追踪的文件或目录。
• Cargo.toml: Rust 项目的构建配置文件，定义了依赖项和其他构建设置。
• README.md: 项目的说明文档，包含了项目简介、安装方法和使用示例。

2. 项目的启动文件介绍

由于StyLua是作为命令行工具使用的，它没有传统意义上的启动文件。你可以通过运行其可执行文件（如stylua）来启动该工具。在终端中输入stylua或指定参数（例如stylua --help获取帮助），以执行代码格式化或其他相关操作。

3. 项目的配置文件介绍

StyLua的配置主要是在用户的全局或项目本地设置文件中进行的。以下是一些配置方式：

1) settings.json

对于Visual Studio Code用户，可以在settings.json文件中设置默认的代码格式器为StyLua，如下所示：

"[lua]": {
    "editor.defaultFormatter": "JohnnyMorganz.stylua"
}

2) .stylerc 或 .stylua.toml

StyLua支持自定义配置文件.stylerc或.stylua.toml，在这个文件中可以指定代码风格、排除某些规则等。例如：

indent_style = "space"
indent_size = 4
tab_width = 4
newline_style = "lf"
semicolons = "at_end_of_line"
trailing_whitespace = false
spaces_around_colons = true
max_line_length = 80

3) 命令行选项

在命令行中，可以通过参数调整配置，比如：

stylua --glob '**/*.lua' --exclude 'vendor/' -- src/

这将格式化src/目录下的所有.lua文件，但跳过名为vendor/的目录。

以上即为StyLua的基本安装与使用信息。要了解更多详细信息，建议查看官方仓库的README.md文档和示例。

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