Add more shells and customize hooks for devbox

Author: savil

internal/shell/README.md renamed to internal/shenv/README.md

@@ -1,4 +1,4 @@
-package shell
+package shenv
 
 import "fmt"
 
@@ -8,15 +8,15 @@ type bash struct{}
 var Bash Shell = bash{}
 
 const bashHook = `
-_direnv_hook() {
+_devbox_hook() {
   local previous_exit_status=$?;
   trap -- '' SIGINT;
-  eval "$("{{.SelfPath}}" export bash)";
+  eval "$(devbox shellenv --config {{ .ProjectDir }})";
   trap - SIGINT;
   return $previous_exit_status;
 };
-if ! [[ "${PROMPT_COMMAND:-}" =~ _direnv_hook ]]; then
-  PROMPT_COMMAND="_direnv_hook${PROMPT_COMMAND:+;$PROMPT_COMMAND}"
+if ! [[ "${PROMPT_COMMAND:-}" =~ _devbox_hook ]]; then
+  PROMPT_COMMAND="_devbox_hook${PROMPT_COMMAND:+;$PROMPT_COMMAND}"
 fi
 `
 
@@ -94,9 +94,13 @@ func BashEscape(str string) string {
 	if str == "" {
 		return "''"
 	}
+	// var too short
+	//nolint:varnamelen
 	in := []byte(str)
 	out := ""
 	i := 0
+	// var too short
+	//nolint:varnamelen
 	l := len(in)
 	escape := false
 

internal/shell/shell_bash.go renamed to internal/shenv/shell_bash.go

@@ -1,4 +1,4 @@
-package shell
+package shenv
 
 import (
 	"fmt"
@@ -11,29 +11,9 @@ type fish struct{}
 var Fish Shell = fish{}
 
 const fishHook = `
-    function __direnv_export_eval --on-event fish_prompt;
-        "{{.SelfPath}}" export fish | source;
-
-        if test "$direnv_fish_mode" != "disable_arrow";
-            function __direnv_cd_hook --on-variable PWD;
-                if test "$direnv_fish_mode" = "eval_after_arrow";
-                    set -g __direnv_export_again 0;
-                else;
-                    "{{.SelfPath}}" export fish | source;
-                end;
-            end;
-        end;
-    end;
-
-    function __direnv_export_eval_2 --on-event fish_preexec;
-        if set -q __direnv_export_again;
-            set -e __direnv_export_again;
-            "{{.SelfPath}}" export fish | source;
-            echo;
-        end;
-
-        functions --erase __direnv_cd_hook;
-    end;
+function __devbox_shellenv_eval --on-event fish_prompt;
+  devbox shellenv --config {{ .ProjectDir }} | source;
+end;
 `
 
 func (sh fish) Hook() (string, error) {
@@ -74,9 +54,13 @@ func (sh fish) unset(key string) string {
 }
 
 func (sh fish) escape(str string) string {
+	// var too short
+	//nolint:varnamelen
 	in := []byte(str)
 	out := "'"
 	i := 0
+	// var too short
+	//nolint:varnamelen
 	l := len(in)
 
 	hex := func(char byte) {

internal/shell/shell_fish.go renamed to internal/shenv/shell_fish.go

@@ -0,0 +1,30 @@
+package shenv
+
+type ksh struct{}
+
+// Ksh adds support the korn shell
+var Ksh Shell = ksh{}
+
+// um, this is ChatGPT writing it. I need to verify and test
+const kshHook = `
+_devbox_hook() {
+  eval "$(devbox shellenv --config {{ .ProjectDir }})";
+}
+if [[ "$(typeset -f precmd)" != *"_devbox_hook"* ]]; then
+  function precmd {
+    devbox_hook
+  }
+fi
+`
+
+func (sh ksh) Hook() (string, error) {
+	return kshHook, nil
+}
+
+func (sh ksh) Export(e ShellExport) (out string) {
+	panic("not implemented")
+}
+
+func (sh ksh) Dump(env Env) (out string) {
+	panic("not implemented")
+}

internal/shenv/shell_ksh.go

@@ -0,0 +1,34 @@
+package shenv
+
+type posix struct{}
+
+// Posix adds support for posix-compatible shells
+// Specifically, in the context of devbox, this includes
+// `dash`, `ash`, and `shell`
+var Posix Shell = posix{}
+
+// um, this is ChatGPT writing it. I need to verify and test
+const posixHook = `
+_devbox_hook() {
+  local previous_exit_status=$?
+  trap : INT
+  eval "$(devbox shellenv --config {{ .ProjectDir }})"
+  trap - INT
+  return $previous_exit_status
+}
+if [ -z "$PROMPT_COMMAND" ] || ! printf "%s" "$PROMPT_COMMAND" | grep -q "_devbox_hook"; then
+  PROMPT_COMMAND="_devbox_hook${PROMPT_COMMAND:+;$PROMPT_COMMAND}"
+fi
+`
+
+func (sh posix) Hook() (string, error) {
+	return posixHook, nil
+}
+
+func (sh posix) Export(e ShellExport) (out string) {
+	panic("not implemented")
+}
+
+func (sh posix) Dump(env Env) (out string) {
+	panic("not implemented")
+}

internal/shenv/shell_posix.go

@@ -0,0 +1,24 @@
+package shenv
+
+type unknown struct{}
+
+// UnknownSh adds support the unknown shell. This serves
+// as a fallback alternative to outright failure.
+var UnknownSh Shell = unknown{}
+
+const unknownHook = `
+echo "Warning: this shell will not update its environment. 
+Please exit and re-enter shell after making any changes that may affect the devbox generated environment.\n"
+`
+
+func (sh unknown) Hook() (string, error) {
+	return unknownHook, nil
+}
+
+func (sh unknown) Export(e ShellExport) (out string) {
+	panic("not implemented")
+}
+
+func (sh unknown) Dump(env Env) (out string) {
+	panic("not implemented")
+}

internal/shenv/shell_unknown.go

@@ -1,4 +1,4 @@
-package shell
+package shenv
 
 // ZSH is a singleton instance of ZSH_T
 type zsh struct{}
@@ -7,18 +7,14 @@ type zsh struct{}
 var Zsh Shell = zsh{}
 
 const zshHook = `
-_direnv_hook() {
+_devbox_hook() {
   trap -- '' SIGINT;
-  eval "$("{{.SelfPath}}" export zsh)";
+  eval "$(devbox shellenv --config {{ .ProjectDir }})";
   trap - SIGINT;
 }
 typeset -ag precmd_functions;
-if [[ -z "${precmd_functions[(r)_direnv_hook]+1}" ]]; then
-  precmd_functions=( _direnv_hook ${precmd_functions[@]} )
-fi
-typeset -ag chpwd_functions;
-if [[ -z "${chpwd_functions[(r)_direnv_hook]+1}" ]]; then
-  chpwd_functions=( _direnv_hook ${chpwd_functions[@]} )
+if [[ -z "${precmd_functions[(r)_devbox_hook]+1}" ]]; then
+  precmd_functions=( _devbox_hook ${precmd_functions[@]} )
 fi
 `
 

internal/shell/shell_zsh.go renamed to internal/shenv/shell_zsh.go

@@ -1,8 +1,4 @@
-package shell
-
-import (
-	"path/filepath"
-)
+package shenv
 
 type Env map[string]string
 
@@ -33,36 +29,21 @@ func (e ShellExport) Remove(key string) {
 	e[key] = nil
 }
 
-// DetectShell returns a Shell instance from the given target.
-//
-// target is usually $0 and can also be prefixed by `-`
+// DetectShell returns a Shell instance from the given shell name
+// TODO: use a single common "enum" for both shenv and DevboxShell
 func DetectShell(target string) Shell {
-	target = filepath.Base(target)
-	// $0 starts with "-"
-	if target[0:1] == "-" {
-		target = target[1:]
-	}
-
 	switch target {
 	case "bash":
 		return Bash
-	//case "elvish":
-	//	return Elvish
 	case "fish":
 		return Fish
-	//case "gha":
-	//	return GitHubActions
-	//case "gzenv":
-	//	return GzEnv
-	//case "json":
-	//	return JSON
-	//case "tcsh":
-	//	return Tcsh
-	//case "vim":
-	//	return Vim
+	case "ksh":
+		return Ksh
+	case "posix":
+		return Posix
 	case "zsh":
 		return Zsh
+	default:
+		return UnknownSh
 	}
-
-	return nil
 }