Add imports_granularity="Item".

This option splits all imports into their own `use` statement.
This commit is contained in:
Michael Morgan 2021-01-12 14:29:11 -05:00 committed by Caleb Cartwright
parent 5e14f760c5
commit 384ba68d64
6 changed files with 81 additions and 9 deletions

View File

@ -1620,7 +1620,7 @@ pub enum Foo {}
How imports should be grouped into `use` statements. Imports will be merged or split to the configured level of granularity.
- **Default value**: `Preserve`
- **Possible values**: `Preserve`, `Crate`, `Module`
- **Possible values**: `Preserve`, `Crate`, `Module`, `Item`
- **Stable**: No
#### `Preserve` (default):
@ -1659,6 +1659,21 @@ use foo::{a, b, c};
use qux::{h, i};
```
#### `Item`:
Flatten imports so that each has its own `use` statement.
```rust
use foo::a;
use foo::b;
use foo::b::f;
use foo::b::g;
use foo::c;
use foo::d::e;
use qux::h;
use qux::i;
```
## `merge_imports`
This option is deprecated. Use `imports_granularity = "Crate"` instead.

View File

@ -121,6 +121,8 @@ pub enum ImportGranularity {
Crate,
/// Use one `use` statement per module.
Module,
/// Use one `use` statement per imported item.
Item,
}
#[config_type]

View File

@ -181,6 +181,24 @@ pub(crate) fn merge_use_trees(use_trees: Vec<UseTree>, merge_by: SharedPrefix) -
result
}
pub(crate) fn flatten_use_trees(use_trees: Vec<UseTree>) -> Vec<UseTree> {
use_trees
.into_iter()
.flat_map(UseTree::flatten)
.map(|mut tree| {
// If a path ends in `::self`, rewrite it to `::{self}`.
if let Some(UseSegment::Slf(..)) = tree.path.last() {
let self_segment = tree.path.pop().unwrap();
tree.path.push(UseSegment::List(vec![UseTree::from_path(
vec![self_segment],
DUMMY_SP,
)]));
}
tree
})
.collect()
}
impl fmt::Debug for UseTree {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Display::fmt(self, f)
@ -1084,6 +1102,25 @@ mod test {
);
}
#[test]
fn test_flatten_use_trees() {
assert_eq!(
flatten_use_trees(parse_use_trees!["foo::{a::{b, c}, d::e}"]),
parse_use_trees!["foo::a::b", "foo::a::c", "foo::d::e"]
);
assert_eq!(
flatten_use_trees(parse_use_trees!["foo::{self, a, b::{c, d}, e::*}"]),
parse_use_trees![
"foo::{self}",
"foo::a",
"foo::b::c",
"foo::b::d",
"foo::e::*"
]
);
}
#[test]
fn test_use_tree_flatten() {
assert_eq!(

View File

@ -12,7 +12,7 @@ use rustc_ast::ast;
use rustc_span::{symbol::sym, Span};
use crate::config::{Config, GroupImportsTactic, ImportGranularity};
use crate::imports::{merge_use_trees, SharedPrefix, UseSegment, UseTree};
use crate::imports::{flatten_use_trees, merge_use_trees, SharedPrefix, UseSegment, UseTree};
use crate::items::{is_mod_decl, rewrite_extern_crate, rewrite_mod};
use crate::lists::{itemize_list, write_list, ListFormatting, ListItem};
use crate::rewrite::RewriteContext;
@ -107,15 +107,14 @@ fn rewrite_reorderable_or_regroupable_items(
for (item, list_item) in normalized_items.iter_mut().zip(list_items) {
item.list_item = Some(list_item.clone());
}
match context.config.imports_granularity() {
ImportGranularity::Crate => {
normalized_items = merge_use_trees(normalized_items, SharedPrefix::Crate)
}
normalized_items = match context.config.imports_granularity() {
ImportGranularity::Crate => merge_use_trees(normalized_items, SharedPrefix::Crate),
ImportGranularity::Module => {
normalized_items = merge_use_trees(normalized_items, SharedPrefix::Module)
merge_use_trees(normalized_items, SharedPrefix::Module)
}
ImportGranularity::Preserve => {}
}
ImportGranularity::Item => flatten_use_trees(normalized_items),
ImportGranularity::Preserve => normalized_items,
};
let mut regrouped_items = match context.config.group_imports() {
GroupImportsTactic::Preserve => vec![normalized_items],

View File

@ -0,0 +1,6 @@
// rustfmt-imports_granularity: Item
use a::{b, c, d};
use a::{f::g, h::{i, j}};
use a::{l::{self, m, n::o, p::*}};
use a::q::{self};

View File

@ -0,0 +1,13 @@
// rustfmt-imports_granularity: Item
use a::b;
use a::c;
use a::d;
use a::f::g;
use a::h::i;
use a::h::j;
use a::l::m;
use a::l::n::o;
use a::l::p::*;
use a::l::{self};
use a::q::{self};