Skip to content

Commit 1d7122b

Browse files
committed
adding more tests and doc updates
change config name to generated_marker_line_search_limit
1 parent 3bc09b6 commit 1d7122b

9 files changed

+44
-6
lines changed

Configurations.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1061,12 +1061,14 @@ This option is currently ignored for stdin (`@generated` in stdin is ignored.)
10611061

10621062
## `generated_file_header_size`
10631063

1064-
Number of lines to check for a `@generated` pragma header when `format_generated_files` is enabled. When `format_generated_files` is disabled, this option has no effect.
1064+
Number of lines to check for a `@generated` pragma header when `format_generated_files` is `false`. When `format_generated_files` is `true`, this option has no effect.
10651065

10661066
- **Default value**: `5`
10671067
- **Possible values**: any positive integer
10681068
- **Stable**: No (tracking issue: [#5080](https://github.com/rust-lang/rustfmt/issues/5080))
10691069

1070+
See also [format_generated_files](#format_generated_files) link here.
1071+
10701072
## `format_macro_matchers`
10711073

10721074
Format the metavariable matching patterns in macros.

src/config/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ create_config! {
151151
"Write an item and its attribute on the same line \
152152
if their combined width is below a threshold";
153153
format_generated_files: bool, true, false, "Format generated files";
154-
generated_file_header_size: usize, 5, false, "Number of lines to check for a `@generated` \
154+
generated_marker_line_search_limit: usize, 5, false, "Number of lines to check for a `@generated` \
155155
marker when `format_generated_files` is enabled";
156156

157157
// Options that can change the source code beyond whitespace/blocks (somewhat linty things)
@@ -682,7 +682,7 @@ edition = "2015"
682682
version = "One"
683683
inline_attribute_width = 0
684684
format_generated_files = true
685-
generated_file_header_size = 5
685+
generated_marker_line_search_limit = 5
686686
merge_derives = true
687687
use_try_shorthand = false
688688
use_field_init_shorthand = false

src/formatting.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ fn should_skip_module<T: FormatHandler>(
8282
let source_file = context.parse_session.span_to_file_contents(module.span);
8383
let src = source_file.src.as_ref().expect("SourceFile without src");
8484

85-
if is_generated_file(src, config.generated_file_header_size()) {
85+
if is_generated_file(src, config.generated_marker_line_search_limit()) {
8686
return true;
8787
}
8888
}

tests/target/configs/format_generated_files/false_with_generated_file_header_size.rs renamed to tests/source/configs/format_generated_files/false_with_generated_marker_line_search_limit.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// rustfmt-format_generated_files: false
2-
// rustfmt-generated_file_header_size: 15
2+
// rustfmt-generated_marker_line_search_limit: 15
33

44
fn main()
55
{

tests/source/configs/format_generated_files/false_with_generated_file_header_size.rs renamed to tests/source/configs/format_generated_files/false_with_marker_out_scope_size.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// rustfmt-format_generated_files: false
2-
// rustfmt-generated_file_header_size: 15
2+
// rustfmt-generated_marker_line_search_limit: 1
33

44
fn main()
55
{
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// rustfmt-format_generated_files: true
2+
// rustfmt-generated_marker_line_search_limit: 20
3+
4+
fn main()
5+
{
6+
println!("hello, world")
7+
;
8+
}
9+
10+
// @generated
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// rustfmt-format_generated_files: false
2+
// rustfmt-generated_marker_line_search_limit: 15
3+
4+
fn main()
5+
{
6+
println!("hello, world")
7+
;
8+
}
9+
10+
// @generated
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// rustfmt-format_generated_files: false
2+
// rustfmt-generated_marker_line_search_limit: 1
3+
4+
fn main() {
5+
println!("hello, world");
6+
}
7+
8+
// @generated
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// rustfmt-format_generated_files: true
2+
// rustfmt-generated_marker_line_search_limit: 20
3+
4+
fn main() {
5+
println!("hello, world");
6+
}
7+
8+
// @generated

0 commit comments

Comments
 (0)