ufofmt

基于 Rust 的 Norad 库 的快速、灵活的 UFO 源文件格式化工具

关于

ufofmt 是一个支持自定义 UFO 源文件格式的 Rust 可执行程序。

默认源文件格式

自定义格式化选项在下面的使用部分中描述。

安装

安装过程会安装 ufofmt 可执行文件。

安装 Rust，然后按照以下说明进行操作。

用户安装

以下命令安装最新版本的构建版本

$ cargo install ufofmt

使用以下命令将以前的安装升级到新版本

$ cargo install --force ufofmt

开发者安装

以下命令从存储库主分支的最新提交中安装构建版本

$ git clone https://github.com/source-foundry/ufofmt.git
$ cd ufofmt && cargo install --path .

使用

将一个或多个 UFO 源目录路径传递给 ufofmt 可执行文件

$ ufofmt [OPTIONS] [UFO PATH 1] ... [UFO PATH N]

使用命令 ufofmt --help 查看所有可用的命令行选项。

自定义源格式化选项

缩进空格字符类型

默认情况下，每级使用单缩进。使用 --indent-space 命令行选项切换到空格字符。请参阅下面的部分以定义每级的缩进空格字符数。

每级缩进空格字符数

使用 --indent-number [NUMBER] 命令行选项定义 1-4 个缩进或空格缩进字符。请参阅上面的部分以使用空格代替缩进。

XML声明引号样式

默认情况下，XML声明属性用双引号包围。可以通过--singlequotes命令行选项将其转换为单引号。

贡献

欢迎对项目的贡献！所有贡献都接受下面的许可部分中定义的项目许可。

源代码贡献

使用以下命令在可执行文件中测试本地更改：

$ cargo run -- [ARGS]

添加测试以覆盖您的源代码更改，并使用以下命令在本地运行测试套件：

$ cargo test

请提交包含更改建议的GitHub拉取请求。

文档贡献

请使用以下命令在本地构建和审查您的文档更改：

$ cargo doc --open

请提交包含更改建议的GitHub拉取请求。

许可

Apache License v2.0