cargo-modules 0,0

A cargo plugin for showing a tree-like overview of a crate's modules.

cargo-modules

Build Status Downloads Version License

Synopsis

A cargo plugin for showing a tree-like overview of a crate’s modules.

Motivation

With time, as your Rust projects grow bigger and bigger, it gets more and more important to properly structure your code. Fortunately Rust provides us with a quite sophisticated module system, allowing us to neatly split up our crates into arbitrarily small sub-modules of types and functions. While this helps to avoid monolithic and unstructured chunks of code, it can also make it hard at times to still mentally stay on top of the over-all high-level structure of the project at hand.

This is where cargo-modules comes into play:

preview

Installation

Install cargo-modules via:

cargo install cargo-modules

Usage

cargo modules

Orphaned Modules

If you want to also list of potentially orphaned modules, then add a --orphans argument:

cargo modules --orphans

Any file src/../foo.rs or src/../foo/mod.rs that is not linked by its super-module via mod foo; is considered a (potential) orphaned module.

To keep false positives to a minimum cargo-modules excludes all build scripts as well as lib.rs and main.rs from the selection of potential orphans.

Plain Mode

If you, for some reason, need to remove the coloring, use:

cargo modules --plain

Help

If you need any further help:

cargo modules --help

Contributing

Please read CONTRIBUTING.md for details on our code of conduct,
and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MPL-2.0 – see the LICENSE.md file for details.

Related Repositories

cargo-modules

cargo-modules

A cargo plugin for showing a tree-like overview of a crate's modules. ...

cargo-mod

cargo-mod

A cargo sub command for generating modules. ...


Top Contributors

regexident dtolnay andrey-gvrd llogiq