Skip to content

Add config to allow generated lines scan to be configurable #5918

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions Configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -1050,15 +1050,26 @@ Max width for code snippets included in doc comments. Only used if [`format_code

## `format_generated_files`

Format generated files. A file is considered generated
if any of the first five lines contain a `@generated` comment marker.
By default, generated files are reformatted, i. e. `@generated` marker is ignored.
This option is currently ignored for stdin (`@generated` in stdin is ignored.)
Format generated files. A file is considered generated if any of
the first `generated_files_scan_lines_limit` lines contain a
`@generated` comment marker. By default, generated files are
reformatted, i. e. `@generated` marker is ignored. This option
is currently ignored for stdin (`@generated` in stdin is ignored.)

- **Default value**: `true`
- **Possible values**: `true`, `false`
- **Stable**: No (tracking issue: [#5080](https://github.com/rust-lang/rustfmt/issues/5080))

## `generated_files_scan_lines_limit`

Number of lines to scan for `@generated` marker in generated files. If the marker is not found
within the specified number of lines, the file is considered not generated.

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


## `format_macro_matchers`

Format the metavariable matching patterns in macros.
Expand Down Expand Up @@ -2342,7 +2353,7 @@ specific version of rustfmt is used in your CI, use this option.

The width threshold for an array element to be considered "short".

The layout of an array is dependent on the length of each of its elements.
The layout of an array is dependent on the length of each of its elements.
If the length of every element in an array is below this threshold (all elements are "short") then the array can be formatted in the mixed/compressed style, but if any one element has a length that exceeds this threshold then the array elements will have to be formatted vertically.

- **Default value**: `10`
Expand Down
4 changes: 4 additions & 0 deletions src/config/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,9 @@ 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_files_scan_lines_limit: usize, 5, false,
"How many lines at the beginning of each file to scan for \
`@generated` markers, to determine if it is generated";

// Options that can change the source code beyond whitespace/blocks (somewhat linty things)
merge_derives: bool, true, true, "Merge multiple `#[derive(...)]` into a single one";
Expand Down Expand Up @@ -671,6 +674,7 @@ edition = "2015"
version = "One"
inline_attribute_width = 0
format_generated_files = true
generated_files_scan_lines_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) {
if is_generated_file(src, config.generated_files_scan_lines_limit()) {
return true;
}
}
Expand Down
27 changes: 25 additions & 2 deletions src/formatting/generated.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,30 @@
/// Returns `true` if the given span is a part of generated files.
pub(super) fn is_generated_file(original_snippet: &str) -> bool {
pub(super) fn is_generated_file(original_snippet: &str, scan_number_of_lines: usize) -> bool {
original_snippet
.lines()
.take(5) // looking for marker only in the beginning of the file
.take(scan_number_of_lines)
.any(|line| line.contains("@generated"))
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn detect_generated_file_simple() {
let snippet = "@generated";
assert!(is_generated_file(snippet, 1));
}

#[test]
fn detect_generated_file_5_lines() {
let snippet = "\n \n \n \n @generated";
assert!(is_generated_file(snippet, 5));
}

#[test]
fn no_detect_generated_file_5_lines() {
let snippet = "\n \n \n \n \n @generated";
assert!(!is_generated_file(snippet, 5));
}
}