Rust中的Starlark

GitHub上有多份此仓库的副本，facebookexperimental/starlark-rust是官方的。

此项目提供了Starlark语言的Rust实现。Starlark（原名Skylark）是一种受Python3启发的确定性语言，用于Bazel、Buck和Buck2等构建系统的配置，其中Buck2依赖于这个库。该项目最初在这个仓库中开发（此仓库），包含更详细的历史记录。

至少有三种Starlark实现，一个是Java，一个是Go，以及这个Rust版本。我们主要遵循Starlark标准。如果您想尝试Rust Starlark，可以克隆此仓库并运行

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
$ cargo run
$> 1+2
3

此项目由Damien Martin-Guillerez发起。此库的0.4.0版本将所有权从Google变更为Facebook。

了解更多

阅读此博客文章，了解库的概述、Starlark的原因以及它如何适应您的项目。还有2分钟介绍视频。

功能

此项目具有以下功能

• Rust类型和Starlark之间易于互操作。
• 友好的Rust类型，因此冻结值是Send/Sync，而非冻结值则不是。
• 堆上分配的垃圾收集值。
• 可选的运行时检查类型。
• 用于检测 Starlark 代码问题的代码检查器。
• 以LSP形式实现的IDE集成。
• 包括模糊测试在内的广泛测试。
• 支持DAP。

本项目还有三个非目标

• 我们不旨在发布之间的API稳定性，而是希望快速迭代并尽可能完善API。但我们确实遵循SemVer。
• 我们不旨在最小化依赖项，而是希望保持一个功能强大的包。但如果某些依赖项很复杂，我们可能会添加功能标志。

组件

共有六个组件

• starlark_derive，一个proc-macro包，定义了Starlark所需的宏。这个库是starlark库的依赖项，该库重新导出所有相关部分，不应直接使用。
• starlark_map，一个包含内存高效的有序/无序映射/集合和各种其他在Starlark中有用的数据结构的库。
• starlark_syntax，一个包含Starlark的AST和解析函数的库。只有在您想直接操作AST时才使用。
• starlark是主库，包含评估器、标准库、调试器支持和许多其他部分。希望将Starlark嵌入其环境中的项目（具有额外的类型、库函数和功能）将使用此库。此库重新导出starlark_derive、starlark_map和大部分starlark_syntax的相关部分。
• starlark_lsp，一个提供LSP的库。
• starlark_bin是二进制文件，提供交互式评估、IDE功能和代码检查器，通过命令行公开。如果您想使用纯Starlark（但如果有，请考虑Python3），或者作为实验的测试平台，这很有用。大多数项目最终将在starlark和starlark_lsp库上实现一些功能，并结合它们特定的额外类型等。

特别是starlark_bin二进制文件可以有效地用作代码检查器。但对于REPL、评估器和IDE功能，starlark_bin二进制文件只知道标准的Starlark。大多数Starlark嵌入提供额外的函数和数据类型来处理特定领域的问题，如果没有这些绑定，使用它们会导致REPL/评估器失败，并导致IDE体验不佳。在大多数情况下，您应该编写自己的二进制文件，依赖于starlark库，集成您特定的领域特定组件，然后使用捆绑的LSP函数在之上产生您自己的IDE/REPL/评估器。您仍然可以使用VS Code扩展。

兼容性

在本节中，我们概述了我们不遵守Starlark规范的地方。

• 我们有很多扩展，例如类型注解、递归、顶层for。
• 我们尚未支持Starlark的后续添加，例如字节。
• 在某些情况下，创建循环数据结构可能会导致栈溢出。

发布版本

1. 检查GitHub Actions是否为绿色。
2. 使用自上次发布以来的更改更新CHANGELOG.md。此链接可能会有所帮助（更新为与上次发布进行比较）。
3. 更新两个 Cargo.toml 文件的版本号。如果没有不兼容的更改，则将其提升 0.0.1，如果有则提升到 0.1.0。将 starlark 的依赖项更新到指向最新的 starlark_derive 版本。
4. 将文件 CHANGELOG.md、LICENSE 和 README.md 复制到每个子目录中。
5. 在每个组件目录中按上述顺序运行 cargo publish --allow-dirty --dry-run，然后在没有 --dry-run 的情况下执行。
6. 使用 starlark 版本作为名称，创建一个带有 v0.X.Y 的 GitHub 发布版。

许可证

Starlark Rust 采用 Apache License，版本 2.0 授权，如 LICENSE 文件中所示。