10 分钟上手 Typstyle：新手必备的 Typst 代码格式化指南

10 分钟上手 Typstyle：新手必备的 Typst 代码格式化指南

【免费下载链接】typstyleBeautiful and reliable typst code formatter项目地址: https://gitcode.com/gh_mirrors/ty/typstyle

Typstyle 是一款为 Typst 打造的代码格式化工具，它能让你的代码变得美观且规范，让你专注于内容创作而不是格式调整。无论是新手还是有经验的开发者，都能在短时间内掌握它的使用方法，轻松提升代码质量。

📦 快速安装 Typstyle

安装 Typstyle 非常简单，根据你的系统环境选择以下任意一种方式即可快速完成安装。

通过 Cargo 安装

如果你已经安装了 Rust 环境，那么可以直接使用 Cargo 命令安装 Typstyle：

cargo install typstyle --locked

这条命令会从 crates.io 下载并安装最新版本的 Typstyle，--locked选项可以确保依赖版本的稳定性。

通过源码构建

如果你想体验最新的开发版本，可以通过源码构建：

git clone https://gitcode.com/gh_mirrors/ty/typstyle cd typstyle cargo build --release

构建完成后，可执行文件会生成在target/release目录下。

🚀 基本使用方法

安装完成后，你就可以开始使用 Typstyle 来格式化你的 Typst 代码了。

格式化单个文件

使用以下命令可以格式化指定的 Typst 文件，并将结果直接写回文件（原地格式化）：

typstyle -i your_file.typ

其中-i参数表示 in-place（原地）修改文件。

检查文件格式

如果你只是想检查文件是否符合格式规范，而不想直接修改文件，可以使用--check选项：

typstyle --check your_file.typ

如果文件格式不符合规范，命令会输出相应的提示信息。

查看格式差异

如果你想查看格式化前后的具体差异，可以使用--diff选项：

typstyle --diff your_file.typ

这会以统一差异的形式展示格式化带来的变化，让你更清晰地了解格式调整的内容。

⚙️ 配置 Typstyle

Typstyle 支持通过配置来自定义格式化行为，以满足不同项目的需求。配置相关的逻辑主要在crates/typstyle-core/src/config.rs文件中实现。你可以根据自己的喜好和项目规范，调整诸如缩进大小、换行规则等参数。

📝 在 Typst 文档中嵌入使用

Typstyle 还提供了在 Typst 文档中直接使用的方式，通过contrib/typstyle-embedded/目录下的 Typst 包，你可以在文档内部调用格式化功能。例如：

#import "typstyle-embedded/src/lib.typ": typstyle #let code = " #let x = 1 + 2 #let y = x * 3 " #let formatted = typstyle.format(code)

这样就可以在文档中直接获取格式化后的代码。

💡 常见问题与解决方法

格式化后代码出现错误？

如果格式化后的代码出现意外错误，可以尝试使用format-with-error函数，它会在格式化失败时将错误信息以注释的形式包含在结果中，帮助你定位问题：

#let result = typstyle.format-with-error(code)

如何处理特殊格式的代码？

如果你有一些不想被格式化的代码片段，可以使用@typstyle off指令暂时关闭格式化功能，处理完成后再用@typstyle on重新开启。

🎯 总结

通过本文的介绍，你已经了解了 Typstyle 的基本安装、使用方法以及一些高级特性。Typstyle 作为一款优秀的 Typst 代码格式化工具，能够帮助你轻松维护代码的整洁和规范。无论是在命令行中使用，还是嵌入到 Typst 文档中，它都能为你提供一致且美观的代码格式化效果。现在就动手尝试一下，让你的 Typst 代码焕发出新的光彩吧！

核心的格式化逻辑位于crates/typstyle-core/src/pretty/目录下，如果你对 Typstyle 的实现细节感兴趣，可以查阅相关源码进行深入了解。希望这篇指南能帮助你快速上手 Typstyle，享受高效的代码格式化体验！

【免费下载链接】typstyleBeautiful and reliable typst code formatter项目地址: https://gitcode.com/gh_mirrors/ty/typstyle