[CmdLineArgs] "--keepOpen" to keep the window/tab/pane open after the process/profile has exited.

[htcfreek]

Summary of the Pull Request

Adding a parameter to wt.exe that stops WT from closing after the sub process has exited.

References and Relevant Issues

Detailed Description of the Pull Request / Additional comments

This PR add the command line argument --keepOpen (short: -o) that stops WT from closing after the sub process has exited. This is done by overriding the Profile termination behavior setting at runtime with Never.

The new parameter also supports to be written to/read from a command line arguments JSON file.

Validation Steps Performed

• ✅ Tested that the new parameter is recognized on long and short form.
• 🔲 Tested the following parameter cases:

Commandline	Result	Reason
wt.exe --keepOpen ping.exe learn.microsoft.com	❌	wt/profile closes on Exit 0
wt.exe --keepOpen cmd.exe /c echo "test"	❌	wt/profile closes on Exit 0
wt.exe new-tab PowerShell --keepOpen -c Get-Service	❌	append to cmd
wt.exe nt -p "Command Prompt" --keepOpen	❌	wt/profile closes on Exit 0
wt.exe nt -p "PowerShell" --keepOpen	❌	wt/profile closes on Exit 0
wt.exe nt -p "Windows PowerShell" --keepOpen	❌	wt/profile closes on Exit 0
wt.exe -p "Command Prompt" ; split-pane -p "PowerShell" --keepOpen	❌	powershell pane closes on Exit 0
wt.exe -p "Command Prompt" ; split-pane -p "PowerShell" -o	❌	powershell pane closes on Exit 0
wt.exe --keepOpen -p "Command Prompt" ; split-pane -p "PowerShell"	❌	powershell pane closes on Exit 0
wt.exe new-tab PowerShell --keepOpen --appendCommandLine -- Write-Host test	❌	append to commandline
wt.exe new-tab PowerShell -o --appendCommandLine -- Write-Host test	❌	append to commandline

• 🔲 Tested that the new parameter stops WT from closing regardless of the current setting choice.
• 🔲 Tested that the new parameter not changes the setting permanently.
• 🔲 Tested that the net tests succeed.

PR Checklist

• Closes Add a parameter for --closeOnExit #16060
• Tests added/passed
• Documentation updated
  • If checked, please file a pull request on our docs repo and link it here: #xxx
• Schema updated (if necessary)

[htcfreek]

Is it correct that this json code and the one in line 395 is used to read form/write to a WT arguments json file? Do I need to update a json schema? (I can't find one.)

[zadjii-msft]

Yep, that's pretty much it. The schema can be found at terminal/doc/cascadia /profiles.schema.json

[htcfreek]

I would expect that this line also add the new parameter to the help window. But it doesn't do that:

[zadjii-msft]

Ah, yea that's by design. The help text for wt is different than the help text for wt new-tab. Behind the scenes, we'll secretly treat a wt without a subcommand as a new-tab subcommand, but the automatically generated help text for CLI11 doesn't know how to handle that 😅

[htcfreek]

@zadjii-msft
Status update: I have two important problems and need your help here.

1. wt.exe new-tab "PowerShell" --keepOpen -c Get-Service parses to the following command line: PowerShell --keepOpen -c Get-Service (Same when using the parameter --appendCommandLine -- Write-Host test.)
2. The settings of the profile are using the default value/value form settings.json and my parameter is ignored: What I need to know is, where can I manipulate the behavior of the profile/terminal?
3. [not important] wt.xe -? is incomplete and does not show the new parameter. (See my code comment.)

[htcfreek]

@zadjii-msft , @DHowett
Can you please look at this PR. I am not sure if it makes sense to keep it open as I don't know why it isn't working? Please give me some feedback.

[zadjii-msft]

My apologies! I think this one slipped through the cracks while I was off being distracted writing sudo. I can try and take a spin through the review - though, I might be a little more brief than usual until after Build (May 21-23)

[zadjii-msft]

honestly the rest of this looks like it should work

[zadjii-msft]

this seems... weird. This should already be plumbed through to the TermControl somewhere else...

[zadjii-msft]

Ah, right. It's not actually used by the TermControl. The pane itself handles that, in this blob of code:

terminal/src/cascadia/TerminalApp/TerminalPaneContent.cpp

Lines 240 to 256 in 9c16c5c

	if (_profile)
	{
	if (_isDefTermSession && _profile.CloseOnExit() == CloseOnExitMode::Automatic)
	{
	// For 'automatic', we only care about the connection state if we were launched by Terminal
	// Since we were launched via defterm, ignore the connection state (i.e. we treat the
	// close on exit mode as 'always', see GH #13325 for discussion)
	Close();
	}
	const auto mode = _profile.CloseOnExit();
	if ((mode == CloseOnExitMode::Always) ||
	((mode == CloseOnExitMode::Graceful || mode == CloseOnExitMode::Automatic) && newConnectionState == ConnectionState::Closed))
	{
	Close();
	}
	}

Looks like that's specifically looking up the CloseOnExit value out of the profile, not the TerminalSettings. I bet you could update that to use the value from the TerminalSettings too.

This code has an example in that file of getting settings from the cache:

terminal/src/cascadia/TerminalApp/TerminalPaneContent.cpp

Line 345 in 9c16c5c

if (const auto& settings{ _cache.TryLookup(_profile) })

That'll get you a TerminalSettingsCreateResult, who's .DefaultSettings() will have the value you're looking for

[zadjii-msft]

wt.exe new-tab "PowerShell" --keepOpen -c Get-Service

You'll probably want wt.exe new-tab -p "PowerShell" --keepOpen --appendCommandLine -c Get-Service (note the -p, to make sure it uses the PowerShell profile).