squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Merge pull request #2605 from nrc/import-squelch

Browse source 
Coalesce some of the import options
This commit is contained in:
Nick Cameron 2018-04-11 10:57:16 +12:00 committed by GitHub
commit 1cab171bc3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 46 additions and 294 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

120
Configurations.md
View file

@ -6,7 +6,7 @@ A possible content of `rustfmt.toml` or `.rustfmt.toml` might look like this:
```toml
indent_style = "Block"
reorder_imported_names = true
reorder_imports = false
```
Each configuration option is either stable or unstable.
@ -1240,33 +1240,13 @@ fn dolor() -> usize {}
fn adipiscing() -> usize {}
```
## `reorder_imported_names`
Reorder lists of names in import statements alphabetically
- **Default value**: `false`
- **Possible values**: `true`, `false`
- **Stable**: No
#### `false` (default):
```rust
use super::{lorem, ipsum, dolor, sit};
```
#### `true`:
```rust
use super::{dolor, ipsum, lorem, sit};
```
See also [`reorder_imports`](#reorder_imports).
## `reorder_imports`
Reorder import statements alphabetically
Reorder import and extern crate statements alphabetically in groups (a group is
separated by a newline).
- **Default value**: `false`
- **Default value**: `true`
- **Possible values**: `true`, `false`
- **Stable**: No
@ -1288,98 +1268,6 @@ use lorem;
use sit;
```
See also [`reorder_imported_names`](#reorder_imported_names), [`reorder_imports_in_group`](#reorder_imports_in_group).
## `reorder_imports_in_group`
Reorder import statements in group
- **Default value**: `false`
- **Possible values**: `true`, `false`
- **Stable**: No
**Note:** This option takes effect only when [`reorder_imports`](#reorder_imports) is set to `true`.
#### `true` (default):
```rust
use std::io;
use std::mem;
use dolor;
use ipsum;
use lorem;
use sit;
```
#### `false`:
```rust
use dolor;
use ipsum;
use lorem;
use sit;
use std::io;
use std::mem;
```
See also [`reorder_imports`](#reorder_imports).
## `reorder_extern_crates`
Reorder `extern crate` statements alphabetically
- **Default value**: `true`
- **Possible values**: `true`, `false`
- **Stable**: No
#### `true` (default):
```rust
extern crate dolor;
extern crate ipsum;
extern crate lorem;
extern crate sit;
```
#### `false`:
```rust
extern crate lorem;
extern crate ipsum;
extern crate dolor;
extern crate sit;
```
See also [`reorder_extern_crates_in_group`](#reorder_extern_crates_in_group).
## `reorder_extern_crates_in_group`
Reorder `extern crate` statements in group
- **Default value**: `true`
- **Possible values**: `true`, `false`
- **Stable**: No
#### `false` (default):
This value has no influence beyond the effect of the [`reorder_extern_crates`](#reorder_extern_crates) option. Set [`reorder_extern_crates`](#reorder_extern_crates) to `false` if you do not want `extern crate` groups to be collapsed and ordered.
#### `true`:
**Note:** This only takes effect when [`reorder_extern_crates`](#reorder_extern_crates) is set to `true`.
```rust
extern crate a;
extern crate b;
extern crate dolor;
extern crate ipsum;
extern crate lorem;
extern crate sit;
```
## `reorder_modules`

9
src/config/mod.rs
View file

@ -68,13 +68,8 @@ create_config! {
imports_layout: ListTactic, ListTactic::Mixed, false, "Item layout inside a import block";
// Ordering
reorder_extern_crates: bool, true, false, "Reorder extern crate statements alphabetically";
reorder_extern_crates_in_group: bool, true, false, "Reorder extern crate statements in group";
reorder_imports: bool, true, false, "Reorder import statements alphabetically";
reorder_imports_in_group: bool, true, false, "Reorder import statements in group";
reorder_imported_names: bool, true, false,
"Reorder lists of names in import statements alphabetically";
reorder_modules: bool, true, false, "Reorder module statemtents alphabetically in group";
reorder_imports: bool, true, false, "Reorder import and extern crate statements alphabetically";
reorder_modules: bool, true, false, "Reorder module statements alphabetically in group";
reorder_impl_items: bool, false, false, "Reorder impl items";
// Spaces around punctuation

80
src/imports.rs
View file

@ -185,7 +185,7 @@ impl UseTree {
} else {
Some(item.attrs.clone())
},
).normalize(context.config.reorder_imported_names()),
).normalize(),
),
_ => None,
}
@ -271,7 +271,7 @@ impl UseTree {
}
// Do the adjustments that rustfmt does elsewhere to use paths.
pub fn normalize(mut self, do_sort: bool) -> UseTree {
pub fn normalize(mut self) -> UseTree {
let mut last = self.path.pop().expect("Empty use tree?");
// Hack around borrow checker.
let mut normalize_sole_list = false;
@ -340,7 +340,7 @@ impl UseTree {
for seg in &list[0].path {
self.path.push(seg.clone());
}
return self.normalize(do_sort);
return self.normalize();
}
_ => unreachable!(),
}
@ -349,11 +349,9 @@ impl UseTree {
// Recursively normalize elements of a list use (including sorting the list).
if let UseSegment::List(list) = last {
let mut list = list.into_iter()
.map(|ut| ut.normalize(do_sort))
.map(|ut| ut.normalize())
.collect::<Vec<_>>();
if do_sort {
list.sort();
}
list.sort();
last = UseSegment::List(list);
}
@ -485,6 +483,7 @@ fn rewrite_nested_use_tree(
);
(tactic, remaining_width)
};
let ends_with_newline = context.config.imports_indent() == IndentStyle::Block
&& tactic != DefinitiveListTactic::Horizontal;
let fmt = ListFormatting {
@ -685,75 +684,64 @@ mod test {
#[test]
fn test_use_tree_normalize() {
assert_eq!(parse_use_tree("a::self").normalize(), parse_use_tree("a"));
assert_eq!(
parse_use_tree("a::self").normalize(true),
parse_use_tree("a")
);
assert_eq!(
parse_use_tree("a::self as foo").normalize(true),
parse_use_tree("a::self as foo").normalize(),
parse_use_tree("a as foo")
);
assert_eq!(parse_use_tree("a::{self}").normalize(), parse_use_tree("a"));
assert_eq!(parse_use_tree("a::{b}").normalize(), parse_use_tree("a::b"));
assert_eq!(
parse_use_tree("a::{self}").normalize(true),
parse_use_tree("a")
);
assert_eq!(
parse_use_tree("a::{b}").normalize(true),
parse_use_tree("a::b")
);
assert_eq!(
parse_use_tree("a::{b, c::self}").normalize(true),
parse_use_tree("a::{b, c::self}").normalize(),
parse_use_tree("a::{b, c}")
);
assert_eq!(
parse_use_tree("a::{b as bar, c::self}").normalize(true),
parse_use_tree("a::{b as bar, c::self}").normalize(),
parse_use_tree("a::{b as bar, c}")
);
}
#[test]
fn test_use_tree_ord() {
assert!(parse_use_tree("a").normalize(true) < parse_use_tree("aa").normalize(true));
assert!(parse_use_tree("a").normalize(true) < parse_use_tree("a::a").normalize(true));
assert!(parse_use_tree("a").normalize(true) < parse_use_tree("*").normalize(true));
assert!(parse_use_tree("a").normalize(true) < parse_use_tree("{a, b}").normalize(true));
assert!(parse_use_tree("*").normalize(true) < parse_use_tree("{a, b}").normalize(true));
assert!(parse_use_tree("a").normalize() < parse_use_tree("aa").normalize());
assert!(parse_use_tree("a").normalize() < parse_use_tree("a::a").normalize());
assert!(parse_use_tree("a").normalize() < parse_use_tree("*").normalize());
assert!(parse_use_tree("a").normalize() < parse_use_tree("{a, b}").normalize());
assert!(parse_use_tree("*").normalize() < parse_use_tree("{a, b}").normalize());
assert!(
parse_use_tree("aaaaaaaaaaaaaaa::{bb, cc, dddddddd}").normalize(true)
< parse_use_tree("aaaaaaaaaaaaaaa::{bb, cc, ddddddddd}").normalize(true)
parse_use_tree("aaaaaaaaaaaaaaa::{bb, cc, dddddddd}").normalize()
< parse_use_tree("aaaaaaaaaaaaaaa::{bb, cc, ddddddddd}").normalize()
);
assert!(
parse_use_tree("serde::de::{Deserialize}").normalize(true)
< parse_use_tree("serde_json").normalize(true)
parse_use_tree("serde::de::{Deserialize}").normalize()
< parse_use_tree("serde_json").normalize()
);
assert!(parse_use_tree("a::b::c").normalize() < parse_use_tree("a::b::*").normalize());
assert!(
parse_use_tree("a::b::c").normalize(true) < parse_use_tree("a::b::*").normalize(true)
);
assert!(
parse_use_tree("foo::{Bar, Baz}").normalize(true)
< parse_use_tree("{Bar, Baz}").normalize(true)
parse_use_tree("foo::{Bar, Baz}").normalize()
< parse_use_tree("{Bar, Baz}").normalize()
);
assert!(
parse_use_tree("foo::{self as bar}").normalize(true)
< parse_use_tree("foo::{qux as bar}").normalize(true)
parse_use_tree("foo::{self as bar}").normalize()
< parse_use_tree("foo::{qux as bar}").normalize()
);
assert!(
parse_use_tree("foo::{qux as bar}").normalize(true)
< parse_use_tree("foo::{baz, qux as bar}").normalize(true)
parse_use_tree("foo::{qux as bar}").normalize()
< parse_use_tree("foo::{baz, qux as bar}").normalize()
);
assert!(
parse_use_tree("foo::{self as bar, baz}").normalize(true)
< parse_use_tree("foo::{baz, qux as bar}").normalize(true)
parse_use_tree("foo::{self as bar, baz}").normalize()
< parse_use_tree("foo::{baz, qux as bar}").normalize()
);
assert!(parse_use_tree("foo").normalize(true) < parse_use_tree("Foo").normalize(true));
assert!(parse_use_tree("foo").normalize(true) < parse_use_tree("foo::Bar").normalize(true));
assert!(parse_use_tree("foo").normalize() < parse_use_tree("Foo").normalize());
assert!(parse_use_tree("foo").normalize() < parse_use_tree("foo::Bar").normalize());
assert!(
parse_use_tree("std::cmp::{d, c, b, a}").normalize(true)
< parse_use_tree("std::cmp::{b, e, g, f}").normalize(true)
parse_use_tree("std::cmp::{d, c, b, a}").normalize()
< parse_use_tree("std::cmp::{b, e, g, f}").normalize()
);
}
}

12
src/reorder.rs
View file

@ -198,18 +198,18 @@ impl ReorderableItemKind {
pub fn is_reorderable(&self, config: &Config) -> bool {
match *self {
ReorderableItemKind::ExternCrate => config.reorder_extern_crates(),
ReorderableItemKind::ExternCrate => config.reorder_imports(),
ReorderableItemKind::Mod => config.reorder_modules(),
ReorderableItemKind::Use => config.reorder_imports(),
ReorderableItemKind::Other => false,
}
}
pub fn in_group(&self, config: &Config) -> bool {
pub fn in_group(&self) -> bool {
match *self {
ReorderableItemKind::ExternCrate => config.reorder_extern_crates_in_group(),
ReorderableItemKind::Mod => config.reorder_modules(),
ReorderableItemKind::Use => config.reorder_imports_in_group(),
ReorderableItemKind::ExternCrate
| ReorderableItemKind::Mod
| ReorderableItemKind::Use => true,
ReorderableItemKind::Other => false,
}
}
@ -268,7 +268,7 @@ impl<'b, 'a: 'b> FmtVisitor<'a> {
let item_kind = ReorderableItemKind::from(items[0]);
if item_kind.is_reorderable(self.config) {
let visited_items_num =
self.walk_reorderable_items(items, item_kind, item_kind.in_group(self.config));
self.walk_reorderable_items(items, item_kind, item_kind.in_group());
let (_, rest) = items.split_at(visited_items_num);
items = rest;
} else {

11
tests/source/configs/reorder_extern_crates/false.rs
View file

@ -1,11 +0,0 @@
// rustfmt-reorder_extern_crates: false
extern crate foo;
extern crate bar;
extern crate foobar;
#[macro_use]
extern crate nom;
extern crate regex;
#[macro_use]
extern crate log;

11
tests/source/configs/reorder_extern_crates/true.rs
View file

@ -1,11 +0,0 @@
// rustfmt-reorder_extern_crates: true
extern crate foo;
extern crate bar;
extern crate foobar;
#[macro_use]
extern crate nom;
extern crate regex;
#[macro_use]
extern crate log;

4
tests/source/configs/reorder_imported_names/false.rs
View file

@ -1,4 +0,0 @@
// rustfmt-reorder_imported_names: false
// Reorder imported names
use super::{lorem, ipsum, dolor, sit};

4
tests/source/configs/reorder_imported_names/true.rs
View file

@ -1,4 +0,0 @@
// rustfmt-reorder_imported_names: true
// Reorder imported names
use super::{lorem, ipsum, dolor, sit};

13
tests/source/configs/reorder_imports_in_group/false.rs
View file

@ -1,13 +0,0 @@
// rustfmt-reorder_imports: true
// rustfmt-reorder_imports_in_group: false
// Reorder imports in group
/// This comment should stay with `use std::mem;`
use std::mem;
use std::io;
use lorem;
/// This comment should stay with `use ipsum;`
use ipsum;
use dolor;
use sit;

13
tests/source/configs/reorder_imports_in_group/true.rs
View file

@ -1,13 +0,0 @@
// rustfmt-reorder_imports: true
// rustfmt-reorder_imports_in_group: true
// Reorder imports in group
/// This comment should stay with `use std::mem;`
use std::mem;
use std::io;
use lorem;
/// This comment should stay with `use ipsum;`
use ipsum;
use dolor;
use sit;

3
tests/source/imports-reorder-lines-and-items.rs
View file

@ -1,6 +1,3 @@
// rustfmt-reorder_imports: true
// rustfmt-reorder_imported_names: true
/// This comment should stay with `use std::str;`
use std::str;
use std::cmp::{d, c, b, a};

1
tests/source/imports-reorder.rs
View file

@ -1,5 +1,4 @@
// rustfmt-normalize_comments: true
// rustfmt-reorder_imported_names: true
use path::{C,/*A*/ A, B /* B */, self /* self */};

11
tests/target/configs/reorder_extern_crates/false.rs
View file

@ -1,11 +0,0 @@
// rustfmt-reorder_extern_crates: false
extern crate foo;
extern crate bar;
extern crate foobar;
#[macro_use]
extern crate nom;
extern crate regex;
#[macro_use]
extern crate log;

11
tests/target/configs/reorder_extern_crates/true.rs
View file

@ -1,11 +0,0 @@
// rustfmt-reorder_extern_crates: true
extern crate bar;
extern crate foo;
extern crate foobar;
#[macro_use]
extern crate nom;
extern crate regex;
#[macro_use]
extern crate log;

4
tests/target/configs/reorder_imported_names/false.rs
View file

@ -1,4 +0,0 @@
// rustfmt-reorder_imported_names: false
// Reorder imported names
use super::{lorem, ipsum, dolor, sit};

4
tests/target/configs/reorder_imported_names/true.rs
View file

@ -1,4 +0,0 @@
// rustfmt-reorder_imported_names: true
// Reorder imported names
use super::{dolor, ipsum, lorem, sit};

12
tests/target/configs/reorder_imports_in_group/false.rs
View file

@ -1,12 +0,0 @@
// rustfmt-reorder_imports: true
// rustfmt-reorder_imports_in_group: false
// Reorder imports in group
use dolor;
/// This comment should stay with `use ipsum;`
use ipsum;
use lorem;
use sit;
use std::io;
/// This comment should stay with `use std::mem;`
use std::mem;

13
tests/target/configs/reorder_imports_in_group/true.rs
View file

@ -1,13 +0,0 @@
// rustfmt-reorder_imports: true
// rustfmt-reorder_imports_in_group: true
// Reorder imports in group
use std::io;
/// This comment should stay with `use std::mem;`
use std::mem;
use dolor;
/// This comment should stay with `use ipsum;`
use ipsum;
use lorem;
use sit;

3
tests/target/imports-reorder-lines-and-items.rs
View file

@ -1,6 +1,3 @@
// rustfmt-reorder_imports: true
// rustfmt-reorder_imported_names: true
use std::cmp::{a, b, c, d};
use std::ddd::aaa;
use std::ddd::{a, b, c as g, d as p};

1
tests/target/imports-reorder.rs
View file

@ -1,5 +1,4 @@
// rustfmt-normalize_comments: true
// rustfmt-reorder_imported_names: true
use path::{self /* self */, /* A */ A, B /* B */, C};