包含的语言

Inkjet 随附了对七十多种语言的内置支持，并且很容易添加更多 - 请参阅常见问题解答部分。

除了这些语言，Inkjet 还提供了 Runtime 和 Plaintext 语言。

• Runtime 包含一个指向 fn() -> &'static HighlightConfiguration 指针，该指针用于在运行时解析语言。
• Plaintext 允许廉价的空操作高亮。它在底层加载 diff 语法，但提供没有高亮查询。它别名为 none 和 nolang。

Cargo 功能

• (默认) html - 启用捆绑的 HTML 格式化工具，它依赖于 v_htmlescape。
• (默认) theme - 启用主题 API，它依赖于 ahash、toml 和 serde。
• (默认) all-languages - 启用所有语言。
• language-{name} - 启用指定的语言。
  • 如果您只想启用包含语言的一个子集，您必须设置 default-features=false 并手动重新添加您想要使用的每个语言。

常见问题解答

"为什么 Inkjet 那么大?"

由 tree-sitter 生成的解析器源代码可以非常大，有些大小可达数十兆字节。Inkjet 必须为它支持的所有语言捆绑这些源代码，因此它会累积。 (根据 loc，有超过 2300 万行 C 代码！)

如果您需要最小化二进制大小，请考虑禁用您不需要的语言。链接时间优化也可以节省几兆字节。

"为什么 Inkjet 构建需要这么长时间?"

因为它必须编译和链接数十个 C/C++ 程序（Inkjet 捆绑的每个语言的解析器和扫描器）。

然而，在第一次构建之后，这些工件将被缓存，后续构建应该会更快。

"为什么高亮需要对高亮器的可变引用?"

在底层，Inkjet 创建了一个 tree-sitter 高亮器/解析器对象，该对象反过来动态分配一块工作内存。因此，如果使用相同的高亮器执行多个同时作业，就会导致各种讨厌的不确定行为。

如果您想要并行高亮，您必须为每个线程创建高亮器的副本。如果您需要一个快速且简单的解决方案，我推荐使用 thread_local! 和 RefCell。

"我想高亮的语言没有捆绑在 Inkjet 中！"

假设您或其他人已经为要高亮的语言实现了准备好高亮的 tree-sitter 语法，将其添加到 Inkjet 中很容易！只需打开一个请求添加该语言的 issue，链接到该语言的语法仓库。

或者，您可以使用 Language::Runtime，这将允许您使用 Inkjet 捆绑之外的语言的语法。

其他注意事项

• 喷墨打印目前仅支持检查由 tree-sitter 生成的解析器的语法存储库（以避免在构建时依赖 node/npm。）
• Inkjet 要求语法至少包含一个针对基本 tree-sitter 库的 highlights.scm 查询。扩展查询（如来自 nvim-treesitter 的查询）将不起作用。
• 我不会支持类似 Solidity 的区块链/智能合约语言。请将您的骗局支持者转移到其他地方。

构建

对于常规使用，Inkjet 将像任何其他 crate 一样自动编译。

但是，如果您已分叉了存储库并希望更新捆绑的语言，您需要设置一些环境变量

• INKJET_REDOWNLOAD_LANGS 将清除 languages/ 目录并从头开始重新下载一切。
  • 目前，这仅在 *nix 上有效。您需要安装 git、sed 和 wget。（Git 克隆语法存储库，而 sed 和 wget 被用于一些语言的微型设置脚本。）
• INKJET_REBUILD_LANGS_MODULE 将清除 src/languages.rs 并从头开始重新生成它。
• INKJET_REBUILD_FEATURES 将在 crate 根目录中生成一个名为 features 的文件，其中包含所有单个语言功能（可粘贴到 Cargo.toml。）

这些变量的值无关紧要 - 只需设置即可。

此外

• 您需要传递 --all-features 标志到 cargo 以使其工作 - 默认情况下，构建脚本的开发部分不会被编译。
• 我建议在重新下载语言时运行 cargo build -vv，以便脚本进度可见。

致谢

• Inkjet 的实现离不开 tree-sitter 和其周围的语法生态系统。
• 许多语言的支持归功于 Helix 项目创建的突出显示查询。