feat(shell): Parameterize binary names in shell integration scripts

- Add {{CLI_BINARY_NAME}} and {{PTY_BINARY_NAME}} placeholders to all shell scripts
- Update pre.sh, pre.fish, pre.nu to use placeholders
- Update post.bash, post.fish, post.zsh, post.nu to use placeholders
- Modify get_fig_integration_source() to return String and perform substitution
- Replace hardcoded 'q' and 'qterm' with constants from fig_util::consts
- Remove unnecessary .into() call in init.rs

This enables easy rebranding by changing constants in one place.

Author: kkashilk

crates/fig_integrations/src/shell/mod.rs

@@ -12,6 +12,7 @@ use fig_os_shim::Env;
 use fig_util::{
     CLI_BINARY_NAME,
     PRODUCT_NAME,
+    PTY_BINARY_NAME,
     Shell,
     directories,
 };
@@ -97,7 +98,7 @@ pub trait ShellExt {
     fn get_shell_integrations(&self, env: &Env) -> Result<Vec<Box<dyn ShellIntegration>>>;
     /// Script integrations are installed into ~/.fig/shell
     fn get_script_integrations(&self) -> Result<Vec<ShellScriptShellIntegration>>;
-    fn get_fig_integration_source(&self, when: &When) -> &'static str;
+    fn get_fig_integration_source(&self, when: &When) -> String;
 }
 
 impl ShellExt for Shell {
@@ -186,8 +187,8 @@ impl ShellExt for Shell {
         Ok(integrations)
     }
 
-    fn get_fig_integration_source(&self, when: &When) -> &'static str {
-        match (self, when) {
+    fn get_fig_integration_source(&self, when: &When) -> String {
+        let script = match (self, when) {
             (Shell::Fish, When::Pre) => include_str!("scripts/pre.fish"),
             (Shell::Fish, When::Post) => include_str!("scripts/post.fish"),
             (Shell::Zsh, When::Pre) => include_str!("scripts/pre.sh"),
@@ -216,7 +217,11 @@ impl ShellExt for Shell {
             },
             (Shell::Nu, When::Pre) => include_str!("scripts/pre.nu"),
             (Shell::Nu, When::Post) => include_str!("scripts/post.nu"),
-        }
+        };
+
+        script
+            .replace("{{CLI_BINARY_NAME}}", CLI_BINARY_NAME)
+            .replace("{{PTY_BINARY_NAME}}", PTY_BINARY_NAME)
     }
 }
 
@@ -814,7 +819,7 @@ mod test {
     }
 
     fn check_script(shell: Shell, when: When) {
-        run_shellcheck(shell.get_fig_integration_source(&when).to_owned());
+        run_shellcheck(shell.get_fig_integration_source(&when));
     }
 
     #[test]

crates/fig_integrations/src/shell/scripts/post.bash

@@ -17,7 +17,7 @@ Q_LAST_PS2="$PS2"
 Q_LAST_PS3="$PS3"
 
 if [[ -z "${Q_SHELL:-}" ]]; then
-  Q_SHELL=$(q _ get-shell)
+  Q_SHELL=$({{CLI_BINARY_NAME}} _ get-shell)
 fi
 
 # Construct Operating System Command.
