feat(shell): detecting VSCode shell startup to prevent hook issues (#560)

Author: bytemain

cmd/commands/activate.go

@@ -27,6 +27,7 @@ import (
 
 	"github.com/urfave/cli/v3"
 	"github.com/version-fox/vfox/internal/env"
+	"github.com/version-fox/vfox/internal/logger"
 	"github.com/version-fox/vfox/internal/shell"
 )
 
@@ -58,15 +59,22 @@ func activateCmd(ctx context.Context, cmd *cli.Command) error {
 
 	exportEnvs := sdkEnvs.ToExportEnvs()
 
-	exportEnvs[env.HookFlag] = &name
-	exportEnvs[internal.HookCurTmpPath] = &manager.PathMeta.CurTmpPath
+	// Current shell is not for user use, it will be killed after the activation.
+	// If we setup hook in this shell, it will cause all terminal launched by IDE could not be hooked properly.
+	if !env.IsIDEEnvironmentResolution() {
+		exportEnvs[env.HookFlag] = &name
+		exportEnvs[internal.HookCurTmpPath] = &manager.PathMeta.CurTmpPath
+	}
+
+	logger.Debugf("export envs: %+v", exportEnvs)
 
 	path := manager.PathMeta.ExecutablePath
 	path = strings.Replace(path, "\\", "/", -1)
 	s := shell.NewShell(name)
 	if s == nil {
 		return fmt.Errorf("unknown target shell %s", name)
 	}
+
 	exportStr := s.Export(exportEnvs)
 	str, err := s.Activate(
 		shell.ActivateConfig{

internal/env/env.go

@@ -37,3 +37,11 @@ type Envs struct {
 	BinPaths  *Paths
 	Paths     *Paths
 }
+
+func (e *Envs) MergePaths(envs *Envs) {
+	if envs == nil {
+		return
+	}
+	e.BinPaths.Merge(envs.BinPaths)
+	e.Paths.Merge(envs.Paths)
+}

internal/env/flag.go

@@ -35,11 +35,30 @@ func IsHookEnv() bool {
 	return os.Getenv(HookFlag) != ""
 }
 
+// IsIDEEnvironmentResolution detects if the current shell session was launched by an IDE
+// for the purpose of environment variable resolution. This is useful to avoid certain
+// shell initialization behaviors that might interfere with IDE environment detection.
+//
+// Supported IDEs:
+//   - Visual Studio Code: Detects via VSCODE_RESOLVING_ENVIRONMENT environment variable
+//     Reference: https://code.visualstudio.com/docs/configure/command-line#_how-do-i-detect-when-a-shell-was-launched-by-vs-code
+//   - JetBrains IDEs (IntelliJ IDEA, PyCharm, etc.): Detects via INTELLIJ_ENVIRONMENT_READER environment variable
+//     Reference: https://youtrack.jetbrains.com/articles/SUPPORT-A-1727/Shell-Environment-Loading
+//
+// Returns true if any of the supported IDE environment resolution indicators are present.
+func IsIDEEnvironmentResolution() bool {
+	return os.Getenv("VSCODE_RESOLVING_ENVIRONMENT") != "" ||
+		os.Getenv("INTELLIJ_ENVIRONMENT_READER") != ""
+}
+
 func GetPid() int {
-	if pid := os.Getenv(PidFlag); pid != "" {
-		p, _ := strconv.Atoi(pid) // Convert pid from string to int
-		return p
+	if IsHookEnv() {
+		if pid := os.Getenv(PidFlag); pid != "" {
+			p, _ := strconv.Atoi(pid) // Convert pid from string to int
+			return p
+		}
 	}
+
 	return os.Getppid()
 }
 

internal/env/path.go

@@ -18,11 +18,12 @@ package env
 
 import (
 	"fmt"
-	"github.com/version-fox/vfox/internal/logger"
-	"github.com/version-fox/vfox/internal/util"
 	"os"
 	"path/filepath"
 	"strings"
+
+	"github.com/version-fox/vfox/internal/logger"
+	"github.com/version-fox/vfox/internal/util"
 )
 
 type PathFrom int
@@ -38,6 +39,9 @@ type Paths struct {
 }
 
 func (p *Paths) Merge(other *Paths) *Paths {
+	if other == nil {
+		return p
+	}
 	for _, path := range other.Slice() {
 		p.Add(path)
 	}

internal/sdk.go

@@ -165,15 +165,15 @@ func (b *Sdk) Install(version base.Version) error {
 	pterm.Printf("Install %s success! \n", pterm.LightGreen(label))
 	useCommand := fmt.Sprintf("vfox use %s", label)
 	pterm.Printf("Please use `%s` to use it.\n", pterm.LightBlue(useCommand))
-	
+
 	// Copy command to clipboard in TTY mode
 	if util.IsTTY() {
 		if err := util.CopyToClipboard(useCommand); err == nil {
 			pterm.Printf("%s\n", pterm.LightYellow("Copied to clipboard, you can paste it now."))
 		}
 		// Silently ignore clipboard errors (not supported, utility not found, etc.)
 	}
-	
+
 	return nil
 }
 
@@ -347,6 +347,18 @@ func (b *Sdk) EnvKeys(version base.Version, location base.Location) (*env.Envs,
 	if err != nil {
 		return nil, fmt.Errorf("plugin [EnvKeys] error: err:%w", err)
 	}
+
+	if env.IsIDEEnvironmentResolution() {
+		// current shell will be killed after the activation,
+		// so we need to run into something like `shims` mode.
+		rawKeys, err := b.Plugin.EnvKeys(linkPackage.from)
+		if err != nil {
+			return nil, fmt.Errorf("plugin [EnvKeys] error: err:%w", err)
+		}
+
+		keys.MergePaths(rawKeys)
+	}
+
 	return keys, nil
 }
 

internal/shell/zsh.go

@@ -25,7 +25,7 @@ type zsh struct{}
 var Zsh = zsh{}
 
 const zshHook = `
-if [[ -z "$__VFOX_PID" ]]; then
+if [[ -z "$__VFOX_PID" || -z "$__VFOX_SHELL" ]]; then
   {{.EnvContent}}
 
   export __VFOX_PID=$$;