Typstyle 项目使用教程

Typstyle 项目使用教程

typstyleBeautiful and reliable typst code formatter项目地址:https://gitcode.com/gh_mirrors/ty/typstyle

1. 项目介绍

Typstyle 是一个用于格式化 Typst 代码的开源项目。Typst 是一种用于排版和文档生成的语言，Typstyle 旨在提供一个美观且可靠的代码格式化工具，帮助开发者保持代码的一致性和可读性。

Typstyle 支持多种安装方式，包括从 GitHub 下载二进制文件、使用包管理器安装、通过 cargo-binstall 安装以及直接使用 cargo 安装。项目遵循 Apache-2.0 许可证，拥有活跃的社区支持和持续的更新。

2. 项目快速启动

安装 Typstyle

从 GitHub 下载二进制文件

你可以从 GitHub Releases 页面下载适合你操作系统的二进制文件。

使用包管理器安装

通过包管理器安装 Typstyle：

# 使用 repology 安装
https://repology.org/project/typstyle/versions

使用 cargo-binstall 安装

cargo binstall typstyle

使用 cargo 安装

cargo install typstyle --locked

使用 Typstyle

格式化单个文件

typstyle -i file.typ

格式化多个文件

typstyle -i file1.typ file2.typ file3.typ

格式化目录中的所有文件

typstyle format-all directory

从标准输入读取并输出格式化结果

cat file.typ | typstyle > file-formatted.typ

3. 应用案例和最佳实践

在编辑器中使用

Typstyle 已经集成到 tinymist 插件中，你可以在编辑器中通过安装该插件来使用 Typstyle。

使用 pre-commit 钩子

在 pre-commit 配置文件中添加以下内容，以便在提交代码前自动格式化 Typst 文件：

- repo: https://github.com/Enter-tainer/typstyle
  rev: '' # 使用你想要的版本或标签
  hooks:
    - id: typstyle

禁用格式化

如果你发现 Typstyle 在某些代码段上无法正常工作，可以使用以下注释来禁用格式化：

// @typstyle off

或

/* @typstyle off */

4. 典型生态项目

Typst

Typst 是 Typstyle 的主要应用场景，Typst 是一种用于排版和文档生成的语言，Typstyle 帮助开发者保持 Typst 代码的整洁和一致性。

Tinymist

Tinymist 是一个编辑器插件，支持 Typstyle 的集成，使得开发者可以在编辑器中直接使用 Typstyle 进行代码格式化。

Cargo

Cargo 是 Rust 的包管理器，Typstyle 可以通过 Cargo 进行安装和管理，方便 Rust 开发者使用。

通过以上教程，你可以快速上手并充分利用 Typstyle 来提升你的 Typst 代码质量。

typstyleBeautiful and reliable typst code formatter项目地址:https://gitcode.com/gh_mirrors/ty/typstyle