@@ -68,8 +68,8 @@ function __fig_pre_prompt () {
   fig_osc "Log=%s" "${Q_LOG_LEVEL}"
   fig_osc "User=%s" "${USER:-root}"
 
-  if command -v q >/dev/null 2>&1; then
-    (command q _ pre-cmd --alias "$(\alias)" > /dev/null 2>&1 &) >/dev/null 2>&1
+  if command -v {{CLI_BINARY_NAME}} >/dev/null 2>&1; then
+    (command {{CLI_BINARY_NAME}} _ pre-cmd --alias "$(\alias)" > /dev/null 2>&1 &) >/dev/null 2>&1
   fi
 
   # Work around bug in CentOS 7.2 where preexec doesn't run if you press ^C
@@ -180,4 +180,4 @@ fi
 
 fi
 
-(command q _ pre-cmd --alias "$(\alias)" > /dev/null 2>&1 &) >/dev/null 2>&1
+(command {{CLI_BINARY_NAME}} _ pre-cmd --alias "$(\alias)" > /dev/null 2>&1 &) >/dev/null 2>&1

crates/fig_integrations/src/shell/scripts/post.fish

@@ -6,7 +6,7 @@ set --export TTY
 
 set --export SHELL_PID $fish_pid
 
-set --query Q_SHELL; or set Q_SHELL (q _ get-shell)
+set --query Q_SHELL; or set Q_SHELL ({{CLI_BINARY_NAME}} _ get-shell)
 
 function fig_osc
     builtin printf "\033]697;$argv[1]\007" $argv[2..-1]
@@ -98,8 +98,8 @@ function fig_precmd --on-event fish_prompt
 
     set fig_has_set_prompt 1
 
-    if command -v q &>/dev/null
-        begin; command q _ pre-cmd --alias (alias) &> /dev/null &; end
+    if command -v {{CLI_BINARY_NAME}} &>/dev/null
+        begin; command {{CLI_BINARY_NAME}} _ pre-cmd --alias (alias) &> /dev/null &; end
     end
 end
 
@@ -109,4 +109,4 @@ if test -n "$PROCESS_LAUNCHED_BY_Q"
     fig_osc DoneSourcing
 end
 
-begin; command q _ pre-cmd --alias (alias) &> /dev/null &; end
+begin; command {{CLI_BINARY_NAME}} _ pre-cmd --alias (alias) &> /dev/null &; end

crates/fig_integrations/src/shell/scripts/post.nu

@@ -7,7 +7,7 @@ def pathadd [path: string] {
 }
 
 let-env PATH = pathadd $"($env.HOME)/.local/bin"
-let-env Q_SHELL = (^q _ get-shell)
+let-env Q_SHELL = (^{{CLI_BINARY_NAME}} _ get-shell)
 
 let-env PATH = $env.PATH
 
@@ -143,7 +143,7 @@ def-env fig_pre_prompt_hook [] {
     # }
 
     if (which fig | length) >= 1 {
-      let result = (q _ pre-cmd | complete)
+      let result = ({{CLI_BINARY_NAME}} _ pre-cmd | complete)
       if $result.stdout == "EXEC_NEW_SHELL" {
         let-env Q_DOTFILES_SOURCED = $nothing
         exec nu
@@ -208,4 +208,4 @@ if "PROCESS_LAUNCHED_BY_Q" in $env {
   print_fig_osc "DoneSourcing"
 }
 
-(^q _ pre-cmd | complete | ignore)
+(^{{CLI_BINARY_NAME}} _ pre-cmd | complete | ignore)

crates/fig_integrations/src/shell/scripts/post.zsh

@@ -13,7 +13,7 @@ export TTY
 export SHELL_PID="$$"
 
 if [[ -z "${Q_SHELL:-}" ]]; then
-  Q_SHELL=$(q _ get-shell)
+  Q_SHELL=$({{CLI_BINARY_NAME}} _ get-shell)
 fi
 
 # shellcheck disable=SC2059
@@ -165,8 +165,8 @@ fig_precmd() {
 
   Q_HAS_SET_PROMPT=1
 
-  if command -v q >/dev/null 2>&1; then
-    (command q _ pre-cmd --alias "$(\alias)" > /dev/null 2>&1 &) >/dev/null 2>&1
+  if command -v {{CLI_BINARY_NAME}} >/dev/null 2>&1; then
+    (command {{CLI_BINARY_NAME}} _ pre-cmd --alias "$(\alias)" > /dev/null 2>&1 &) >/dev/null 2>&1
   fi
 }
 
@@ -190,4 +190,4 @@ fi
 
 fi
 
-(command q _ pre-cmd --alias "$(\alias)" > /dev/null 2>&1 &) >/dev/null 2>&1
+(command {{CLI_BINARY_NAME}} _ pre-cmd --alias "$(\alias)" > /dev/null 2>&1 &) >/dev/null 2>&1

crates/fig_integrations/src/shell/scripts/pre.fish

@@ -16,31 +16,31 @@ end
 
 if test -z "$SHOULD_QTERM_LAUNCH"
     # 0 = Yes, 1 = No, 2 = Fallback to Q_TERM
-    q _ should-figterm-launch 1>/dev/null 2>&1
+    {{CLI_BINARY_NAME}} _ should-figterm-launch 1>/dev/null 2>&1
     set SHOULD_QTERM_LAUNCH $status
 end
 
 if test -t 1
     and test -z "$PROCESS_LAUNCHED_BY_Q"
-    and command -v qterm 1>/dev/null 2>/dev/null
+    and command -v {{PTY_BINARY_NAME}} 1>/dev/null 2>/dev/null
     and test "$SHOULD_QTERM_LAUNCH" -eq 0 -o \( "$SHOULD_QTERM_LAUNCH" -eq 2 -a \( -z "$Q_TERM" -o \( -z "$Q_TERM_TMUX" -a -n "$TMUX" \) \) \)
 
     if test -z "$Q_SHELL"
-        set Q_SHELL (q _ get-shell)
+        set Q_SHELL ({{CLI_BINARY_NAME}} _ get-shell)
     end
     set Q_IS_LOGIN_SHELL 0
     if status --is-login
         set Q_IS_LOGIN_SHELL 1
     end
 
-    # Do not launch qterm in non-interactive shells (like VSCode Tasks)
+    # Do not launch {{PTY_BINARY_NAME}} in non-interactive shells (like VSCode Tasks)
     if status --is-interactive
-        set Q_TERM_NAME (command basename "$Q_SHELL")" (qterm)"
+        set Q_TERM_NAME (command basename "$Q_SHELL")" ({{PTY_BINARY_NAME}})"
         if not set -q Q_TERM_PATH
             if test -x "$HOME/.local/bin/$Q_TERM_NAME"
                 set Q_TERM_PATH "$HOME/.local/bin/$Q_TERM_NAME"
             else
-                set Q_TERM_PATH (command -v qterm || echo "$HOME/.local/bin/qterm")
+                set Q_TERM_PATH (command -v {{PTY_BINARY_NAME}} || echo "$HOME/.local/bin/{{PTY_BINARY_NAME}}")
             end
         end
 

crates/fig_integrations/src/shell/scripts/pre.nu

@@ -26,7 +26,7 @@ if "Q_SET_PARENT_CHECK" not-in $env {
 }
 
 
-let result = (^q _ should-figterm-launch | complete)
+let result = (^{{CLI_BINARY_NAME}} _ should-figterm-launch | complete)
 let-env SHOULD_QTERM_LAUNCH = $result.exit_code
 
 let should_launch = (
@@ -36,7 +36,7 @@ let should_launch = (
 )
 
 if $should_launch {
-  let Q_SHELL = (q _ get-shell | complete).stdout
+  let Q_SHELL = ({{CLI_BINARY_NAME}} _ get-shell | complete).stdout
 
   let fig_term_name = "nu (figterm)"
   let figterm_path = if ([$env.HOME ".fig" "bin" $fig_term_name] | path join | path exists) {

crates/fig_integrations/src/shell/scripts/pre.sh

@@ -24,7 +24,7 @@ fi
 
 # 0 = Yes, 1 = No, 2 = Fallback to Q_TERM
 if [ -z "${SHOULD_QTERM_LAUNCH:-}" ]; then
-  q _ should-figterm-launch 1>/dev/null 2>&1
+  {{CLI_BINARY_NAME}} _ should-figterm-launch 1>/dev/null 2>&1
   SHOULD_QTERM_LAUNCH=$?
 fi
 
@@ -33,12 +33,12 @@ fi
 # It is not necessary in Fish.
 if   [[ -t 1 ]] \
   && [[ -z "${PROCESS_LAUNCHED_BY_Q:-}" ]] \
-  && command -v qterm 1>/dev/null 2>&1 \
+  && command -v {{PTY_BINARY_NAME}} 1>/dev/null 2>&1 \
   && [[ ("${SHOULD_QTERM_LAUNCH}" -eq 0) || (("${SHOULD_QTERM_LAUNCH}" -eq 2) && (-z "${Q_TERM:-}" || (-z "${Q_TERM_TMUX:-}" && -n "${TMUX:-}"))) ]]
 then
   # Pty module sets Q_TERM or Q_TERM_TMUX to avoid running twice.
   if [ -z "${Q_SHELL:-}" ]; then
-    Q_SHELL=$(q _ get-shell)
+    Q_SHELL=$({{CLI_BINARY_NAME}} _ get-shell)
   fi
   Q_IS_LOGIN_SHELL="${Q_IS_LOGIN_SHELL:='0'}"
 
@@ -50,12 +50,12 @@ then
 
   # Do not launch figterm in non-interactive shells (like VSCode Tasks)
   if [[ $- == *i* ]]; then
-    Q_TERM_NAME="$(basename "${Q_SHELL}") (qterm)"
+    Q_TERM_NAME="$(basename "${Q_SHELL}") ({{PTY_BINARY_NAME}})"
     if [[ -z "${Q_TERM_PATH:-}" ]]; then
       if [[ -x "${HOME}/.local/bin/${Q_TERM_NAME}" ]]; then
         Q_TERM_PATH="${HOME}/.local/bin/${Q_TERM_NAME}"
       else
-        Q_TERM_PATH="$(command -v qterm || echo "${HOME}/.local/bin/qterm")"
+        Q_TERM_PATH="$(command -v {{PTY_BINARY_NAME}} || echo "${HOME}/.local/bin/{{PTY_BINARY_NAME}}")"
       fi
     fi
 

crates/q_cli/src/cli/init.rs

@@ -204,7 +204,7 @@ async fn shell_init(shell: &Shell, when: &When, rcfile: &Option<String>) -> Resu
     }
 
     let shell_integration_source = shell.get_fig_integration_source(when);
-    to_source.push(shell_integration_source.into());
+    to_source.push(shell_integration_source);
 
     if when == &When::Pre && is_jetbrains_terminal {
         // Manually call JetBrains shell integration after exec-ing to figterm.