hakari

hakari 是 cargo hakari 的库，这是一个用于管理 workspace-hack 包的工具。

示例

use guppy::MetadataCommand;
use hakari::{HakariBuilder, HakariOutputOptions};

// Use this workspace's PackageGraph for these tests.
let package_graph = MetadataCommand::new()
    .build_graph()
    .expect("obtained cargo-guppy's PackageGraph");

// The second argument to HakariBuilder::new specifies a Hakari (workspace-hack) package.
// In this repository, the package is called "guppy-workspace-hack".
let hakari_package = package_graph.workspace().member_by_name("guppy-workspace-hack").unwrap().id();
let hakari_builder = HakariBuilder::new(&package_graph, Some(hakari_package))
    .expect("HakariBuilder was constructed");

// HakariBuilder has a number of config options. For this example, use the defaults.
let hakari = hakari_builder.compute();

// hakari can be used to build a TOML representation that forms part of a Cargo.toml file.
// Existing Cargo.toml files can be managed using Hakari::read_toml.
let toml = hakari.to_toml_string(&HakariOutputOptions::default()).expect("TOML output was constructed");

// toml contains the Cargo.toml [dependencies] that would go in the Hakari package. It can be
// written out through `HakariCargoToml` (returned by Hakari::read_toml) or manually.
println!("Cargo.toml contents:\n{}", toml);

cargo-guppy 仓库使用由 cargo hakari 管理的 workspace-hack crate。 查看生成的 Cargo.toml。

cargo-guppy 仓库还有一些用于演示 Hakari 输出的示例。 这里有一个示例。

如何使用 hakari

Hakari 遵循三个步骤的过程。

1. 配置

HakariBuilder 提供选项来配置如何执行 Hakari 计算。支持的选项包括

• workspace-hack 包的位置
• 在哪些平台上模拟 Cargo 构建
• 要使用的 Cargo 解析器版本
• 在计算期间要排除的包
• 从最终输出中排除的包

使用可选的 cli-support 功能，HakariBuilder 选项可以从文件中读取或写入为 TOML 或其他格式。

2. 计算

一旦配置了 HakariBuilder，可以调用其 compute 方法来创建一个 Hakari 实例。算法分为三个步骤

1. 使用guppy为每个工作空间包和每个指定平台模拟Cargo构建，包括无功能、默认功能和所有功能。将结果收集到一个以每个依赖项及其构建时所用的不同功能集为索引的映射中。
2. 遍历映射，找出哪些依赖项是用两个或更多不同的功能集构建的，并将它们收集到一个输出映射中。
3. 如果假设输出映射将通过以下第3步写入到workspace-hack包中，那么它可能会导致一些额外的包用第二个功能集构建。查找这样的包，将它们添加到输出映射中，并迭代直到达到固定点且没有更多包以多种方式构建。

此计算以并行方式执行，使用Rayon库。

此计算的输出是一个Hakari实例。

3. 序列化

最后一步是将输出映射的内容序列化到workspace-hack包的Cargo.toml文件中。

1. Hakari::read_toml从磁盘上读取现有的Cargo.toml文件。此文件是部分生成的

   [package]
   name = "workspace-hack"
   version = "0.1.0"
   # more options...
   
   ### BEGIN HAKARI SECTION
   ...
   ### END HAKARI SECTION
   

   在BEGIN HAKARI SECTION和END HAKARI SECTION行之外的内容可以手动编辑。该部分的内容是自动生成的。

   成功时，返回一个HakariCargoToml。

2. Hakari::to_toml_string返回自动生成部分的最新内容。

3. HakariCargoToml::write_to_file将内容写入磁盘。