add format_cargo_toml option & integrate to cargo-fmt

Author: xxchan

Cargo.toml

@@ -9,6 +9,11 @@ readme = "README.md"
 repository = "https://github.com/rust-lang/rustfmt"
 description = "Tool to find and fix Rust formatting issues"
 
+# Rustc dependencies are loaded from the sysroot, Cargo doesn't know about them.
+[package.metadata.rust-analyzer]
+# This package uses #[feature(rustc_private)]
+rustc_private = true
+
 [[bin]]
 name = "rustfmt"
 path = "src/bin/main.rs"
@@ -61,8 +66,3 @@ toml_edit = "0.13"
 unicode-segmentation = "1.9"
 unicode-width = "0.1"
 unicode_categories = "0.1"
-
-# Rustc dependencies are loaded from the sysroot, Cargo doesn't know about them.
-[package.metadata.rust-analyzer]
-# This package uses #[feature(rustc_private)]
-rustc_private = true

Configurations.md

@@ -1040,6 +1040,14 @@ fn add_one(x: i32) -> i32 {
 }
 ```
 
+## `format_cargo_toml`
+
+Format `Cargo.toml` files.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#4091](https://github.com/rust-lang/rustfmt/issues/4091))
+
 ## `doc_comment_code_block_width`
 
 Max width for code snippets included in doc comments. Only used if [`format_code_in_doc_comments`](#format_code_in_doc_comments) is true.

rustfmt.toml

@@ -1,3 +1,4 @@
 error_on_line_overflow = true
 error_on_unformatted = true
 version = "Two"
+format_cargo_toml = true

src/cargo-fmt/main.rs

@@ -284,6 +284,15 @@ impl Target {
             edition: target.edition.clone(),
         }
     }
+
+    /// `Cargo.toml` file to format.
+    pub fn manifest_target(manifest_path: PathBuf) -> Self {
+        Target {
+            path: manifest_path,
+            kind: String::from("manifest"),
+            edition: String::from("2021"), // The value doesn't matter for formatting Cargo.toml.
+        }
+    }
 }
 
 impl PartialEq for Target {
@@ -365,6 +374,9 @@ fn get_targets_root_only(
 ) -> Result<(), io::Error> {
     let metadata = get_cargo_metadata(manifest_path)?;
     let workspace_root_path = PathBuf::from(&metadata.workspace_root).canonicalize()?;
+    targets.insert(Target::manifest_target(
+        workspace_root_path.join("Cargo.toml"),
+    ));
     let (in_workspace_root, current_dir_manifest) = if let Some(target_manifest) = manifest_path {
         (
             workspace_root_path == target_manifest,
@@ -379,7 +391,15 @@ fn get_targets_root_only(
     };
 
     let package_targets = match metadata.packages.len() {
-        1 => metadata.packages.into_iter().next().unwrap().targets,
+        1 => {
+            let p = metadata.packages.into_iter().next().unwrap();
+            targets.insert(Target::manifest_target(
+                PathBuf::from(&p.manifest_path)
+                    .canonicalize()
+                    .unwrap_or_default(),
+            ));
+            p.targets
+        }
         _ => metadata
             .packages
             .into_iter()
@@ -390,13 +410,18 @@ fn get_targets_root_only(
                         .unwrap_or_default()
                         == current_dir_manifest
             })
-            .flat_map(|p| p.targets)
+            .flat_map(|p| {
+                targets.insert(Target::manifest_target(
+                    PathBuf::from(&p.manifest_path)
+                        .canonicalize()
+                        .unwrap_or_default(),
+                ));
+                p.targets
+            })
             .collect(),
     };
 
-    for target in package_targets {
-        targets.insert(Target::from_target(&target));
-    }
+    add_targets(&package_targets, targets);
 
     Ok(())
 }
@@ -408,6 +433,11 @@ fn get_targets_recursive(
 ) -> Result<(), io::Error> {
     let metadata = get_cargo_metadata(manifest_path)?;
     for package in &metadata.packages {
+        targets.insert(Target::manifest_target(
+            PathBuf::from(&package.manifest_path)
+                .canonicalize()
+                .unwrap_or_default(),
+        ));
         add_targets(&package.targets, targets);
 
         // Look for local dependencies using information available since cargo v1.51
@@ -447,6 +477,11 @@ fn get_targets_with_hitlist(
 
     for package in metadata.packages {
         if workspace_hitlist.remove(&package.name) {
+            targets.insert(Target::manifest_target(
+                PathBuf::from(&package.manifest_path)
+                    .canonicalize()
+                    .unwrap_or_default(),
+            ));
             for target in package.targets {
                 targets.insert(Target::from_target(&target));
             }

src/cargo-fmt/test/targets.rs

@@ -57,7 +57,7 @@ mod all_targets {
                 manifest_suffix,
                 "divergent-crate-dir-names",
                 &exp_targets,
-                3,
+                3 + 3, // include 3 Cargo.toml files
             );
         }
 
@@ -112,7 +112,7 @@ mod all_targets {
                 manifest_suffix,
                 "workspaces/path-dep-above",
                 &exp_targets,
-                6,
+                6 + 6, // include 6 Cargo.toml files,
             );
         }
 

src/config/mod.rs

@@ -173,6 +173,7 @@ create_config! {
          or they are left with trailing whitespaces";
     ignore: IgnoreList, IgnoreList::default(), false,
         "Skip formatting the specified files and directories";
+    format_cargo_toml: bool, false, false, "Format Cargo.toml files";
 
     // Not user-facing
     verbose: Verbosity, Verbosity::Normal, false, "How much to information to emit to the user";
@@ -681,6 +682,7 @@ hide_parse_errors = false
 error_on_line_overflow = false
 error_on_unformatted = false
 ignore = []
+format_cargo_toml = false
 emit_mode = "Files"
 make_backup = false
 "#,

src/formatting.rs

@@ -196,7 +196,7 @@ fn format_cargo_toml<T: FormatHandler>(
 
     let ignore_path_set = IgnorePathSet::from_ignore_list(&config.ignore())?;
     let file_name = FileName::Real(path.clone());
-    if ignore_path_set.is_match(&file_name) {
+    if !config.format_cargo_toml() || ignore_path_set.is_match(&file_name) {
         return Ok(report);
     }
 

src/test/mod.rs

@@ -696,6 +696,12 @@ fn print_mismatches<T: Fn(u32) -> String>(
 }
 
 fn read_config(filename: &Path) -> Config {
+    if filename.file_name().map_or(false, |f| f == "Cargo.toml") {
+        let mut config = Config::default();
+        config.set().format_cargo_toml(true);
+        return config;
+    }
+
     let sig_comments = read_significant_comments(filename);
     // Look for a config file. If there is a 'config' property in the significant comments, use
     // that. Otherwise, if there are no significant comments at all, look for a config file with