zsh HISTFILE Hardcoded after #168396 fix

[Redoubts]

Does this issue occur when all extensions are disabled?: Yes

• VS Code Version: 1.74.1 (Universal)
• OS Version: Darwin x64 22.2.0 (ssh extension into debian 10.12)

The fix for #168396 permanently overwrites my $HISTFILE setting, so I can't redirect it to another file. If I set

    "terminal.integrated.env.linux": {
        "HISTFILE": "${HOME}/something_else",
    }

in VS Code user settings or export HISTFILE="${HOME}/something_else" in my .zshenv, I see

% env | grep HIST
HISTFILE=/home/redoubts/.zsh_history

Steps to Reproduce:

1. try to set $HISTFILE anywhere normally
2. observe with env | grep HIST

[Tyriar]

As a temporary workaround you could set it in your .zshrc, checking TERM_PROGRAM == "vscode" if you want it only in VS Code.

I guess to fix this one we need to record any custom HISTFILE when we're constructing the envMixin:

vscode/src/vs/platform/terminal/node/terminalEnvironment.ts

Lines 198 to 220 in be6992b

	// Move .zshrc into $ZDOTDIR as the way to activate the script
	const zdotdir = path.join(os.tmpdir(), `${os.userInfo().username}-${productService.applicationName}-zsh`);
	envMixin['ZDOTDIR'] = zdotdir;
	const userZdotdir = env?.ZDOTDIR ?? os.homedir() ?? `~`;
	envMixin['USER_ZDOTDIR'] = userZdotdir;
	const filesToCopy: IShellIntegrationConfigInjection['filesToCopy'] = [];
	filesToCopy.push({
	source: path.join(appRoot, 'out/vs/workbench/contrib/terminal/browser/media/shellIntegration-rc.zsh'),
	dest: path.join(zdotdir, '.zshrc')
	});
	filesToCopy.push({
	source: path.join(appRoot, 'out/vs/workbench/contrib/terminal/browser/media/shellIntegration-profile.zsh'),
	dest: path.join(zdotdir, '.zprofile')
	});
	filesToCopy.push({
	source: path.join(appRoot, 'out/vs/workbench/contrib/terminal/browser/media/shellIntegration-env.zsh'),
	dest: path.join(zdotdir, '.zshenv')
	});
	filesToCopy.push({
	source: path.join(appRoot, 'out/vs/workbench/contrib/terminal/browser/media/shellIntegration-login.zsh'),
	dest: path.join(zdotdir, '.zlogin')
	});
	return { newArgs, envMixin, filesToCopy };

Then if we had a custom one, assign it here:

vscode/src/vs/workbench/contrib/terminal/browser/media/shellIntegration-rc.zsh

Lines 21 to 23 in be6992b

	if [[ "$VSCODE_INJECTION" == "1" ]]; then
	HISTFILE=$USER_ZDOTDIR/.zsh_history
	fi

@meganrogge will save this one for you for some good testing, no rush as there's an easy workaround.

[bika-c]

Will this be fixed in January update?

[kwmlodozeniec]

I have this variable set in my .zenv file and it still gets overridden somehow, to overcome that I had to disable the shell integration setting
"terminal.integrated.shellIntegration.enabled": false

[t-fritsch]

thank you @Tyriar for the suggested workaround. It didn't work for me because I need different history file for every workspace :

"terminal.integrated.env.osx": {
    "HISTFILE": "${workspaceFolder}/.zsh_history"
}

Anyway your suggestion helped me finding a temporary workaround (still hoping this bug gets fixed some day 😅) that I write here in case anyone is looking for something similar :

1. in .vscode/settings.json, create a custom env var :

   "terminal.integrated.env.osx": {
       "VSCODE_HISTFILE": "${workspaceFolder}/.zsh_history",
   },

2. in ~/.zshrc, check if it exists and overwrite HISTFILE :

   # fix vscode custom histfile
   # cf. https://github.com/microsoft/vscode/issues/169264
   if [[ -v VSCODE_HISTFILE ]]; then
       export HISTFILE=$VSCODE_HISTFILE
   fi