add support for fish and tcsh shells

cli/flox-rust-sdk/src/models/environment/path_environment.rs

@@ -78,6 +78,8 @@ pub struct InitCustomization {
     pub hook_on_activate: Option<String>,
     pub profile_common: Option<String>,
     pub profile_bash: Option<String>,
+    pub profile_fish: Option<String>,
+    pub profile_tcsh: Option<String>,
     pub profile_zsh: Option<String>,
     pub packages: Option<Vec<PackageToInstall>>,
 }

cli/flox-rust-sdk/src/models/manifest.rs

@@ -139,14 +139,16 @@ impl RawManifest {
             # Scripts defined in the `[profile]` section are *sourced* by *your shell* and
             # inherit environment variables set in the `[vars]` section and by `[hook]` scripts.
             # The `profile.common` script is sourced by all shells and special care should be
-            # taken to ensure compatibility with all shells. The `profile.bash` and `profile.zsh`
-            # scripts are then sourced by the corresponding shell.
+            # taken to ensure compatibility with all shells, after which exactly one of
+            # `profile.{bash,fish,tcsh,zsh}` is sourced by the corresponding shell.
         "#});
 
         match customization {
             InitCustomization {
                 profile_common: None,
                 profile_bash: None,
+                profile_fish: None,
+                profile_tcsh: None,
                 profile_zsh: None,
                 ..
             } => {
@@ -170,6 +172,18 @@ impl RawManifest {
                         toml_edit::value(indent::indent_all_by(2, profile_bash)),
                     );
                 }
+                if let Some(profile_fish) = &customization.profile_fish {
+                    profile_table.insert(
+                        "fish",
+                        toml_edit::value(indent::indent_all_by(2, profile_fish)),
+                    );
+                }
+                if let Some(profile_tcsh) = &customization.profile_tcsh {
+                    profile_table.insert(
+                        "tcsh",
+                        toml_edit::value(indent::indent_all_by(2, profile_tcsh)),
+                    );
+                }
                 if let Some(profile_zsh) = &customization.profile_zsh {
                     profile_table.insert(
                         "zsh",
@@ -863,6 +877,8 @@ pub(super) mod test {
             hook_on_activate: None,
             profile_common: None,
             profile_bash: None,
+            profile_fish: None,
+            profile_tcsh: None,
             profile_zsh: None,
             packages: None,
         };
@@ -905,8 +921,8 @@ pub(super) mod test {
             # Scripts defined in the `[profile]` section are *sourced* by *your shell* and
             # inherit environment variables set in the `[vars]` section and by `[hook]` scripts.
             # The `profile.common` script is sourced by all shells and special care should be
-            # taken to ensure compatibility with all shells. The `profile.bash` and `profile.zsh`
-            # scripts are then sourced by the corresponding shell.
+            # taken to ensure compatibility with all shells, after which exactly one of
+            # `profile.{bash,fish,tcsh,zsh}` is sourced by the corresponding shell.
             [profile]
             # common = """
             #   echo "it's gettin' flox in here"
@@ -929,6 +945,8 @@ pub(super) mod test {
             hook_on_activate: None,
             profile_common: None,
             profile_bash: None,
+            profile_fish: None,
+            profile_tcsh: None,
             profile_zsh: None,
             packages: Some(vec![]),
         };
@@ -972,8 +990,8 @@ pub(super) mod test {
             # Scripts defined in the `[profile]` section are *sourced* by *your shell* and
             # inherit environment variables set in the `[vars]` section and by `[hook]` scripts.
             # The `profile.common` script is sourced by all shells and special care should be
-            # taken to ensure compatibility with all shells. The `profile.bash` and `profile.zsh`
-            # scripts are then sourced by the corresponding shell.
+            # taken to ensure compatibility with all shells, after which exactly one of
+            # `profile.{bash,fish,tcsh,zsh}` is sourced by the corresponding shell.
             [profile]
             # common = """
             #   echo "it's gettin' flox in here"
@@ -996,6 +1014,8 @@ pub(super) mod test {
             hook_on_activate: None,
             profile_common: None,
             profile_bash: None,
+            profile_fish: None,
+            profile_tcsh: None,
             profile_zsh: None,
             packages: Some(vec![PackageToInstall {
                 id: "python3".to_string(),
@@ -1042,8 +1062,8 @@ pub(super) mod test {
             # Scripts defined in the `[profile]` section are *sourced* by *your shell* and
             # inherit environment variables set in the `[vars]` section and by `[hook]` scripts.
             # The `profile.common` script is sourced by all shells and special care should be
-            # taken to ensure compatibility with all shells. The `profile.bash` and `profile.zsh`
-            # scripts are then sourced by the corresponding shell.
+            # taken to ensure compatibility with all shells, after which exactly one of
+            # `profile.{bash,fish,tcsh,zsh}` is sourced by the corresponding shell.
             [profile]
             # common = """
             #   echo "it's gettin' flox in here"
@@ -1075,6 +1095,8 @@ pub(super) mod test {
             ),
             profile_common: None,
             profile_bash: None,
+            profile_fish: None,
+            profile_tcsh: None,
             profile_zsh: None,
             packages: None,
         };
@@ -1116,8 +1138,8 @@ pub(super) mod test {
             # Scripts defined in the `[profile]` section are *sourced* by *your shell* and
             # inherit environment variables set in the `[vars]` section and by `[hook]` scripts.
             # The `profile.common` script is sourced by all shells and special care should be
-            # taken to ensure compatibility with all shells. The `profile.bash` and `profile.zsh`
-            # scripts are then sourced by the corresponding shell.
+            # taken to ensure compatibility with all shells, after which exactly one of
+            # `profile.{bash,fish,tcsh,zsh}` is sourced by the corresponding shell.
             [profile]
             # common = """
             #   echo "it's gettin' flox in here"
@@ -1145,6 +1167,8 @@ pub(super) mod test {
                 .to_string(),
             ),
             profile_bash: None,
+            profile_fish: None,
+            profile_tcsh: None,
             profile_zsh: None,
             packages: None,
         };
@@ -1187,8 +1211,8 @@ pub(super) mod test {
             # Scripts defined in the `[profile]` section are *sourced* by *your shell* and
             # inherit environment variables set in the `[vars]` section and by `[hook]` scripts.
             # The `profile.common` script is sourced by all shells and special care should be
-            # taken to ensure compatibility with all shells. The `profile.bash` and `profile.zsh`
-            # scripts are then sourced by the corresponding shell.
+            # taken to ensure compatibility with all shells, after which exactly one of
+            # `profile.{bash,fish,tcsh,zsh}` is sourced by the corresponding shell.
             [profile]
             common = """
               echo \"Hello from Flox\"

cli/flox/doc-catalog/manifest.toml.md

@@ -272,8 +272,8 @@ Scripts defined in the `[profile]` section are sourced by *your shell* and
 inherit environment variables set in the `[vars]` section and by the `[hook]`
 scripts.
 The `profile.common` script is sourced for every shell,
-and special care should be taken to ensure compatibility with all shells.
-The `profile.<shell>` scripts are then sourced *after* `profile.common` by the
+and special care should be taken to ensure compatibility with all shells,
+after which exactly one of `profile.{bash,fish,tcsh,zsh}` is sourced by the
 corresponding shell.
 
 These scripts are useful for performing shell-specific customizations such as

cli/flox/doc/flox-activate.md

@@ -38,7 +38,7 @@ and adds `bin` directories to your `$PATH`.
   Flox will determine the parent shell from `$FLOX_SHELL` or otherwise
   automatically determine the parent shell and fall back to `$SHELL`.
 
-`flox activate` currently only supports `bash` and `zsh` shells
+`flox activate` currently supports `bash`, `fish`, `tcsh` and `zsh` shells
 for any of the detection mechanisms described above.
 
 When invoked interactively,

cli/flox/doc/flox.md

@@ -26,7 +26,7 @@ making them portable across the full software lifecycle.
 
 ## Command Line Completions
 
-Flox ships with command line completions for `bash`, `zsh` and `fish`.
+Flox ships with command line completions for `bash`, `fish` and `zsh`.
 These completions are installed alongside Flox.
 
 # OPTIONS

cli/flox/doc/manifest.toml.md

@@ -312,8 +312,8 @@ Scripts defined in the `[profile]` section are sourced by *your shell* and
 inherit environment variables set in the `[vars]` section and by the `[hook]`
 scripts.
 The `profile.common` script is sourced for every shell,
-and special care should be taken to ensure compatibility with all shells.
-The `profile.<shell>` scripts are then sourced *after* `profile.common` by the
+and special care should be taken to ensure compatibility with all shells,
+after which exactly one of `profile.{bash,fish,tcsh,zsh}` is sourced by the
 corresponding shell.
 
 These scripts are useful for performing shell-specific customizations such as
@@ -329,6 +329,11 @@ bash = """
     alias foo="echo bar"
     set -o vi
 """
+fish = """
+    source $venv_dir/bin/activate.fish
+    alias foo="echo bar"
+    fish_vi_key_bindings
+"""
 zsh = """
     source $venv_dir/bin/activate
     alias foo="echo bar"

cli/flox/src/commands/activate.rs

@@ -6,7 +6,7 @@ use std::os::unix::process::CommandExt;
 use std::path::{Path, PathBuf};
 use std::process::Command;
 
-use anyhow::{bail, Context, Result};
+use anyhow::{anyhow, bail, Context, Result};
 use bpaf::Bpaf;
 use crossterm::tty::IsTty;
 use flox_rust_sdk::flox::{Flox, DEFAULT_NAME};
@@ -365,6 +365,12 @@ impl Activate {
                     .arg("--rcfile")
                     .arg(activation_path.join("activate").join("bash"));
             },
+            Shell::Fish(_) => {
+                return Err(anyhow!("fish not supported with environments rendered before version 1.0.5; please update environment and try again"));
+            },
+            Shell::Tcsh(_) => {
+                return Err(anyhow!("tcsh not supported with environments rendered before version 1.0.5; please update environment and try again"));
+            },
             Shell::Zsh(_) => {
                 // From man zsh:
                 // Commands are then read from $ZDOTDIR/.zshenv.  If the shell is a
@@ -516,6 +522,8 @@ impl Activate {
             .map(|(key, value)| (key, shell_escape::escape(Cow::Borrowed(value))))
             .map(|(key, value)| match shell {
                 Shell::Bash(_) => format!("export {key}={value};",),
+                Shell::Fish(_) => format!("set -gx {key} {value};",),
+                Shell::Tcsh(_) => format!("setenv {key} {value};",),
                 Shell::Zsh(_) => format!("export {key}={value};",),
             })
             .join("\n");
@@ -533,15 +541,15 @@ impl Activate {
     /// Quote run args so that words don't get split,
     /// but don't escape all characters.
     ///
-    /// To do this we escape `"`,
+    /// To do this we escape '"' and '`',
     /// but we don't escape anything else.
-    /// We want `$` for example to be expanded by the shell.
+    /// We want '$' for example to be expanded by the shell.
     fn quote_run_args(run_args: &[String]) -> String {
         run_args
             .iter()
             .map(|arg| {
-                if arg.contains(' ') || arg.contains('"') {
-                    format!(r#""{}""#, arg.replace('"', r#"\""#))
+                if arg.contains(' ') || arg.contains('"') || arg.contains('`') {
+                    format!(r#""{}""#, arg.replace('"', r#"\""#).replace('`', r#"\`"#))
                 } else {
                     arg.to_string()
                 }

cli/flox/src/commands/init/go.rs

@@ -140,6 +140,8 @@ impl InitHook for Go {
             hook_on_activate: Some(GO_HOOK.to_string()),
             profile_common: None,
             profile_bash: None,
+            profile_fish: None,
+            profile_tcsh: None,
             profile_zsh: None,
             packages: Some(vec![PackageToInstall {
                 id: "go".to_string(),

cli/flox/src/commands/init/mod.rs

@@ -245,6 +245,8 @@ impl Init {
         let mut custom_hook_on_activate_scripts: Vec<String> = vec![];
         let mut custom_profile_common_scripts: Vec<String> = vec![];
         let mut custom_profile_bash_scripts: Vec<String> = vec![];
+        let mut custom_profile_fish_scripts: Vec<String> = vec![];
+        let mut custom_profile_tcsh_scripts: Vec<String> = vec![];
         let mut custom_profile_zsh_scripts: Vec<String> = vec![];
         // Deduplicate packages with a set
         let mut packages_set = HashSet::<PackageToInstall>::new();
@@ -261,6 +263,12 @@ impl Init {
             if let Some(profile_bash_script) = customization.profile_bash {
                 custom_profile_bash_scripts.push(profile_bash_script)
             }
+            if let Some(profile_fish_script) = customization.profile_fish {
+                custom_profile_fish_scripts.push(profile_fish_script)
+            }
+            if let Some(profile_tcsh_script) = customization.profile_tcsh {
+                custom_profile_tcsh_scripts.push(profile_tcsh_script)
+            }
             if let Some(profile_zsh_script) = customization.profile_zsh {
                 custom_profile_zsh_scripts.push(profile_zsh_script)
             }
@@ -294,6 +302,22 @@ impl Init {
                 # End autogenerated by Flox
                 ", custom_profile_bash_scripts.join("\n\n")}
         });
+        let custom_profile_fish = (!custom_profile_fish_scripts.is_empty()).then(|| {
+            formatdoc! {"
+                # Autogenerated by Flox
+
+                {}
+
+                # End autogenerated by Flox", custom_profile_fish_scripts.join("\n\n")}
+        });
+        let custom_profile_tcsh = (!custom_profile_tcsh_scripts.is_empty()).then(|| {
+            formatdoc! {"
+                # Autogenerated by Flox
+
+                {}
+
+                # End autogenerated by Flox", custom_profile_tcsh_scripts.join("\n\n")}
+        });
         let custom_profile_zsh = (!custom_profile_zsh_scripts.is_empty()).then(|| {
             formatdoc! {"
                 # Autogenerated by Flox
@@ -311,6 +335,8 @@ impl Init {
             hook_on_activate: custom_hook_on_activate,
             profile_common: custom_profile_common,
             profile_bash: custom_profile_bash,
+            profile_fish: custom_profile_fish,
+            profile_tcsh: custom_profile_tcsh,
             profile_zsh: custom_profile_zsh,
             packages,
         }
@@ -379,6 +405,22 @@ fn format_customization(customization: &InitCustomization) -> Result<String> {
             "#, indent::indent_all_by(2, profile_bash_script)}))),
         );
     };
+    if let Some(profile_fish_script) = &customization.profile_fish {
+        profile_table.insert(
+            "fish",
+            Item::Value(Value::String(Formatted::new(formatdoc! {r#"
+                {}
+            "#, indent::indent_all_by(2, profile_fish_script)}))),
+        );
+    };
+    if let Some(profile_tcsh_script) = &customization.profile_tcsh {
+        profile_table.insert(
+            "tcsh",
+            Item::Value(Value::String(Formatted::new(formatdoc! {r#"
+                {}
+            "#, indent::indent_all_by(2, profile_tcsh_script)}))),
+        );
+    };
     if let Some(profile_zsh_script) = &customization.profile_zsh {
         profile_table.insert(
             "zsh",
@@ -830,6 +872,8 @@ mod tests {
                 hook_on_activate: Some("hook_on_activate1".to_string()),
                 profile_common: Some("profile_common1".to_string()),
                 profile_bash: Some("profile_bash1".to_string()),
+                profile_fish: Some("profile_fish1".to_string()),
+                profile_tcsh: Some("profile_tcsh1".to_string()),
                 profile_zsh: Some("profile_zsh1".to_string()),
                 packages: Some(vec![
                     PackageToInstall {
@@ -850,6 +894,8 @@ mod tests {
                 hook_on_activate: Some("hook_on_activate2".to_string()),
                 profile_common: Some("profile_common2".to_string()),
                 profile_bash: Some("profile_bash2".to_string()),
+                profile_fish: Some("profile_fish2".to_string()),
+                profile_tcsh: Some("profile_tcsh2".to_string()),
                 profile_zsh: Some("profile_zsh2".to_string()),
                 packages: Some(vec![
                     PackageToInstall {
@@ -908,6 +954,28 @@ mod tests {
                 "#}
                 .to_string()
             ),
+            profile_fish: Some(
+                indoc! {r#"
+                        # Autogenerated by Flox
+
+                        profile_fish1
+
+                        profile_fish2
+
+                        # End autogenerated by Flox"#}
+                .to_string()
+            ),
+            profile_tcsh: Some(
+                indoc! {r#"
+                        # Autogenerated by Flox
+
+                        profile_tcsh1
+
+                        profile_tcsh2
+
+                        # End autogenerated by Flox"#}
+                .to_string()
+            ),
             profile_zsh: Some(
                 indoc! {r#"
                         # Autogenerated by Flox