[PT Run] Windows Terminal Plugin

[davidegiacometti]

Summary of the Pull Request

What is this about:
Open in PT Run Windows Terminal profiles

TO-DO

• Setup
• Enable localization
• Plugin icon
• Plugin results icon
• Test on Windows 11
• Add tests

What is include in the PR:

• Support both Windows Terminal and Windows Terminal Preview
• The plugin read the profiles from the settings JSON file
• Option for open the profiles in a new tab

How does someone test / validate:

• Validate that the new plugin is working as expected

Quality Checklist

• Linked issue: [Run][New Plugin] Windows Terminal: show "profiles" as entries in results #4194
• Communication: I've discussed this with core contributors in the issue.
• Tests: Added/updated and all pass
• Installer: Added/updated and all pass
• Localization: All end user facing strings can be localized
• Docs: Added/ updated
• Binaries: Any new files are added to WXS / YML
  • No new binaries
  • YML for signing for new binaries
  • WXS for installer for new binaries

Contributor License Agreement (CLA)

A CLA must be signed. If not, go over here and sign the CLA.

[github-actions]

@check-spelling-bot Report

Unrecognized words, please review:

• ITerminal

Previously acknowledged words that are now absent

Accessible available chrisharris coc CTriage djsoref docsmsft dogancelik estdir Fody ftps gmx htt inprivate installpowertoys itsme listbox mfreadwrite mfuuid Nefario nitroin null nunit powertoyswiki Radiobuttons sidepanel spamming systray ulazy windevbuildagents winstore xia XSmall xunit

Some files were were automatically ignored

These sample patterns would exclude them:

^src/modules/previewpane/UnitTests-MarkdownPreviewHandler/HelperFiles/MarkdownWithHTMLImageTag\.txt$

You should consider adding them to:

.github/actions/spell-check/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To accept these unrecognized words as correct (and remove the previously acknowledged and now absent words), run the following commands

... in a clone of the [email protected]:microsoft/PowerToys.git repository
on the users/davidegiacometti/terminal-plugin branch:

update_files() {
perl -e '
my @expect_files=qw('".github/actions/spell-check/expect.txt"');
@ARGV=@expect_files;
my @stale=qw('"$patch_remove"');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
next if /^(?:$re)(?:(?:\r|\n)*$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spell-check/expect.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
(cat '.github/actions/spell-check/excludes.txt' - <<EOF
$should_exclude_patterns
EOF
) |grep .|
sort -f |
uniq > '.github/actions/spell-check/excludes.txt.temp' &&
mv '.github/actions/spell-check/excludes.txt.temp' '.github/actions/spell-check/excludes.txt'
}

comment_json=$(mktemp)
curl -L -s -S \
  --header "Content-Type: application/json" \
  "https://api.github.com/repos/microsoft/PowerToys/issues/comments/925304808" > "$comment_json"
comment_body=$(mktemp)
jq -r .body < "$comment_json" > $comment_body
rm $comment_json

patch_remove=$(perl -ne 'next unless s{^</summary>(.*)</details>$}{$1}; print' < "$comment_body")
  

patch_add=$(perl -e '$/=undef;
$_=<>;
s{<details>.*}{}s;
s{^#.*}{};
s{\n##.*}{};
s{(?:^|\n)\s*\*}{}g;
s{\s+}{ }g;
print' < "$comment_body")
  

should_exclude_patterns=$(perl -e '$/=undef;
$_=<>;
exit unless s{(?:You should consider excluding directory paths|You should consider adding them to).*}{}s;
s{.*These sample patterns would exclude them:}{}s;
s{.*\`\`\`([^`]*)\`\`\`.*}{$1}m;
print' < "$comment_body" | grep . || true)

update_files
rm $comment_body
git add -u

If you see a bunch of garbage

If it relates to a ...

well-formed pattern

See if there's a pattern that would match it.

If not, try writing one and 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.

binary-ish string

Please add a file path to the excludes.txt file instead of just accepting the garbage.

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

[htcfreek]

Does it make sense to show the results when searching for wt/Windows Terminal (Preview) without using activation command (global results).

[niels9001]

@davidegiacometti I have created a .light and .dark icon that might be useful for this plugin :) (and already in the style for #13385)

[Aaron-Junker]

@davidegiacometti I have created a .light and .dark icon that might be useful for this plugin :) (and already in the style for #13385)

@niels9001 I like these icons, but in my opinion it would be better to just use the terminal icon (or at least in the results):

[davidegiacometti]

@niels9001 icon must be used for the settings.
For results I would like to use the profile icons from Terminal but the icon could be an image file or a resource inside Terminal package.
Need to look in to this. Otherwise let's consider plugin or Terminal icon.

[Jay-o-Way]

I have created a .light and .dark icon

Why not stick to MDL2?

[davidegiacometti]

I have created a .light and .dark icon

Why not stick to MDL2?

Icons for plugins aren't MDL2 but custom

[davidegiacometti]

Post about result's icon: #4194 (comment)

[niels9001]

Post about result's icon: #4194 (comment)

I'd go for the colored Terminal icon in Run itself, but the Fluent Icons-version for the plugin manager list in Settings.

[davidegiacometti]

The PR is ready to review.
I have updated the screenshots in the first post.

Somebody please can build and test the plugin on Windows 11?

[jaimecbernardo]

Works nicely on Windows 11.

[jaimecbernardo]

LGTM! Works well.
I'd still like to have another review in here, but after that it can go in.
Thank you for the contribution!

[yuyoyuppe]

The code looks good to me, awesome contribution!