Explore and summarise Rust projects

Having trouble seeing the forest for the trees? forest analyses Rust projects to summarise variable mutability and data structure usage. It provides insights about where variables and data structures are declared, used, and what their types are.

Multiple output formats are supported, however the JSON output is the most convenient to work with as it can be easily manipulated with a tool like jq or nushell, for example:

openout.json|getmutable_variables|table--expand

Installation

cargo install forest

Usage

See HELP

Use the --link option to include VSCode-compatable file paths in the output, which can be used to navigate directly to the associated code from terminals which support it.

Example output

See out.json

Note that the --link option was not used in this example to avoid revealing private file paths.

Update changes

see CHANGELOG

Contributing

see CONTRIBUTING

License

MIT