created_at2022-07-14 18:05:49.415845
updated_at2022-07-14 18:05:49.415845
descriptionFind unused enabled feature flags and prune them.
Timon (TimonPost)



Donate Latest Version MIT docs

Unused enabled feature flag pruner.

This cargo tool allows you to find and prune enabled, but, unused feature flags from your project.

There are three subcommands in this library:

Use cargo purge-features --help to fetch more details about available subcommands and their configurations.

How to use

Run cargo install purge-features or download the binary and build it your self.

  1. Step Analyzing enabled unused features.
cargo purge-features analyze --workspace "C:/some_path/to/project" --report "C:/some_path/to/project/report.json"

After it finished running, check the report.json and use this for the next two steps.

  1. Generating a HTML report. (optional)

You can generate a simple HTML report from the json to make it easier to inspect results.

cargo purge-features build-report --input "C:/some_path/to/project/report.json" --output "C:/some_path/to/project/report.html"

You can choose to manually fix your dependencies or use the command in the next step.

  1. Applying suggested removals of feature flags.

It is possible to auto-apply the findings of the first command. But keep in mind the disclaimers.

cargo purge-features purge --input "C:/some_path/to/project/report.json"

How it Works

This library works for both workspaces and individual crates. In the context of a workspace it will just iterate each crate in the workspace-definition and run the same process it does for a single crate.

For a single crate. it removes a feature of a dependency and then compiles the project to see if it still compiles. If so, we can 'believe' that the feature can be removed. Yes, this implies some overhead by recompiling the project for each feature flag enabled. However, this is a one-time thing and if you have a large project, just let it run for a while. But, the compiler will not perform a complete clean rebuild which is in our favor.

Furthermore, This library uses cargo_toml to remove or add features. It loads a TOML file into memory, modifies the dependency features, serializes the Manifest, and writes it back to the toml-file. Then it starts compiling, and after it finishes running, the original content is written back as if nothing had happened.

But before doing all of that, we need to know which features to remove in the first case. This library uses cargo-metadata to collect all enabled features from the dependencies. Features can be enabled in several ways. Manually by features = ['x', 'y'] tag, or by the default-features=false/true tag. Also, features can enable 0-n other features e.g default=[x,y]. So, this library collects all enabled features, whether they are implicitly or explicitly enabled. After it collects all enabled features for a dependency, it will remove them one-by-one and compile the project as described above.

During the process, a json report is updated for each crate to ensure that if it crashes the progress is not lost. Use the cargo prune-features build-report command to visualize this report.

Finally, this library also has the option to apply all suggestions automatically by running cargo prune-features apply command. For this task, toml-edit is used because it doesn't mess with formatting, comments, and spaces, in the TOML-file.

Some things to keep in mind

  • Sometimes feature flags can turn logic on and off without breaking the compilation and therefore this tool can mark a feature flag as removable, but essentially it would change the internal logic of a library. For this reason, this library offers 3 phases. Analyze, automatically apply suggestions, and generate a report. If you want to be more carefully inspect the HTML report to see more clearly what suggestions are given and manually update the dependencies yourself.
  • Given crate A and B, B depends on A and uses logic from a dependency of A that is hidden behind a feature flag enabled in A, but A itself does not use this code. In this scenario, the feature flag can be removed for A but not for B. So this can result in a false positive. I would recommend going through the suggestions on a crate by crate basis, or just running it on the full workspace, and fixing the compilation errors by adding the removed features.
  • Feature flags may depend on the target. This project does not compile for each target, but instead you can specify the target with --target x to the cargo purge-features command.

Report Bug

This tool is very new, and one can expect problems. If you have problems, please open an issue with the problematic Cargo.toml file. That allows me to quickly debug the permutation process.

Commit count: 32

cargo fmt