Make target dir self-ignoring

Author: senekor

src/cargo/core/workspace.rs

@@ -402,9 +402,16 @@ impl<'gctx> Workspace<'gctx> {
     }
 
     pub fn target_dir(&self) -> Filesystem {
-        self.target_dir
+        let target_dir = self
+            .target_dir
             .clone()
-            .unwrap_or_else(|| self.default_target_dir())
+            .unwrap_or_else(|| self.default_target_dir());
+
+        let path = target_dir.as_path_unlocked();
+        paths::create_dir_all(path).unwrap();
+        std::fs::write(path.join(".gitignore"), "*\n").unwrap();
+
+        target_dir
     }
 
     fn default_target_dir(&self) -> Filesystem {

src/cargo/ops/cargo_new.rs

@@ -680,7 +680,7 @@ fn write_ignore_file(base_path: &Path, list: &IgnoreList, vcs: VersionControl) -
     }
 
     for fp_ignore in match vcs {
-        VersionControl::Git => vec![base_path.join(".gitignore")],
+        VersionControl::Git => return Ok(()), // target-dir already contains wildcard gitignore file
         VersionControl::Hg => vec![base_path.join(".hgignore")],
         VersionControl::Pijul => vec![base_path.join(".ignore")],
         // Fossil has a cleaning functionality configured in a separate file.

tests/testsuite/cargo_init/auto_git/out/.gitignore

@@ -1,5 +1 @@
-**/some.file
-
-# Added by cargo
-
-/target
+**/some.file

tests/testsuite/cargo_init/explicit_bin_with_git/out/.gitignore

@@ -1,8 +1,2 @@
 /target
-**/some.file
-
-# Added by cargo
-#
-# already existing elements were commented out
-
-#/target
+**/some.file

tests/testsuite/cargo_init/git_autodetect/out/.gitignore

@@ -849,7 +849,7 @@ fn clean_dry_run() {
     p.cargo("clean --dry-run")
         .with_stdout_data("")
         .with_stderr_data(str![[r#"
-[SUMMARY] 0 files
+[SUMMARY] [FILE_NUM] files, [FILE_SIZE]B total
 [WARNING] no files deleted due to --dry-run
 
 "#]])

tests/testsuite/cargo_init/git_ignore_exists_no_conflicting_entries/out/.gitignore

@@ -105,13 +105,14 @@ fn simple_git() {
     assert!(paths::root().join("foo/Cargo.toml").is_file());
     assert!(paths::root().join("foo/src/lib.rs").is_file());
     assert!(paths::root().join("foo/.git").is_dir());
-    assert!(paths::root().join("foo/.gitignore").is_file());
-
-    let fp = paths::root().join("foo/.gitignore");
-    let contents = fs::read_to_string(&fp).unwrap();
-    assert_eq!(contents, "/target\n",);
 
     cargo_process("build").cwd(&paths::root().join("foo")).run();
+
+    assert!(paths::root().join("foo/target/.gitignore").is_file());
+
+    let fp = paths::root().join("foo/target/.gitignore");
+    let contents = fs::read_to_string(&fp).unwrap();
+    assert_eq!(contents, "*\n",);
 }
 
 #[cargo_test(requires = "hg")]
@@ -272,7 +273,7 @@ fn git_prefers_command_line() {
     .unwrap();
 
     cargo_process("new foo --vcs git").run();
-    assert!(paths::root().join("foo/.gitignore").exists());
+    assert!(!paths::root().join("foo/.gitignore").exists());
     assert!(!fs::read_to_string(paths::root().join("foo/Cargo.toml"))
         .unwrap()
         .contains("authors ="));
@@ -283,7 +284,7 @@ fn subpackage_no_git() {
     cargo_process("new foo").run();
 
     assert!(paths::root().join("foo/.git").is_dir());
-    assert!(paths::root().join("foo/.gitignore").is_file());
+    assert!(!paths::root().join("foo/.gitignore").is_file());
 
     let subpackage = paths::root().join("foo").join("components");
     fs::create_dir(&subpackage).unwrap();
@@ -302,7 +303,7 @@ fn subpackage_git_with_gitignore() {
     cargo_process("new foo").run();
 
     assert!(paths::root().join("foo/.git").is_dir());
-    assert!(paths::root().join("foo/.gitignore").is_file());
+    assert!(!paths::root().join("foo/.gitignore").is_file());
 
     let gitignore = paths::root().join("foo/.gitignore");
     fs::write(gitignore, b"components").unwrap();
@@ -314,7 +315,7 @@ fn subpackage_git_with_gitignore() {
     assert!(paths::root()
         .join("foo/components/subcomponent/.git")
         .is_dir());
-    assert!(paths::root()
+    assert!(!paths::root()
         .join("foo/components/subcomponent/.gitignore")
         .is_file());
 }
@@ -330,7 +331,7 @@ fn subpackage_git_with_vcs_arg() {
     assert!(paths::root()
         .join("foo/components/subcomponent/.git")
         .is_dir());
-    assert!(paths::root()
+    assert!(!paths::root()
         .join("foo/components/subcomponent/.gitignore")
         .is_file());
 }
@@ -544,13 +545,10 @@ fn non_utf8_str_in_ignore_file() {
     fs::write(paths::home().join(".gitignore"), &[0xFF, 0xFE]).unwrap();
 
     cargo_process(&format!("init {} --vcs git", paths::home().display()))
-        .with_status(101)
+        .with_status(0)
         .with_stderr_data(str![[r#"
 [CREATING] binary (application) package
-[ERROR] Failed to create package `home` at `[ROOT]/home`
-
-Caused by:
-  Character at line 0 is invalid. Cargo only supports UTF-8.
+[NOTE] see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 "#]])
         .run();