terminal icon indicating copy to clipboard operation
terminal copied to clipboard

Don't send newlines to the shell from Terminal Chat

Open PankajBhojwani opened this issue 1 year ago • 5 comments

Summary of the Pull Request

When a multiline code block is clicked in Terminal chat, the first command gets run before the user presses 'Enter'. This commit fixes that by separating the code lines by the delimiter appropriate to the shell (& for cmd, ; for everything else).

Validation Steps Performed

Newlines get replaced with the appropriate delimiter

PR Checklist

  • [x] Closes #17939
  • [ ] 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)

PankajBhojwani avatar Oct 03 '24 21:10 PankajBhojwani

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

Delimeter

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

... in a clone of the [email protected]:microsoft/terminal.git repository on the dev/pabhoj/no_newlines 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/11169894259/attempts/1'
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary

This includes both expected items (2223) 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 6

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 Oct 03 '24 21:10 github-actions[bot]

I'm a little confused why we don't just remove the \r replacement entirely. \r is what the shell considers to be an "Enter" press so if we send \n delimited strings the shell will treat it as a multi-line paste. If that is correct, then the & / ; replacement seems like the wrong way to solve this.

Unfortunately the way we send the text to the shell (i.e. via a SendInput action) does not behave well with newlines, which was why this "replace newlines with \r" was here in the first place.

PankajBhojwani avatar Oct 07 '24 18:10 PankajBhojwani

\r is what the shell considers to be an "Enter" press so if we send \n delimited strings the shell will treat it as a multi-line paste.

cmd has entered the room

DHowett avatar Oct 07 '24 18:10 DHowett

Unfortunately the way we send the text to the shell (i.e. via a SendInput action) does not behave well with newlines, which was why this "replace newlines with \r" was here in the first place.

What was the issue with SendInput? In my testing it work just fine (outside of cmd).

cmd has entered the room

Right, that makes sense.

lhecker avatar Oct 07 '24 18:10 lhecker

What was the issue with SendInput? In my testing it work just fine (outside of cmd).

https://github.com/microsoft/terminal/issues/15788. We closed it because we stipulated there should actually be \rs along with the \ns.

PankajBhojwani avatar Oct 07 '24 20:10 PankajBhojwani