[FZ Editor] Open settings

[niels9001]

Summary of the Pull Request

This PR introduces a settings button in the FancyZones editor to quickly open Settings: #7408

How does someone test / validate:

• Make sure to run the latest settings (= runner) from master branch.
• Debug FancyZones editor.
• Click on the new settings button.

Quality Checklist

• Linked issue: [Settings] Support for deep-linking #7408
• 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:

• asembly
• Btn

Previously acknowledged words that are now absent

Accessible available CIEXYZ coc CTriage dchristensen djsoref docsmsft dogancelik dupenv estdir Fody ftp ftps gmx htt ianjoneill inprivate installpowertoys itsme jakeoeding KERNELBASE listbox mfreadwrite mfuuid Nefario nitroin null nunit powertoyswiki PROGRAMFILES 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/niels9001/fzeditordeeplink 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/939511910" > "$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).

[Jay-o-Way]

Icons are a no-go

[htcfreek]

@niels9001
We should fix spellings and not add incorrect ones to expect.txt.

asembly => assembly

[niels9001]

asembly

Yes, you're right. I though it was related to a namespace but it was a var name with a typo :). Thanks!

[SeraphimaZykova]

LGTM!

[martinchrzan]

guard this block (all 3 lines) with try/catch clause and log it, it can throw multiple exceptions.

[niels9001]

@SeraphimaZ I added a try catch block, what is the code for log events in FZ editor?

[SeraphimaZykova]

@niels9001 there isn't any logger in the FZ editor yet.
Only unhandled exceptions are saved in a file.

PowerToys/src/modules/fancyzones/editor/FancyZonesEditor/App.xaml.cs

Lines 214 to 225 in 0ca9b1b

	private void OnUnhandledException(object sender, UnhandledExceptionEventArgs args)
	{
	var fileStream = File.OpenWrite(CrashReportLogFile);
	using (var sw = new StreamWriter(fileStream))
	{
	sw.Write(FormatException((Exception)args.ExceptionObject));
	}
	fileStream.Close();
	ShowReportMessageBox(fileStream.Name);
	}