Code Formatting - Twiggy🌱 (original) (raw)

1. Introduction
2. 1. 📦 Install
3. 2. 💡 Concepts
4. 1. 2.1. Call Graph
   2. 2.2. Paths
   3. 2.3. Dominators and Retained Size
   4. 2.4. Generic Functions and Monomorphization
5. 3. 🏋️‍♀️ Usage
6. 1. 3.1. ⌨ Command Line Interface
   2. 1. 3.1.1. twiggy top
         1. 3.1.2. twiggy paths
         2. 3.1.3. twiggy monos
         3. 3.1.4. twiggy dominators
         4. 3.1.5. twiggy diff
         5. 3.1.6. twiggy garbage
   3. 3.2. 🦀 As a Crate
   4. 3.3. 🕸 On the Web with WebAssembly
7. 4. 🔎 Supported Binary Formats
8. 5. 🙌 Contributing to Twiggy
9. 1. 5.1. Building
   2. 5.2. Testing
   3. 5.3. Code Formatting
   4. 5.4. Pull Requests
   5. 5.5. Team

Twiggy🌱

Code Formatting

We use rustfmt to enforce a consistent code style across the whole code base.

You can install the latest version of rustfmt with this command:

$ rustup update
$ rustup component add rustfmt --toolchain stable

Ensure that ~/.rustup/toolchains/$YOUR_HOST_TARGET/bin/ is on your $PATH.

Once that is taken care of, you can (re)format all code by running this command from the root of the repository:

$ cargo fmt --all

Linting

We use clippy to lint the codebase. This helps avoid common mistakes, and ensures that code is correct, performant, and idiomatic.

You can install the latest version of clippy with this command:

$ rustup update
$ rustup component add clippy --toolchain stable

Once that is complete, you can lint your code to check for mistakes by running this command from the root of the repository:

$ cargo clippy