Skip to content

Commit

Permalink
adding more tests and doc updates
Browse files Browse the repository at this point in the history
change config name to generated_marker_line_search_limit
  • Loading branch information
IVIURRAY committed Jan 15, 2024
1 parent 3bc09b6 commit 1d7122b
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 6 deletions.
4 changes: 3 additions & 1 deletion Configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -1061,12 +1061,14 @@ This option is currently ignored for stdin (`@generated` in stdin is ignored.)

## `generated_file_header_size`

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.
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.

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

See also [format_generated_files](#format_generated_files) link here.

## `format_macro_matchers`

Format the metavariable matching patterns in macros.
Expand Down
4 changes: 2 additions & 2 deletions src/config/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ create_config! {
"Write an item and its attribute on the same line \
if their combined width is below a threshold";
format_generated_files: bool, true, false, "Format generated files";
generated_file_header_size: usize, 5, false, "Number of lines to check for a `@generated` \
generated_marker_line_search_limit: usize, 5, false, "Number of lines to check for a `@generated` \
marker when `format_generated_files` is enabled";

// Options that can change the source code beyond whitespace/blocks (somewhat linty things)
Expand Down Expand Up @@ -682,7 +682,7 @@ edition = "2015"
version = "One"
inline_attribute_width = 0
format_generated_files = true
generated_file_header_size = 5
generated_marker_line_search_limit = 5
merge_derives = true
use_try_shorthand = false
use_field_init_shorthand = false
Expand Down
2 changes: 1 addition & 1 deletion src/formatting.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ fn should_skip_module<T: FormatHandler>(
let source_file = context.parse_session.span_to_file_contents(module.span);
let src = source_file.src.as_ref().expect("SourceFile without src");

if is_generated_file(src, config.generated_file_header_size()) {
if is_generated_file(src, config.generated_marker_line_search_limit()) {
return true;
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-format_generated_files: false
// rustfmt-generated_file_header_size: 15
// rustfmt-generated_marker_line_search_limit: 15

fn main()
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-format_generated_files: false
// rustfmt-generated_file_header_size: 15
// rustfmt-generated_marker_line_search_limit: 1

fn main()
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// rustfmt-format_generated_files: true
// rustfmt-generated_marker_line_search_limit: 20

fn main()
{
println!("hello, world")
;
}

// @generated
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// rustfmt-format_generated_files: false
// rustfmt-generated_marker_line_search_limit: 15

fn main()
{
println!("hello, world")
;
}

// @generated
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// rustfmt-format_generated_files: false
// rustfmt-generated_marker_line_search_limit: 1

fn main() {
println!("hello, world");
}

// @generated
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// rustfmt-format_generated_files: true
// rustfmt-generated_marker_line_search_limit: 20

fn main() {
println!("hello, world");
}

// @generated

0 comments on commit 1d7122b

Please sign in to comment.