Gelatyx

格式化文档文件中的代码块。

功能

• 格式化文档文件中的语言代码块。
• 检查模式。询问 Gelatyx 文档是否已格式化。
• 支持通配符。
• 通过配置文件配置格式化器。
• 精美错误信息和彩色输出。
• 跨平台和单个二进制文件。
• 支持的语言
  • 通过 StyLua 支持 Lua

使用方法

$ gelatyx --language lua input.md                                 Format a file with lua formatter
$ gelatyx --language lua *.md                                     Format multiple files ...
$ gelatyx --language lua input.md --check                         Check if the docs has been formatted.
$ gelatyx --language lua input.md --language-config config.toml   Configure the formatter.

与其他格式化器的集成

如果你想让 gelatyx 支持你喜欢的格式化器，请随时创建新问题。

安装

从二进制文件

发布页面 包含为 GNU/Linux、macOS 和 Windows 预编译的二进制文件。

从源代码

使用 cargo-binstall

$ cargo binstall gelatyx

使用 Rust 的包管理器 cargo

$ cargo install gelatyx

开发

git clone https://github.com/azzamsa/gelatyx

# Build
cd gelatyx
cargo build

# Run unit tests and integration tests
cargo test

# Install
cargo install --path .

贡献

要了解更多，请阅读开发指南

名称的起源

Gelatyx 这个名字是对 Gelatik 的戏谑版本。来自印度尼西亚的一种美丽鸟类。

致谢

• Anthony Sottile 的 blacken-docs
• Noto Emoji