Skip to content

Commit 50d36bb

Browse files
goffriedavidBar-On
authored andcommitted
Rename to imports_granularity
1 parent dc03bc7 commit 50d36bb

16 files changed

+48
-47
lines changed

Configurations.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1705,7 +1705,7 @@ pub enum Foo {}
17051705
pub enum Foo {}
17061706
```
17071707

1708-
## `imports_merge_style`
1708+
## `imports_granularity`
17091709

17101710
Merge together related imports based on their paths.
17111711

@@ -1751,7 +1751,7 @@ use qux::{h, i};
17511751

17521752
## `merge_imports`
17531753

1754-
This option is deprecated. Use `imports_merge_style = "Crate"` instead.
1754+
This option is deprecated. Use `imports_granularity = "Crate"` instead.
17551755

17561756
- **Default value**: `false`
17571757
- **Possible values**: `true`, `false`
@@ -2602,7 +2602,7 @@ Enable unstable features on stable and beta channels (unstable features are avai
26022602

26032603
For example:
26042604
```bash
2605-
rustfmt src/lib.rs --config unstable_features=true imports_merge_style=Crate
2605+
rustfmt src/lib.rs --config unstable_features=true imports_granularity=Crate
26062606
```
26072607

26082608
## `use_field_init_shorthand`

src/config.rs

+23-22
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,11 @@ create_config! {
7777
// Imports
7878
imports_indent: IndentStyle, IndentStyle::Block, false, "Indent of imports";
7979
imports_layout: ListTactic, ListTactic::Mixed, false, "Item layout inside a import block";
80-
imports_merge_style: ImportMergeStyle, ImportMergeStyle::Preserve, false, "Merge imports";
80+
imports_granularity: ImportGranularity, ImportGranularity::Preserve, false,
81+
"Merge or split imports to the provided granularity";
8182
group_imports: GroupImportsTactic, GroupImportsTactic::Preserve, false,
8283
"Controls the strategy for how imports are grouped together";
83-
merge_imports: bool, false, false, "(deprecated: use imports_merge_style instead)";
84+
merge_imports: bool, false, false, "(deprecated: use imports_granularity instead)";
8485

8586
// Ordering
8687
reorder_imports: bool, true, true, "Reorder import and extern crate statements alphabetically";
@@ -447,9 +448,9 @@ mod test {
447448
single_line_if_else_max_width: usize, 50, true, "Maximum line length for single \
448449
line if-else expressions. A value of zero means always break if-else expressions.";
449450
// merge_imports deprecation
450-
imports_merge_style: ImportMergeStyle, ImportMergeStyle::Preserve, false,
451+
imports_granularity: ImportGranularity, ImportGranularity::Preserve, false,
451452
"Merge imports";
452-
merge_imports: bool, false, false, "(deprecated: use imports_merge_style instead)";
453+
merge_imports: bool, false, false, "(deprecated: use imports_granularity instead)";
453454

454455
unstable_features: bool, false, true,
455456
"Enables unstable features on stable and beta channels \
@@ -601,7 +602,7 @@ fn_single_line = false
601602
where_single_line = false
602603
imports_indent = "Block"
603604
imports_layout = "Mixed"
604-
imports_merge_style = "Preserve"
605+
imports_granularity = "Preserve"
605606
group_imports = "Preserve"
606607
reorder_imports = true
607608
reorder_modules = true
@@ -722,13 +723,13 @@ ignore = []
722723
}
723724
let toml = r#"
724725
unstable_features = true
725-
imports_merge_style = "Crate"
726+
imports_granularity = "Crate"
726727
"#;
727728
let config = Config::from_toml(toml, Path::new("")).unwrap();
728729
assert_eq!(config.was_set().unstable_features(), true);
729-
assert_eq!(config.was_set().imports_merge_style(), true);
730+
assert_eq!(config.was_set().imports_granularity(), true);
730731
assert_eq!(config.unstable_features(), true);
731-
assert_eq!(config.imports_merge_style(), ImportMergeStyle::Crate);
732+
assert_eq!(config.imports_granularity(), ImportGranularity::Crate);
732733
}
733734

734735
#[test]
@@ -738,9 +739,9 @@ ignore = []
738739
return;
739740
}
740741
let config =
741-
Config::from_toml("imports_merge_style = \"Crate\"", Path::new("")).unwrap();
742-
assert_eq!(config.was_set().imports_merge_style(), false);
743-
assert_eq!(config.imports_merge_style(), ImportMergeStyle::Preserve);
742+
Config::from_toml("imports_granularity = \"Crate\"", Path::new("")).unwrap();
743+
assert_eq!(config.was_set().imports_granularity(), false);
744+
assert_eq!(config.imports_granularity(), ImportGranularity::Preserve);
744745
}
745746

746747
#[test]
@@ -785,12 +786,12 @@ ignore = []
785786
}
786787
let mut config = Config::default();
787788
assert_eq!(config.unstable_features(), false);
788-
config.override_value("imports_merge_style", "Crate");
789-
assert_eq!(config.imports_merge_style(), ImportMergeStyle::Preserve);
789+
config.override_value("imports_granularity", "Crate");
790+
assert_eq!(config.imports_granularity(), ImportGranularity::Preserve);
790791
config.override_value("unstable_features", "true");
791792
assert_eq!(config.unstable_features(), true);
792-
config.override_value("imports_merge_style", "Crate");
793-
assert_eq!(config.imports_merge_style(), ImportMergeStyle::Crate);
793+
config.override_value("imports_granularity", "Crate");
794+
assert_eq!(config.imports_granularity(), ImportGranularity::Crate);
794795
}
795796

796797
#[test]
@@ -1055,18 +1056,18 @@ ignore = []
10551056
merge_imports = true
10561057
"#;
10571058
let config = Config::from_toml(toml, Path::new("")).unwrap();
1058-
assert_eq!(config.imports_merge_style(), ImportMergeStyle::Crate);
1059+
assert_eq!(config.imports_granularity(), ImportGranularity::Crate);
10591060
}
10601061

10611062
#[test]
10621063
fn test_both_set() {
10631064
let toml = r#"
10641065
unstable_features = true
10651066
merge_imports = true
1066-
imports_merge_style = "Preserve"
1067+
imports_granularity = "Preserve"
10671068
"#;
10681069
let config = Config::from_toml(toml, Path::new("")).unwrap();
1069-
assert_eq!(config.imports_merge_style(), ImportMergeStyle::Preserve);
1070+
assert_eq!(config.imports_granularity(), ImportGranularity::Preserve);
10701071
}
10711072

10721073
#[test]
@@ -1076,20 +1077,20 @@ ignore = []
10761077
merge_imports = true
10771078
"#;
10781079
let mut config = Config::from_toml(toml, Path::new("")).unwrap();
1079-
config.override_value("imports_merge_style", "Preserve");
1080-
assert_eq!(config.imports_merge_style(), ImportMergeStyle::Preserve);
1080+
config.override_value("imports_granularity", "Preserve");
1081+
assert_eq!(config.imports_granularity(), ImportGranularity::Preserve);
10811082
}
10821083

10831084
#[test]
10841085
fn test_old_overridden() {
10851086
let toml = r#"
10861087
unstable_features = true
1087-
imports_merge_style = "Module"
1088+
imports_granularity = "Module"
10881089
"#;
10891090
let mut config = Config::from_toml(toml, Path::new("")).unwrap();
10901091
config.override_value("merge_imports", "true");
10911092
// no effect: the new option always takes precedence
1092-
assert_eq!(config.imports_merge_style(), ImportMergeStyle::Module);
1093+
assert_eq!(config.imports_granularity(), ImportGranularity::Module);
10931094
}
10941095
}
10951096
}

src/config/config_type.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -436,13 +436,13 @@ macro_rules! create_config {
436436
if self.was_set().merge_imports() {
437437
eprintln!(
438438
"Warning: the `merge_imports` option is deprecated. \
439-
Use `imports_merge_style=Crate` instead"
439+
Use `imports_granularity=Crate` instead"
440440
);
441-
if !self.was_set().imports_merge_style() {
442-
self.imports_merge_style.2 = if self.merge_imports() {
443-
ImportMergeStyle::Crate
441+
if !self.was_set().imports_granularity() {
442+
self.imports_granularity.2 = if self.merge_imports() {
443+
ImportGranularity::Crate
444444
} else {
445-
ImportMergeStyle::Preserve
445+
ImportGranularity::Preserve
446446
};
447447
}
448448
}

src/config/options.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ pub enum GroupImportsTactic {
121121

122122
#[config_type]
123123
/// How to merge imports.
124-
pub enum ImportMergeStyle {
124+
pub enum ImportGranularity {
125125
/// Do not merge imports.
126126
Preserve,
127127
/// Use one `use` statement per crate.

src/formatting/reorder.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use std::cmp::{Ord, Ordering};
1111
use rustc_ast::ast;
1212
use rustc_span::{symbol::sym, Span};
1313

14-
use crate::config::{Config, GroupImportsTactic, ImportMergeStyle};
14+
use crate::config::{Config, GroupImportsTactic, ImportGranularity};
1515
use crate::formatting::imports::UseSegment;
1616
use crate::formatting::modules::{get_mod_inner_attrs, FileModMap};
1717
use crate::formatting::{
@@ -228,14 +228,14 @@ fn rewrite_reorderable_or_regroupable_items(
228228
for (item, list_item) in normalized_items.iter_mut().zip(list_items) {
229229
item.list_item = Some(list_item.clone());
230230
}
231-
match context.config.imports_merge_style() {
232-
ImportMergeStyle::Crate => {
231+
match context.config.imports_granularity() {
232+
ImportGranularity::Crate => {
233233
normalized_items = merge_use_trees(normalized_items, SharedPrefix::Crate)
234234
}
235-
ImportMergeStyle::Module => {
235+
ImportGranularity::Module => {
236236
normalized_items = merge_use_trees(normalized_items, SharedPrefix::Module)
237237
}
238-
ImportMergeStyle::Preserve => {}
238+
ImportGranularity::Preserve => {}
239239
}
240240

241241
let mut regrouped_items = match context.config.group_imports() {

src/rustfmt/main.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ struct Opt {
100100
/// Set options from command line.
101101
///
102102
/// Set configuration options via command line by specifying a list of key-value pairs
103-
/// separated by commas (e.g., rustfmt --config=max_width=100,imports_merge_style=Crate).
103+
/// separated by commas (e.g., rustfmt --config=max_width=100,imports_granularity=Crate).
104104
/// These settings precedes any other settings specified in configuration files.
105105
#[structopt(long = "config")]
106106
inline_config: Option<Vec<InlineConfig>>,

tests/source/configs/group_imports/StdExternalCrate-merge_imports.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// rustfmt-group_imports: StdExternalCrate
2-
// rustfmt-imports_merge_style: Crate
2+
// rustfmt-imports_granularity: Crate
33
use chrono::Utc;
44
use super::update::convert_publish_payload;
55

tests/source/configs/imports_layout/merge_mixed.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// rustfmt-imports_indent: Block
2-
// rustfmt-imports_merge_style: Crate
2+
// rustfmt-imports_granularity: Crate
33
// rustfmt-imports_layout: Mixed
44

55
use std::{fmt, io, str};

tests/source/imports_merge_style_crate.rs renamed to tests/source/imports_granularity_crate.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// rustfmt-imports_merge_style: Crate
1+
// rustfmt-imports_granularity: Crate
22

33
use a::{c,d,b};
44
use a::{d, e, b, a, f};

tests/source/imports_merge_style_module.rs renamed to tests/source/imports_granularity_module.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// rustfmt-imports_merge_style: Module
1+
// rustfmt-imports_granularity: Module
22

33
use a::{b::c, d::e};
44
use a::{f, g::{h, i}};

tests/source/issue-3750.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// rustfmt-imports_merge_style: Crate
1+
// rustfmt-imports_granularity: Crate
22

33
pub mod foo {
44
pub mod bar {

tests/target/configs/group_imports/StdExternalCrate-merge_imports.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// rustfmt-group_imports: StdExternalCrate
2-
// rustfmt-imports_merge_style: Crate
2+
// rustfmt-imports_granularity: Crate
33
use alloc::{alloc::Layout, vec::Vec};
44
use core::f32;
55
use std::sync::Arc;
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// rustfmt-imports_indent: Block
2-
// rustfmt-imports_merge_style: Crate
2+
// rustfmt-imports_granularity: Crate
33
// rustfmt-imports_layout: Mixed
44

55
use std::{fmt, io, str, str::FromStr};

tests/target/imports_merge_style_crate.rs renamed to tests/target/imports_granularity_crate.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// rustfmt-imports_merge_style: Crate
1+
// rustfmt-imports_granularity: Crate
22

33
use a::{a, b, c, d, e, f, g};
44

tests/target/imports_merge_style_module.rs renamed to tests/target/imports_granularity_module.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// rustfmt-imports_merge_style: Module
1+
// rustfmt-imports_granularity: Module
22

33
use a::b::c;
44
use a::d::e;

tests/target/issue-3750.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// rustfmt-imports_merge_style: Crate
1+
// rustfmt-imports_granularity: Crate
22

33
pub mod foo {
44
pub mod bar {

0 commit comments

Comments
 (0)