MergeBehavior -> ImportGranularity

This commit is contained in:
Lukas Tobias Wirth 2021-05-18 19:49:15 +02:00
parent e3d0d89d7e
commit 64f7072c25
8 changed files with 75 additions and 38 deletions

View file

@ -15,9 +15,32 @@ use crate::{
pub use hir::PrefixKind;
/// How imports should be grouped into use statements.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum ImportGranularity {
/// Do not change the granularity of any imports and preserve the original structure written by the developer.
Preserve,
/// Merge imports from the same crate into a single use statement.
Crate,
/// Merge imports from the same module into a single use statement.
Module,
/// Flatten imports so that each has its own use statement.
Item,
}
impl ImportGranularity {
pub fn merge_behavior(self) -> Option<MergeBehavior> {
match self {
ImportGranularity::Crate => Some(MergeBehavior::Crate),
ImportGranularity::Module => Some(MergeBehavior::Module),
ImportGranularity::Preserve | ImportGranularity::Item => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct InsertUseConfig {
pub merge: Option<MergeBehavior>,
pub granularity: ImportGranularity,
pub prefix_kind: PrefixKind,
pub group: bool,
}
@ -73,7 +96,7 @@ pub fn insert_use<'a>(scope: &ImportScope, path: ast::Path, cfg: InsertUseConfig
let use_item =
make::use_(None, make::use_tree(path.clone(), None, None, false)).clone_for_update();
// merge into existing imports if possible
if let Some(mb) = cfg.merge {
if let Some(mb) = cfg.granularity.merge_behavior() {
for existing_use in scope.as_syntax_node().children().filter_map(ast::Use::cast) {
if let Some(merged) = try_merge_imports(&existing_use, &use_item, mb) {
ted::replace(existing_use.syntax(), merged.syntax());

View file

@ -21,7 +21,7 @@ use crate::bar::A;
use self::bar::A;
use super::bar::A;
use external_crate2::bar::A;",
None,
ImportGranularity::Item,
false,
false,
);
@ -36,7 +36,7 @@ fn insert_not_group_empty() {
r"use external_crate2::bar::A;
",
None,
ImportGranularity::Item,
false,
false,
);
@ -281,7 +281,7 @@ fn insert_empty_module() {
r"{
use foo::bar;
}",
None,
ImportGranularity::Item,
true,
true,
)
@ -635,7 +635,7 @@ fn check(
path: &str,
ra_fixture_before: &str,
ra_fixture_after: &str,
mb: Option<MergeBehavior>,
granularity: ImportGranularity,
module: bool,
group: bool,
) {
@ -651,21 +651,21 @@ fn check(
.find_map(ast::Path::cast)
.unwrap();
insert_use(&file, path, InsertUseConfig { merge: mb, prefix_kind: PrefixKind::Plain, group });
insert_use(&file, path, InsertUseConfig { granularity, prefix_kind: PrefixKind::Plain, group });
let result = file.as_syntax_node().to_string();
assert_eq_text!(ra_fixture_after, &result);
}
fn check_crate(path: &str, ra_fixture_before: &str, ra_fixture_after: &str) {
check(path, ra_fixture_before, ra_fixture_after, Some(MergeBehavior::Crate), false, true)
check(path, ra_fixture_before, ra_fixture_after, ImportGranularity::Crate, false, true)
}
fn check_module(path: &str, ra_fixture_before: &str, ra_fixture_after: &str) {
check(path, ra_fixture_before, ra_fixture_after, Some(MergeBehavior::Module), false, true)
check(path, ra_fixture_before, ra_fixture_after, ImportGranularity::Module, false, true)
}
fn check_none(path: &str, ra_fixture_before: &str, ra_fixture_after: &str) {
check(path, ra_fixture_before, ra_fixture_after, None, false, true)
check(path, ra_fixture_before, ra_fixture_after, ImportGranularity::Item, false, true)
}
fn check_merge_only_fail(ra_fixture0: &str, ra_fixture1: &str, mb: MergeBehavior) {