#starlark #serialization #build-system #serde #bazel #buck

serde_starlark

Serde serializer for generating Starlark build targets

17 releases

0.1.16 Jan 2, 2024
0.1.15 Dec 20, 2023
0.1.14 Jul 15, 2023
0.1.12 Apr 23, 2023
0.0.0 Dec 23, 2022

#1217 in Encoding

Download history 7666/week @ 2023-12-23 6818/week @ 2023-12-30 7763/week @ 2024-01-06 8849/week @ 2024-01-13 10297/week @ 2024-01-20 11000/week @ 2024-01-27 12417/week @ 2024-02-03 12797/week @ 2024-02-10 13964/week @ 2024-02-17 10681/week @ 2024-02-24 12026/week @ 2024-03-02 10198/week @ 2024-03-09 12187/week @ 2024-03-16 13429/week @ 2024-03-23 15751/week @ 2024-03-30 9785/week @ 2024-04-06

53,225 downloads per month
Used in 2 crates

MIT/Apache

66KB
1.5K SLoC

serde_starlark

github crates.io docs.rs build status

Serde serializer for generating syntactically valid Starlark, the declarative format used for describing build targets in build systems including Bazel, Buck, Pants, and Please.


Example

The following example serializes a minimal Bazel target for the syn crate.

The tests/bazel.rs test in this repo has a somewhat more fleshed out example of this use case, including things like load(), package(default_visibility =), distinct include and exclude arguments to glob(), and select({}).

#[derive(Serialize)]
#[serde(rename = "rust_library")]
pub struct RustLibrary {
    pub name: String,
    pub srcs: Glob,
    pub crate_features: BTreeSet<String>,
    pub edition: u16,
    pub deps: BTreeSet<String>,
}

#[derive(Serialize)]
#[serde(rename = "glob")]
pub struct Glob(pub BTreeSet<String>);

fn main() {
    let rust_library = RustLibrary { ... };

    print!("{}", serde_starlark::to_string(&rust_library).unwrap());
}
rust_library(
    name = "syn",
    srcs = glob(["**/*.rs"]),
    crate_features = [
        "default",
        "full",
    ],
    edition = 2018,
    deps = [
        ":proc-macro2",
        ":quote",
        ":unicode-ident",
    ],
)

Data model

The primitive types (integers, boolean, string) serialize in the obvious way to Starlark.

Serde sequences serialize to Starlark arrays. Serde maps serialize to Starlark maps.

Rust structs with named fields serialize to Starlark "function calls" with named arguments:

#[derive(Serialize)]
#[serde(rename = "rust_library")]
pub struct RustLibrary {
    pub name: String,
    pub edition: u16,
}
rust_library(
    name = "syn",
    edition = 2018,
)

Rust newtype structs and tuple structs serialize to Starlark "function calls" with positional arguments:

#[derive(Serialize)]
#[serde(rename = "select")]
pub struct Select<T>(pub BTreeMap<String, T>);
select({
    "//conditions:default": [],
})

To make a newtype struct which does not appear as a function call, use the serde(transparent) attribute.

#[derive(Serialize)]
#[serde(transparent)]
pub struct Dependency(pub String);

Fields of type Option<T> serialize as either None or the value if present. Consider using serde(skip_serializing_if = "Option::is_none") to omit fields with value None from the serialized output.


License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~110–355KB