From efb16dd9cabc04ce0c5c34e5ea67c50c3a63c433 Mon Sep 17 00:00:00 2001
From: cubercsl <2014cais01@gmail.com>
Date: Mon, 14 Feb 2022 22:51:29 +0800
Subject: [PATCH] fix(localip): disable localip module default (#3607)

---
 src/modules/localip.rs | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/src/modules/localip.rs b/src/modules/localip.rs
index 8d02f091..de6e5167 100644
--- a/src/modules/localip.rs
+++ b/src/modules/localip.rs
@@ -11,12 +11,18 @@ use crate::formatter::StringFormatter;
 /// is to connect a UDP socket and then reading its local endpoint.
 ///
 /// Will display the ip if all of the following criteria are met:
-///     - localip.disabled is absent or false
+///     - localip.disabled is false
 ///     - localip.ssh_only is false OR the user is currently connected as an SSH session (`$SSH_CONNECTION`)
 pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
     let mut module = context.new_module("localip");
     let config: LocalipConfig = LocalipConfig::try_load(module.config);
 
+    // As we default to disabled=true, we have to check here after loading our config module,
+    // before it was only checking against whatever is in the config starship.toml
+    if config.disabled {
+        return None;
+    };
+
     let ssh_connection = context.get_env("SSH_CONNECTION");
     if config.ssh_only && ssh_connection.is_none() {
         return None;
@@ -86,6 +92,7 @@ mod tests {
             .config(toml::toml! {
                 [localip]
                 ssh_only = false
+                disabled = false
             })
             .collect();
         let expected = Some(format!("{} ", style().paint(localip)));
@@ -99,6 +106,7 @@ mod tests {
             .config(toml::toml! {
                 [localip]
                 ssh_only = true
+                disabled = false
             })
             .collect();
         let expected = None;
@@ -114,6 +122,7 @@ mod tests {
                 [localip]
                 ssh_only = true
                 trim_at = ""
+                disabled = false
             })
             .env("SSH_CONNECTION", "something")
             .collect();
@@ -122,6 +131,16 @@ mod tests {
         assert_eq!(expected, actual);
     }
 
+    #[test]
+    fn config_blank() {
+        let actual = ModuleRenderer::new("localip")
+            .env("SSH_CONNECTION", "something")
+            .collect();
+
+        let expected = None;
+        assert_eq!(expected, actual);
+    }
+
     fn style() -> Style {
         Color::Yellow.bold()
     }