terminal icon indicating copy to clipboard operation
terminal copied to clipboard

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

Open htcfreek opened this issue 2 years ago • 10 comments

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 is implemented as new-tab parameter and 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 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. => Added, but all command line tests are failing.
  • 🔲 Tested the following parameter cases:
Command line Result Reason
wt.exe --keepOpen ping.exe learn.microsoft.com
wt.exe --keepOpen cmd.exe /c echo "test"
wt.exe -o cmd.exe /c echo "test"
wt.exe new-tab --keepOpen PowerShell -c Get-Service
wt.exe nt -p "Command Prompt" --keepOpen
wt.exe nt -p "PowerShell" --keepOpen
wt.exe nt -p "Windows PowerShell" -o
wt.exe -p "Command Prompt" ; split-pane -p "PowerShell" --keepOpen
wt.exe -p "Command Prompt" ; split-pane -p "PowerShell" -o
wt.exe --keepOpen -p "Command Prompt" ; split-pane -p "PowerShell"
wt.exe new-tab --keepOpen PowerShell --appendCommandLine -- Write-Host test
wt.exe new-tab -o PowerShell --appendCommandLine -- Write-Host test

PR Checklist

  • [x] Closes #16060
  • [ ] Tests added/passed => Added, but not passed.
  • [x] Documentation updated
  • [x] Schema updated (if necessary)

htcfreek avatar Dec 25 '23 14:12 htcfreek

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

exitted

To accept these unrecognized words as correct, you could run the following commands

... in a clone of the [email protected]:htcfreek/terminal.git repository on the Term_WindowParam branch (:information_source: how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/terminal/actions/runs/7322304291/attempts/1'
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary

This includes both expected items (2237) from .github/actions/spelling/expect/04cdb9b77d6827c0202f51acd4205b017015bfff.txt .github/actions/spelling/expect/alphabet.txt .github/actions/spelling/expect/expect.txt .github/actions/spelling/expect/web.txt and unrecognized words (1)

Dictionary Entries Covers Uniquely
cspell:k8s/dict/k8s.txt 153 2 2
cspell:swift/src/swift.txt 53 1 1
cspell:gaming-terms/dict/gaming-terms.txt 59 1 1
cspell:monkeyc/src/monkeyc_keywords.txt 123 1 1
cspell:cryptocurrencies/cryptocurrencies.txt 125 1 1

Consider adding them (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

      with:
        extra_dictionaries:
          cspell:k8s/dict/k8s.txt
          cspell:swift/src/swift.txt
          cspell:gaming-terms/dict/gaming-terms.txt
          cspell:monkeyc/src/monkeyc_keywords.txt
          cspell:cryptocurrencies/cryptocurrencies.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

check_extra_dictionaries: ''
Errors (1)

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

:x: Errors Count
:x: ignored-expect-variant 3

See :x: Event descriptions for more information.

:pencil2: Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

If the listed items are:

  • ... misspelled, then please correct them instead of using the command.
  • ... names, please add them to .github/actions/spelling/allow/names.txt.
  • ... APIs, you can add them to a file in .github/actions/spelling/allow/.
  • ... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
  • ... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

:microscope: You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. :wink:

If the flagged items are :exploding_head: false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it, try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

github-actions[bot] avatar Dec 25 '23 14:12 github-actions[bot]

@zadjii-msft If you try this please not that WT isn't starting. After my last changes it crashes immediately. (I don't know why and need to find the reason.)

And it seems to be hard to implement one parameter that works for wt.exe ping.exe learn.microsoft.com, wt.exe cmd.exe /c echo test and wt.exe new-tab PowerShell --appendCommandLine -- Write-Host test.

[Update 1] The crash is fixed and the parameter never manipulates the profile settings.[/Update1]

htcfreek avatar Dec 25 '23 17:12 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 avatar Dec 31 '23 13:12 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.

htcfreek avatar May 07 '24 08:05 htcfreek

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 avatar May 07 '24 11:05 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).

zadjii-msft avatar May 07 '24 11:05 zadjii-msft

@zadjii-msft Please remove the needs& feedback and the no-activity label. I need some time to look into it again.

htcfreek avatar May 14 '24 13:05 htcfreek

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).

The problem was a wrong parameter order. Correct order is wt.exe new-tab --keepOpen "PowerShell" -c Get-Service

htcfreek avatar Jun 24 '24 12:06 htcfreek

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

kepp

Previously acknowledged words that are now absent burriter codenav CRLFs FIter Redir wcsicmp 🫥
To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:htcfreek/terminal.git repository on the Term_WindowParam branch (:information_source: how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/terminal/actions/runs/9647969030/attempts/1'
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary

This includes both expected items (2218) from .github/actions/spelling/expect/04cdb9b77d6827c0202f51acd4205b017015bfff.txt .github/actions/spelling/expect/alphabet.txt .github/actions/spelling/expect/expect.txt .github/actions/spelling/expect/web.txt and unrecognized words (1)

Dictionary Entries Covers Uniquely
cspell:cpp/src/lang-jargon.txt 11 1 1
cspell:swift/src/swift.txt 53 1 1
cspell:gaming-terms/dict/gaming-terms.txt 59 1 1
cspell:monkeyc/src/monkeyc_keywords.txt 123 1 1
cspell:cryptocurrencies/cryptocurrencies.txt 125 1 1

Consider adding them (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

      with:
        extra_dictionaries:
          cspell:cpp/src/lang-jargon.txt
          cspell:swift/src/swift.txt
          cspell:gaming-terms/dict/gaming-terms.txt
          cspell:monkeyc/src/monkeyc_keywords.txt
          cspell:cryptocurrencies/cryptocurrencies.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

check_extra_dictionaries: ''
Errors (1)

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

:x: Errors Count
:x: ignored-expect-variant 3

See :x: Event descriptions for more information.

:pencil2: Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

If the listed items are:

  • ... misspelled, then please correct them instead of using the command.
  • ... names, please add them to .github/actions/spelling/allow/names.txt.
  • ... APIs, you can add them to a file in .github/actions/spelling/allow/.
  • ... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
  • ... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

:microscope: You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. :wink:

If the flagged items are :exploding_head: false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it, try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

github-actions[bot] avatar Jun 24 '24 15:06 github-actions[bot]

@zadjii-msft All command line tests failed. The tests I have updated and the tests I did not changed. The message is

    *********** CheckTypos - Test Start ***********
Trace Message: TerminalAppLocalTests::CommandlineTest::CheckTypos
	Message: 
	Result: Blocked
	Type: TestBlocked
	Context: TAEF
	File: 
	Function: 
	Timestamp: 01.01.0001 02:35:09
	Id: 106

*********** CheckTypos - Test Blocked ***********

What is happening here?

htcfreek avatar Jun 24 '24 16:06 htcfreek