Enum cargo_hackerman::opts::Action

pub enum Action {
    Hack {
        profile: Profile,
        dry: bool,
        lock: bool,
        no_dev: bool,
    },
    Restore {
        profile: Profile,
        separate: Vec<PathBuf>,
    },
    Check {
        profile: Profile,
        no_dev: bool,
    },
    MergeDriver {
        base: PathBuf,
        local: PathBuf,
        remote: PathBuf,
        result: PathBuf,
    },
    Explain {
        profile: Profile,
        no_transitive_opt: bool,
        package_nodes: bool,
        stdout: bool,
        krate: String,
        feature: Option<String>,
        version: Option<Version>,
    },
    Dupes {
        profile: Profile,
    },
    Tree {
        profile: Profile,
        no_transitive_opt: bool,
        no_dev: bool,
        package_nodes: bool,
        workspace: bool,
        stdout: bool,
        krate: Option<String>,
        feature: Option<String>,
        version: Option<Version>,
    },
    ShowCrate {
        profile: Profile,
        focus: Focus,
        krate: String,
        version: Option<Version>,
    },
}

A collection of tools that help your workspace to compile fast

Variants

Hack

Fields

profile: Profile

dry: bool

Don’t perform action, only display it

lock: bool

Include dependencies checksum into stash

This helps to ensure you can go back to original (unhacked) dependencies: to be able to restore the original dependencies hackerman needs to have them stashed in Cargo.toml file. If CI detects checksum mismatch this means dependencies were updated on hacked sources. You should instead restore them, update and hack again.

You can make locking the default behavior by adding this to Cargo.toml in the workspace

[workspace.metadata.hackerman]
lock = true

no_dev: bool

Don’t unify dev dependencies

Unify crate dependencies across individual crates in the workspace

You can undo those changes using cargo hackerman restore.

cargo-hackerman hack calculates and adds a minimal set of extra dependencies to all the workspace members such that features of all the dependencies of this crate stay the same when it is used as part of the whole workspace or by itself.

Once dependencies are hacked you should restore them before making any changes.

Restore

Fields

profile: Profile

separate: Vec<PathBuf>

Restore individual files instead of the whole workspace

Remove crate dependency unification added by the hack command

Check

Fields

profile: Profile

no_dev: bool

Don’t unify dev dependencies

Check if unification is required and if checksums are correct

Similar to cargo-hackerman hack --dry, but also sets exit status to 1 so you can use it as part of CI process

MergeDriver

Fields

base: PathBuf

local: PathBuf

remote: PathBuf

result: PathBuf

Restore files and merge with the default merge driver

To use it you would add something like this to ~/.gitconfig or .git/config

[merge "hackerman"]
name = merge restored files with hackerman
driver = cargo hackerman merge %O %A %B %P

And something like this to .git/gitattributes

Cargo.toml merge=hackerman

Explain

Fields

profile: Profile

no_transitive_opt: bool

Don’t strip redundant links

package_nodes: bool

Use package nodes instead of feature nodes

stdout: bool

Print dot file to stdout instead of spawning xdot

krate: String

feature: Option<String>

version: Option<Version>

Explain why some dependency is present. Both feature and version are optional

With large amount of dependencies it might be difficult to tell why exactly some sub-sub-sub dependency is included. hackerman explain solves this problem by tracing the dependency chain from the target and to the workspace.

explain starts at a given crate/feature and follows reverse dependency links until it reaches all the crossing points with the workspace but without entering the workspace itself.

White nodes represent workspace members, round nodes represent features, octagonal nodes represent base crates. Dotted line represents dev-only dependency, dashed line - both dev and normal but with different features across them. Target is usually highlighted. By default hackerman expands packages info feature nodes which can be reverted with -P and tries to reduce transitive dependencies to keep the tree more readable - this can be reverted with -T.

If a crate is present in several versions you can specify version of the one you are interested in but it’s optional.

You can also specify which feature to look for, otherwise hackerman will be looking for all of them.

Dupes

Fields

profile: Profile

Lists all the duplicates in the workspace

Tree

Fields

profile: Profile

no_transitive_opt: bool

Don’t strip redundant links

no_dev: bool

Don’t include dev dependencies

package_nodes: bool

Use package nodes instead of feature nodes

workspace: bool

Keep within the workspace

stdout: bool

Print dot file to stdout instead of spawning xdot

krate: Option<String>

feature: Option<String>

version: Option<Version>

Make a tree out of dependencies

Examples:

cargo hackerman tree rand 0.8.4
cargo hackerman tree serde_json preserve_order

ShowCrate

Fields

profile: Profile

focus: Focus

krate: String

version: Option<Version>

Show crate manifest, readme, repository or documentation

Examples:

cargo hackerman show --repository syn

Trait Implementations

impl Clone for Action

fn clone(&self) -> Action

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Action

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.