fix(shell): disable streaming when override var is present

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Author: JanDeDobbeleer

src/config/config_test.go

@@ -163,10 +163,9 @@ func TestFeaturesShellIntegration(t *testing.T) {
 
 func TestFeaturesStreaming(t *testing.T) {
 	cases := []struct {
-		Case             string
-		DisableStreaming string
-		Streaming        int
-		ExpectedFeats    shell.Features
+		Case          string
+		Streaming     int
+		ExpectedFeats shell.Features
 	}{
 		{
 			Case:          "streaming enabled",
@@ -182,7 +181,6 @@ func TestFeaturesStreaming(t *testing.T) {
 	for _, tc := range cases {
 		env := &mock.Environment{}
 		env.On("Shell").Return(shell.PWSH)
-		env.On("Getenv", "POSH_DISABLE_STREAMING").Return(tc.DisableStreaming)
 
 		cfg := &Config{
 			Streaming: tc.Streaming,

src/shell/cmd.go

@@ -33,7 +33,7 @@ else
     os.execute(string.format('"%s" notice', omp_executable))
 end`
 	case Streaming:
-		return "if os.getenv(\"POSH_DISABLE_STREAMING\") ~= \"1\" then\n    serve_enabled = true\nend"
+		return "if os.getenv(\"POSH_DISABLE_STREAMING\") == nil then\n    serve_enabled = true\nend"
 	case PromptMark, PoshGit, Azure, LineError, Jobs, CursorPositioning, Async, KeyHandlers, VIMode:
 		fallthrough
 	default:

src/shell/cmd_test.go

@@ -27,7 +27,7 @@ else
     os.execute(string.format('"%s" notice', omp_executable))
 end
 rprompt_enabled = true
-if os.getenv("POSH_DISABLE_STREAMING") ~= "1" then
+if os.getenv("POSH_DISABLE_STREAMING") == nil then
     serve_enabled = true
 end`
 

src/shell/fish.go

@@ -24,7 +24,7 @@ func (f Features) Fish() Code {
 	case Tooltips:
 		return "enable_poshtooltips"
 	case Streaming:
-		return "if test \"$POSH_DISABLE_STREAMING\" != \"1\"; set --global _omp_enable_streaming 1; end"
+		return "if not set -q POSH_DISABLE_STREAMING; set --global _omp_enable_streaming 1; end"
 	case Upgrade:
 		return unixUpgrade
 	case Notice:

src/shell/fish_test.go

@@ -18,7 +18,7 @@ set --global _omp_ftcs_marks 1
 "$_omp_executable" notice
 set --global _omp_prompt_mark 1
 set --global _omp_cursor_positioning 1
-if test "$POSH_DISABLE_STREAMING" != "1"; set --global _omp_enable_streaming 1; end
+if not set -q POSH_DISABLE_STREAMING; set --global _omp_enable_streaming 1; end
 _omp_enable_vimode
 set --global _omp_transient_rprompt 1`
 

src/shell/pwsh_test.go

@@ -34,7 +34,7 @@ Enable-PoshVIMode`
 }
 
 func TestPwshStreamingGuard(t *testing.T) {
-	assert.Contains(t, pwshInit, "if ($env:POSH_DISABLE_STREAMING -eq '1') {")
+	assert.Contains(t, pwshInit, "if (Test-Path Env:POSH_DISABLE_STREAMING) {")
 	assert.Contains(t, pwshInit, "return")
 }
 

src/shell/scripts/omp.ps1

@@ -993,7 +993,7 @@ New-Module -Name "oh-my-posh-core" -ScriptBlock {
     }
 
     function Enable-PoshStreaming {
-        if ($env:POSH_DISABLE_STREAMING -eq '1') {
+        if (Test-Path Env:POSH_DISABLE_STREAMING) {
             return
         }
 

src/shell/zsh.go

@@ -22,7 +22,7 @@ func (f Features) Zsh() Code {
 	case Notice:
 		return unixNotice
 	case Streaming:
-		return "if [[ \"${POSH_DISABLE_STREAMING:-}\" != \"1\" ]]; then _omp_enable_streaming=1; fi"
+		return "if [[ ! -v POSH_DISABLE_STREAMING ]]; then _omp_enable_streaming=1; fi"
 	case VIMode:
 		return "_omp_enable_vimode"
 	case PromptMark, RPrompt, PoshGit, Azure, LineError, Jobs, Async, KeyHandlers:

src/shell/zsh_test.go

@@ -20,7 +20,7 @@ _omp_ftcs_marks=1
 "$_omp_executable" upgrade --auto
 "$_omp_executable" notice
 _omp_cursor_positioning=1
-if [[ "${POSH_DISABLE_STREAMING:-}" != "1" ]]; then _omp_enable_streaming=1; fi
+if [[ ! -v POSH_DISABLE_STREAMING ]]; then _omp_enable_streaming=1; fi
 _omp_enable_vimode`
 
 	assert.Equal(t, want, got)

website/docs/configuration/streaming.mdx

@@ -47,14 +47,14 @@ We recommend starting with a timeout of around 100ms and adjusting based on your
 
 :::info
 If you're running inside a host or tool that doesn't get along with streaming's background
-repaint, set the `POSH_DISABLE_STREAMING` environment variable to `1` before initializing
-Oh My Posh to force it off entirely, regardless of what `streaming` is set to in your
-configuration. This lets you decide when to disable it using whatever check makes sense for
-your setup:
+repaint, set the `POSH_DISABLE_STREAMING` environment variable before initializing Oh My
+Posh to force it off entirely, regardless of what `streaming` is set to in your
+configuration. The variable can be present with any value, so you can decide when to disable
+it using whatever check makes sense for your setup:
 
 ```powershell
 if ($Host.Name -eq 'SomeIncompatibleHost') {
-    $env:POSH_DISABLE_STREAMING = '1'
+    $env:POSH_DISABLE_STREAMING = ''
 }
 
 oh-my-posh init pwsh --config ~/.mytheme.omp.json | Invoke-Expression