3 Rustfmt is designed to be very configurable. You can create a TOML file called `rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent directory and it will apply the options in that file.
5 A possible content of `rustfmt.toml` or `.rustfmt.toml` might look like this:
9 reorder_imports = false
12 Each configuration option is either stable or unstable.
13 Stable options can be used directly, while unstable options are opt-in.
14 To enable unstable options, set `unstable_features = true` in `rustfmt.toml` or pass `--unstable-features` to rustfmt.
16 # Configuration Options
18 Below you find a detailed visual guide on all the supported configuration options of rustfmt:
23 Indent on expressions or items.
25 - **Default value**: `"Block"`
26 - **Possible values**: `"Block"`, `"Visual"`
31 #### `"Block"` (default):
51 let lorem = vec!["ipsum",
63 #### `"Block"` (default):
67 if lorem_ipsum && dolor_sit && amet_consectetur && lorem_sit && dolor_consectetur && amet_ipsum
79 if lorem_ipsum && dolor_sit && amet_consectetur && lorem_sit && dolor_consectetur && amet_ipsum
87 See also: [`control_brace_style`](#control_brace_style).
89 ### Function arguments
91 #### `"Block"` (default):
96 fn lorem(ipsum: usize) {}
116 fn lorem(ipsum: usize) {}
118 fn lorem(ipsum: usize,
131 #### `"Block"` (default):
165 #### `"Block"` (default):
173 Adipiscing: Eq = usize,
174 Consectetur: Eq = usize,
181 adipiscing: Adipiscing,
182 consectetur: Consectetur,
192 fn lorem<Ipsum: Eq = usize,
196 Adipiscing: Eq = usize,
197 Consectetur: Eq = usize,
203 adipiscing: Adipiscing,
204 consectetur: Consectetur,
213 #### `"Block"` (default):
228 let lorem = Lorem { ipsum: dolor,
233 See also: [`struct_lit_single_line`](#struct_lit_single_line), [`indent_style`](#indent_style).
237 #### `"Block"` (default):
240 fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
254 fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
264 ## `use_small_heuristics`
266 Whether to use different formatting for items and expressions if they satisfy a heuristic notion of 'small'.
268 - **Default value**: `true`
269 - **Possible values**: `true`, `false`
272 #### `true` (default):
278 Sit { amet: Consectetur, adipiscing: Elit },
296 let lorem = Lorem { ipsum: dolor };
298 let lorem = if ipsum { dolor } else { sit };
315 lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
322 let lorem = if ipsum {
332 Where to put a binary operator when a binary expression goes multiline.
334 - **Default value**: `"Front"`
335 - **Possible values**: `"Front"`, `"Back"`
338 #### `"Front"` (default):
342 let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo
343 || barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
345 let sum = 123456789012345678901234567890 + 123456789012345678901234567890
346 + 123456789012345678901234567890;
348 let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
349 ..bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
357 let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo ||
358 barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
360 let sum = 123456789012345678901234567890 + 123456789012345678901234567890 +
361 123456789012345678901234567890;
363 let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa..
364 bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
368 ## `combine_control_expr`
370 Combine control expressions with function calls.
372 - **Default value**: `true`
373 - **Possible values**: `true`, `false`
376 #### `true` (default):
388 foo!(if let Some(..) = x {
401 foo!(while let Some(..) = x {
435 if let Some(..) = x {
452 while let Some(..) = x {
478 Maximum length of comments. No effect unless`wrap_comments = true`.
480 - **Default value**: `80`
481 - **Possible values**: any positive integer
484 **Note:** A value of `0` results in [`wrap_comments`](#wrap_comments) being applied regardless of a line's width.
486 #### `80` (default; comments shorter than `comment_width`):
488 // Lorem ipsum dolor sit amet, consectetur adipiscing elit.
491 #### `60` (comments longer than `comment_width`):
493 // Lorem ipsum dolor sit amet,
494 // consectetur adipiscing elit.
497 See also [`wrap_comments`](#wrap_comments).
499 ## `condense_wildcard_suffixes`
501 Replace strings of _ wildcards by a single .. in tuple patterns
503 - **Default value**: `false`
504 - **Possible values**: `true`, `false`
507 #### `false` (default):
511 let (lorem, ipsum, _, _) = (1, 2, 3, 4);
512 let (lorem, ipsum, ..) = (1, 2, 3, 4);
520 let (lorem, ipsum, ..) = (1, 2, 3, 4);
524 ## `control_brace_style`
526 Brace style for control flow constructs
528 - **Default value**: `"AlwaysSameLine"`
529 - **Possible values**: `"AlwaysNextLine"`, `"AlwaysSameLine"`, `"ClosingNextLine"`
532 #### `"AlwaysSameLine"` (default):
544 #### `"AlwaysNextLine"`:
559 #### `"ClosingNextLine"`:
572 ## `disable_all_formatting`
574 Don't reformat anything
576 - **Default value**: `false`
577 - **Possible values**: `true`, `false`
580 ## `error_on_line_overflow`
582 Error if Rustfmt is unable to get all lines within `max_width`, except for comments and string
583 literals. If this happens, then it is a bug in Rustfmt. You might be able to work around the bug by
584 refactoring your code to avoid long/complex expressions, usually by extracting a local variable or
585 using a shorter name.
587 - **Default value**: `false`
588 - **Possible values**: `true`, `false`
591 See also [`max_width`](#max_width).
593 ## `error_on_unformatted`
595 Error if unable to get comments or string literals within `max_width`, or they are left with
596 trailing whitespaces.
598 - **Default value**: `false`
599 - **Possible values**: `true`, `false`
604 Argument density in functions
606 - **Default value**: `"Tall"`
607 - **Possible values**: `"Compressed"`, `"Tall"`, `"Vertical"`
610 #### `"Tall"` (default):
614 fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
616 fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet) {
625 consectetur: Consectetur,
626 adipiscing: Adipiscing,
635 consectetur: Consectetur,
636 adipiscing: Adipiscing,
648 fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
650 fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet) {
655 ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
656 adipiscing: Adipiscing, elit: Elit,
660 ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
661 adipiscing: Adipiscing, elit: Elit,
693 consectetur: Consectetur,
694 adipiscing: Adipiscing,
703 consectetur: Consectetur,
704 adipiscing: Adipiscing,
715 Brace style for items
717 - **Default value**: `"SameLineWhere"`
718 - **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
723 #### `"SameLineWhere"` (default):
730 fn lorem(ipsum: usize) {
734 fn lorem<T>(ipsum: T)
736 T: Add + Sub + Mul + Div,
742 #### `"AlwaysNextLine"`:
750 fn lorem(ipsum: usize)
755 fn lorem<T>(ipsum: T)
757 T: Add + Sub + Mul + Div,
763 #### `"PreferSameLine"`:
770 fn lorem(ipsum: usize) {
774 fn lorem<T>(ipsum: T)
776 T: Add + Sub + Mul + Div, {
781 ### Structs and enums
783 #### `"SameLineWhere"` (default):
798 #### `"AlwaysNextLine"`:
814 #### `"PreferSameLine"`:
829 ## `empty_item_single_line`
831 Put empty-body functions and impls on a single line
833 - **Default value**: `true`
834 - **Possible values**: `true`, `false`
837 #### `true` (default):
855 See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
860 Put single-expression functions on a single line
862 - **Default value**: `false`
863 - **Possible values**: `true`, `false`
866 #### `false` (default):
869 fn lorem() -> usize {
873 fn lorem() -> usize {
882 fn lorem() -> usize { 42 }
884 fn lorem() -> usize {
890 See also [`control_brace_style`](#control_brace_style).
893 ## `where_single_line`
895 Forces the `where` clause to be laid out on a single line.
897 - **Default value**: `false`
898 - **Possible values**: `true`, `false`
901 #### `false` (default):
916 where Option<T>: Ipsum
922 See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
925 ## `force_explicit_abi`
927 Always print the abi for extern items
929 - **Default value**: `true`
930 - **Possible values**: `true`, `false`
933 **Note:** Non-"C" ABIs are always printed. If `false` then "C" is removed.
935 #### `true` (default):
939 pub static lorem: c_int;
947 pub static lorem: c_int;
953 Format string literals where necessary
955 - **Default value**: `false`
956 - **Possible values**: `true`, `false`
959 #### `false` (default):
964 "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet consectetur adipiscing";
972 let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet \
973 consectetur adipiscing";
977 See also [`max_width`](#max_width).
981 Use tab characters for indentation, spaces for alignment
983 - **Default value**: `false`
984 - **Possible values**: `true`, `false`
987 #### `false` (default):
990 fn lorem() -> usize {
991 42 // spaces before 42
998 fn lorem() -> usize {
1003 See also: [`tab_spaces`](#tab_spaces).
1008 Indent style of imports
1010 - **Default Value**: `"Visual"`
1011 - **Possible values**: `"Block"`, `"Visual"`
1014 #### `"Visual"` (default):
1017 use foo::{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
1018 zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz};
1025 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
1026 zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
1030 See also: [`imports_layout`](#imports_layout).
1034 Item layout inside a imports block
1036 - **Default value**: "Mixed"
1037 - **Possible values**: "Horizontal", "HorizontalVertical", "Mixed", "Vertical"
1040 #### `"Mixed"` (default):
1043 use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
1045 use foo::{aaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbb, cccccccccccccccccc, dddddddddddddddddd,
1046 eeeeeeeeeeeeeeeeee, ffffffffffffffffff};
1049 #### `"Horizontal"`:
1051 **Note**: This option forces all imports onto one line and may exceed `max_width`.
1054 use foo::{xxx, yyy, zzz};
1056 use foo::{aaa, bbb, ccc, ddd, eee, fff};
1059 #### `"HorizontalVertical"`:
1062 use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
1064 use foo::{aaaaaaaaaaaaaaaaaa,
1069 ffffffffffffffffff};
1088 ## `match_block_trailing_comma`
1090 Put a trailing comma after a block based match arm (non-block arms are not affected)
1092 - **Default value**: `false`
1093 - **Possible values**: `true`, `false`
1096 #### `false` (default):
1104 Lorem::Dolor => println!("dolor"),
1117 Lorem::Dolor => println!("dolor"),
1122 See also: [`trailing_comma`](#trailing_comma), [`match_arm_blocks`](#match_arm_blocks).
1126 Maximum width of each line
1128 - **Default value**: `100`
1129 - **Possible values**: any positive integer
1132 See also [`error_on_line_overflow`](#error_on_line_overflow).
1136 Merge multiple derives into a single one.
1138 - **Default value**: `true`
1139 - **Possible values**: `true`, `false`
1142 #### `true` (default):
1145 #[derive(Eq, PartialEq, Debug, Copy, Clone)]
1152 #[derive(Eq, PartialEq)]
1154 #[derive(Copy, Clone)]
1158 ## `force_multiline_blocks`
1160 Force multiline closure and match arm bodies to be wrapped in a block
1162 - **Default value**: `false`
1163 - **Possible values**: `false`, `true`
1166 #### `false` (default):
1170 result.and_then(|maybe_value| match maybe_value {
1172 Some(value) => bar(),
1177 println!("Hello World");
1179 Some(dolor) => foo(),
1188 result.and_then(|maybe_value| {
1191 Some(value) => bar(),
1198 println!("Hello World");
1201 Some(dolor) => foo(),
1209 Unix or Windows line endings
1211 - **Default value**: `"Unix"`
1212 - **Possible values**: `"Native"`, `"Unix"`, `"Windows"`
1215 ## `normalize_comments`
1217 Convert /* */ comments to // comments where possible
1219 - **Default value**: `false`
1220 - **Possible values**: `true`, `false`
1223 #### `false` (default):
1227 fn dolor() -> usize {}
1230 fn adipiscing() -> usize {}
1237 fn dolor() -> usize {}
1240 fn adipiscing() -> usize {}
1244 ## `reorder_imports`
1246 Reorder import and extern crate statements alphabetically
1248 - **Default value**: `false`
1249 - **Possible values**: `true`, `false`
1252 #### `false` (default):
1271 ## `reorder_modules`
1273 Reorder `mod` declarations alphabetically in group.
1275 - **Default value**: `true`
1276 - **Possible values**: `true`, `false`
1279 #### `true` (default)
1303 **Note** `mod` with `#[macro_export]` will not be reordered since that could change the semantic
1304 of the original source code.
1306 ## `reorder_impl_items`
1308 Reorder impl items. `type` and `const` are put first, then macros and methods.
1310 - **Default value**: `false`
1311 - **Possible values**: `true`, `false`
1314 #### `false` (default)
1319 impl Iterator for Dummy {
1320 fn next(&mut self) -> Option<Self::Item> {
1333 impl Iterator for Dummy {
1336 fn next(&mut self) -> Option<Self::Item> {
1344 Report `TODO` items in comments.
1346 - **Default value**: `"Never"`
1347 - **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
1350 Warns about any comments containing `TODO` in them when set to `"Always"`. If
1351 it contains a `#X` (with `X` being a number) in parentheses following the
1352 `TODO`, `"Unnumbered"` will ignore it.
1354 See also [`report_fixme`](#report_fixme).
1358 Report `FIXME` items in comments.
1360 - **Default value**: `"Never"`
1361 - **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
1364 Warns about any comments containing `FIXME` in them when set to `"Always"`. If
1365 it contains a `#X` (with `X` being a number) in parentheses following the
1366 `FIXME`, `"Unnumbered"` will ignore it.
1368 See also [`report_todo`](#report_todo).
1373 Don't reformat out of line modules
1375 - **Default value**: `false`
1376 - **Possible values**: `true`, `false`
1379 ## `space_after_colon`
1381 Leave a space after the colon.
1383 - **Default value**: `true`
1384 - **Possible values**: `true`, `false`
1387 #### `true` (default):
1390 fn lorem<T: Eq>(t: T) {
1391 let lorem: Dolor = Lorem {
1401 fn lorem<T:Eq>(t:T) {
1402 let lorem:Dolor = Lorem {
1409 See also: [`space_before_colon`](#space_before_colon).
1411 ## `space_before_colon`
1413 Leave a space before the colon.
1415 - **Default value**: `false`
1416 - **Possible values**: `true`, `false`
1419 #### `false` (default):
1422 fn lorem<T: Eq>(t: T) {
1423 let lorem: Dolor = Lorem {
1433 fn lorem<T : Eq>(t : T) {
1434 let lorem : Dolor = Lorem {
1441 See also: [`space_after_colon`](#space_after_colon).
1443 ## `struct_field_align_threshold`
1445 The maximum diff of width between struct fields to be aligned with each other.
1447 - **Default value** : 0
1448 - **Possible values**: any positive integer
1471 ## `spaces_around_ranges`
1473 Put spaces around the .., ..=, and ... range operators
1475 - **Default value**: `false`
1476 - **Possible values**: `true`, `false`
1479 #### `false` (default):
1507 let lorem = 0 .. 10;
1508 let ipsum = 0 ..= 10;
1527 ## `spaces_within_parens_and_brackets`
1529 Put spaces within non-empty generic arguments, parentheses, and square brackets
1531 - **Default value**: `false`
1532 - **Possible values**: `true`, `false`
1535 #### `false` (default):
1538 // generic arguments
1539 fn lorem<T: Eq>(t: T) {
1543 // non-empty parentheses
1544 fn lorem<T: Eq>(t: T) {
1545 let lorem = (ipsum, dolor);
1548 // non-empty square brackets
1549 fn lorem<T: Eq>(t: T) {
1550 let lorem: [usize; 2] = [ipsum, dolor];
1557 // generic arguments
1558 fn lorem< T: Eq >( t: T ) {
1562 // non-empty parentheses
1563 fn lorem< T: Eq >( t: T ) {
1564 let lorem = ( ipsum, dolor );
1567 // non-empty square brackets
1568 fn lorem< T: Eq >( t: T ) {
1569 let lorem: [ usize; 2 ] = [ ipsum, dolor ];
1573 ## `struct_lit_single_line`
1575 Put small struct literals on a single line
1577 - **Default value**: `true`
1578 - **Possible values**: `true`, `false`
1581 #### `true` (default):
1585 let lorem = Lorem { foo: bar, baz: ofo };
1600 See also: [`indent_style`](#indent_style).
1605 Number of spaces per tab
1607 - **Default value**: `4`
1608 - **Possible values**: any positive integer
1615 let ipsum = dolor();
1617 "amet consectetur adipiscing elit amet",
1618 "consectetur adipiscing elit amet consectetur.",
1627 let ipsum = dolor();
1629 "amet consectetur adipiscing elit amet",
1630 "consectetur adipiscing elit amet consectetur.",
1635 See also: [`hard_tabs`](#hard_tabs).
1640 How to handle trailing commas for lists
1642 - **Default value**: `"Vertical"`
1643 - **Possible values**: `"Always"`, `"Never"`, `"Vertical"`
1646 #### `"Vertical"` (default):
1650 let Lorem { ipsum, dolor, sit } = amet;
1666 let Lorem { ipsum, dolor, sit, } = amet;
1682 let Lorem { ipsum, dolor, sit } = amet;
1694 See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
1696 ## `trailing_semicolon`
1698 Add trailing semicolon after break, continue and return
1700 - **Default value**: `true`
1701 - **Possible values**: `true`, `false`
1704 #### `true` (default):
1718 ## `type_punctuation_density`
1720 Determines if `+` or `=` are wrapped in spaces in the punctuation of types
1722 - **Default value**: `"Wide"`
1723 - **Possible values**: `"Compressed"`, `"Wide"`
1726 #### `"Wide"` (default):
1729 fn lorem<Ipsum: Dolor + Sit = Amet>() {
1734 #### `"Compressed"`:
1737 fn lorem<Ipsum: Dolor+Sit=Amet>() {
1742 ## `use_field_init_shorthand`
1744 Use field initialize shorthand if possible.
1746 - **Default value**: `false`
1747 - **Possible values**: `true`, `false`
1750 #### `false` (default):
1763 let a = Foo { x: x, y: y, z: z };
1780 let a = Foo { x, y, z };
1784 ## `use_try_shorthand`
1786 Replace uses of the try! macro by the ? shorthand
1788 - **Default value**: `false`
1789 - **Possible values**: `true`, `false`
1792 #### `false` (default):
1796 let lorem = try!(ipsum.map(|dolor| dolor.sit()));
1804 let lorem = ipsum.map(|dolor| dolor.sit())?;
1811 Break comments to fit on the line
1813 - **Default value**: `false`
1814 - **Possible values**: `true`, `false`
1817 #### `false` (default):
1820 // Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
1826 // Lorem ipsum dolor sit amet, consectetur adipiscing elit,
1827 // sed do eiusmod tempor incididunt ut labore et dolore
1828 // magna aliqua. Ut enim ad minim veniam, quis nostrud
1829 // exercitation ullamco laboris nisi ut aliquip ex ea
1830 // commodo consequat.
1833 ## `match_arm_blocks`
1835 Wrap the body of arms in blocks when it does not fit on the same line with the pattern of arms
1837 - **Default value**: `true`
1838 - **Possible values**: `true`, `false`
1841 #### `true` (default):
1847 foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
1849 false => println!("{}", sit),
1860 foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
1861 false => println!("{}", sit),
1866 See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
1870 What Write Mode to use when none is supplied: Replace, Overwrite, Display, Diff, Coverage
1872 - **Default value**: `"Overwrite"`
1873 - **Possible values**: `"Checkstyle"`, `"Coverage"`, `"Diff"`, `"Display"`, `"Overwrite"`, `"Plain"`, `"Replace"`
1876 ## `blank_lines_upper_bound`
1878 Maximum number of blank lines which can be put between items. If more than this number of consecutive empty
1879 lines are found, they are trimmed down to match this integer.
1881 - **Default value**: `1`
1882 - **Possible values**: *unsigned integer*
1933 See also: [`blank_lines_lower_bound`](#blank_lines_lower_bound)
1935 ## `blank_lines_lower_bound`
1937 Minimum number of blank lines which must be put between items. If two items have fewer blank lines between
1938 them, additional blank lines are inserted.
1940 - **Default value**: `0`
1941 - **Possible values**: *unsigned integer*
1945 Original Code (rustfmt will not change it with the default value of `0`):
1974 ## `remove_blank_lines_at_start_or_end_of_block`
1976 Remove blank lines at the start or the end of a block.
1978 - **Default value**: `true`
1979 - **Possible values**: `true`, `false`
1987 let mut str = String::new();
1988 str.push_str("hello, ");
1989 str.push_str("world!");
1992 println!("{}", msg);
2003 let mut str = String::new();
2004 str.push_str("hello, ");
2005 str.push_str("world!");
2009 println!("{}", msg);
2014 ## `required_version`
2016 Require a specific version of rustfmt. If you want to make sure that the
2017 specific version of rustfmt is used in your CI, use this option.
2019 - **Default value**: `CARGO_PKG_VERSION`
2020 - **Possible values**: any published version (e.g. `"0.3.8"`)
2023 ## `hide_parse_errors`
2025 Do not show parse errors if the parser failed to parse files.
2027 - **Default value**: `false`
2028 - **Possible values**: `true`, `false`
2033 Whether to use colored output or not.
2035 - **Default value**: `"Auto"`
2036 - **Possible values**: "Auto", "Always", "Never"
2039 ## `unstable_features`
2041 Enable unstable features on stable channel.
2043 - **Default value**: `false`
2044 - **Possible values**: `true`, `false`
2047 ## `license_template_path`
2049 Check whether beginnings of files match a license template.
2051 - **Default value**: `""``
2052 - **Possible values**: path to a license template file
2055 A license template is a plain text file which is matched literally against the
2056 beginning of each source file, except for `{}`-delimited blocks, which are
2057 matched as regular expressions. The following license template therefore
2058 matches strings like `// Copyright 2017 The Rust Project Developers.`, `//
2059 Copyright 2018 The Rust Project Developers.`, etc.:
2062 // Copyright {\d+} The Rust Project Developers.
2065 `\{`, `\}` and `\\` match literal braces / backslashes.
2069 Skip formatting the specified files and directories.
2071 - **Default value**: format every files
2072 - **Possible values**: See an example below
2077 If you want to ignore specific files, put the following to your config file:
2086 If you want to ignore every file under `examples/`, put the following to your config file: