[cli] Add extra ignores to .gitignores created by CLI (#15674)

aptos-labs · Jan 7, 2025 · 0318475 · 0318475
1 parent e3fdc51
commit 0318475
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/aptos/Cargo.toml b/crates/aptos/Cargo.toml
@@ -67,6 +67,7 @@ diesel-async = { workspace = true }
 dirs = { workspace = true }
 futures = { workspace = true }
 hex = { workspace = true }
+indoc = { workspace = true }
 itertools = { workspace = true }
 maplit = { workspace = true }
 move-binary-format = { workspace = true }

diff --git a/crates/aptos/src/common/types.rs b/crates/aptos/src/common/types.rs
@@ -50,6 +50,7 @@ use aptos_vm_types::output::VMOutput;
 use async_trait::async_trait;
 use clap::{Parser, ValueEnum};
 use hex::FromHexError;
+use indoc::indoc;
 use move_core_types::{
     account_address::AccountAddress, language_storage::TypeTag, vm_status::VMStatus,
 };
@@ -79,6 +80,18 @@ pub const DEFAULT_EXPIRATION_SECS: u64 = 30;
 pub const DEFAULT_PROFILE: &str = "default";
 pub const GIT_IGNORE: &str = ".gitignore";
 
+pub const APTOS_FOLDER_GIT_IGNORE: &str = indoc! {"
+    *
+    testnet/
+    config.yaml
+"};
+pub const MOVE_FOLDER_GIT_IGNORE: &str = indoc! {"
+  .aptos/
+  build/
+  .coverage_map.mvcov
+  .trace"
+};
+
 // Custom header value to identify the client
 const X_APTOS_CLIENT_VALUE: &str = concat!("aptos-cli/", env!("CARGO_PKG_VERSION"));
 
@@ -392,7 +405,7 @@ impl CliConfig {
             write_to_user_only_file(
                 aptos_folder.join(GIT_IGNORE).as_path(),
                 GIT_IGNORE,
-                "*\ntestnet/\nconfig.yaml".as_bytes(),
+                APTOS_FOLDER_GIT_IGNORE.as_bytes(),
             )?;
         }
 

diff --git a/crates/aptos/src/config/mod.rs b/crates/aptos/src/config/mod.rs
@@ -5,7 +5,7 @@ use crate::{
     common::{
         types::{
             CliCommand, CliConfig, CliError, CliResult, CliTypedResult, ConfigSearchMode,
-            ProfileSummary, CONFIG_FOLDER,
+            ProfileSummary, APTOS_FOLDER_GIT_IGNORE, CONFIG_FOLDER, GIT_IGNORE,
         },
         utils::{create_dir_if_not_exist, current_dir, read_from_file, write_to_user_only_file},
     },
@@ -369,6 +369,12 @@ impl GlobalConfig {
             global_folder.join(GLOBAL_CONFIG_FILE).as_path(),
             "Global Config",
             &to_yaml(&self)?.into_bytes(),
+        )?;
+        // Let's also write a .gitignore that ignores this folder
+        write_to_user_only_file(
+            global_folder.join(GIT_IGNORE).as_path(),
+            ".gitignore",
+            APTOS_FOLDER_GIT_IGNORE.as_bytes(),
         )
     }
 }