Static analysis tool that detects external types used in a Rust library's public API. Configuration can be provided to allow certain external types so that this tool can be used in continuous integration so that types don't unintentionally make it into the library's API. It can also output a Markdown table of the external types it found.
The test suite has a Rust library that relies on some external types. When the tool is run against this library without any configuration, it emits errors for each occurrence of an external type in the public API.
When a config file is provided, the allowed external types no longer show up in the output.
When the output format is set to markdown-table
, then
a table of external types is output.
Important: This tool requires a nightly build of Rust to be installed.
To install, run the following from this README path:
bash
cargo install --path .
Then, in your library crate path, run:
cargo check-external-types