A Rust lint to help with the sorting of uses, mods & crate declarations [OUTDATED]
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
.travis.yml
Cargo.toml
EXAMPLE.md
LICENSE.md
README.md

README.md

rust-sorty

Build Status Current Version

A lint to help with sorting the extern crate, mod and use declarations, according to the style rules. Have a look at the detailed example for a start! I guess it will be very handy for large projects written in Rust (well, at least once!).

And yeah, this should actually be done by rustfmt, but it doesn't have this option for now. So, this plugin would serve until rustfmt becomes intelligent enough to detect the unsorted declarations.

Usage

Add this to your Cargo.toml...

sorty = "0.1"

... and then to the top of the main module you wanna check,

#![feature(plugin)]
#![plugin(sorty)]

(It can show warnings or errors based on your choice, just like any other lint)

#![deny(unsorted_declarations)]         // throw errors! (poor choice for styling lints)

#![warn(unsorted_declarations)]         // show warnings (default)

#![allow(unsorted_declarations)]        // stay quiet!

Remove it once you've done all the checks, when you'll no longer be needing the plugin!

I was just kidding. I'll be very happy if you just keep it :)

Note:

This is a compiler lint, and it's unstable. So, make sure you're using the latest nightly Rust. Though this lint shows an output of the lexicographically sorted declarations, it follows some rules:

  • stuff with #[macro_use] are sorted and moved to the top, since macros become visible to the surroundings only after their declaration, unlike others.
  • pub declarations (of uses & mods) are sorted and moved to the bottom
  • self in use lists are moved to the left (other list items are sorted as usual)

Also, note that there are some stuff that aren't tracked (for now). It includes comments, spaces, etc.