feat(cmdpal): add pinyin support for Chinese input method #39354

frg2089 · 2025-05-11T14:54:43Z

Summary of the Pull Request

Add ToolGood.Words.Pinyin package to support pinyin conversion
Implement pinyin matching in StringMatcher class
Update project dependencies and Directory.Packages.props

PR Checklist

Detailed Description of the Pull Request / Additional comments

I've completed a rough implementation of pinyin support, but since I'm currently unsure where to add the toggle for pinyin support, this feature is enabled by default for now.

2025-05-11.230855.mp4

Validation Steps Performed

htcfreek · 2025-05-11T19:03:38Z

@frg2089
You need to update Notice.md. Otherwise build will fail later.

What is the reason for using a different Pinyin package than we already use for PT Run (hyjiacan.pinyin4net)? I think we should avoid using different pinyin packages. What do you think @zadjii-msft?

htcfreek · 2025-05-11T19:13:04Z

I've completed a rough implementation of pinyin support, but since I'm currently unsure where to add the toggle for pinyin support, this feature is enabled by default for now.

@zadjii-msft
Can you help with this?

frg2089 · 2025-05-11T23:01:07Z

What is the reason for using a different Pinyin package than we already use for PT Run (hyjiacan.pinyin4net)?

I just selected a recently updated package on nuget according to the last update time. The last update time of hyjiacan.pinyin4net was 2022/2/23.

Please let me know if you want me to continue using hyjiacan.pinyin4net.

moooyo · 2025-05-12T01:51:56Z

one question, does this package support Native AOT? if not, we can't get it in.
@frg2089

frg2089 · 2025-05-14T08:24:57Z

one question, does this package support Native AOT? if not, we can't get it in. @frg2089

I build it with <IsAotCompatible>true</IsAotCompatible> and they have not any warning.

Copilot

Pull Request Overview

This PR adds support for matching Chinese text by converting inputs and targets to their pinyin representations before performing fuzzy matching.

Introduces the ToolGood.Words.Pinyin package as a dependency.
Extends StringMatcher.FuzzyMatch to generate and match pinyin variants.
Updates central package versions in Directory.Packages.props.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/StringMatcher.cs	Implement pinyin generation and matching loop
src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/Microsoft.CommandPalette.Extensions.Toolkit.csproj	Add ToolGood.Words.Pinyin package reference
Directory.Packages.props	Pin ToolGood.Words.Pinyin version centrally

Comments suppressed due to low confidence (1)

src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/StringMatcher.cs:82

New pinyin matching behavior isn't covered by existing tests. Add unit tests for Chinese inputs and their pinyin variants to validate correctness.

queryList.Add(WordsHelper.GetPinyin(input));

src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/StringMatcher.cs

Copilot · 2025-05-16T06:52:29Z

src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/StringMatcher.cs

+        List<string> stringToCompareList = [stringToCompare];
+
+        // TODO: Add switch for Chinese.
+        if (true)


[nitpick] Avoid using if (true) as a placeholder. Replace with a real feature flag or user-setting check to toggle pinyin support.

Suggested change

if (true)

if (EnablePinyinSupport)

yeelam-gordon · 2025-06-10T06:29:56Z

@cinnamon-msft, in this PR, there are multiple input need and see if you have any suggestion/objection:

in run v1, there is an 3rd party library hyjiacan.pinyin4net (last update is 2022) for pinyun support. While it looks like this ToolGood.Words.Pinyin is faster and lightweight, as well as more up-to-date (2025) with wider usage .
ToolGood.Words.Pinyin is Apache-2.0 license
If there is no AOT problem, and let's say we add a new configuration in cmdpal to support pinyin matching, see if there is other concern.

moooyo · 2025-06-11T06:30:09Z

It's easy to add a new setting to control this behaviour.

See this PR as sample: https://github.com/microsoft/PowerToys/pull/38923/files#diff-2550e476d6684aaba319126262868c92cceb2d9776d3d78348baf4167824b30c

@frg2089

Ok, I've verified this PR is AOT compatible.

frg2089 · 2025-06-11T12:02:20Z

It's easy to add a new setting to control this behaviour.

See this PR as sample: https://github.com/microsoft/PowerToys/pull/38923/files#diff-2550e476d6684aaba319126262868c92cceb2d9776d3d78348baf4167824b30c

I have created settings for Pinyin support, but I don't know how to make StringMatcher use it.

moooyo · 2025-06-12T00:20:44Z

Could you please merge main into your branch?

@frg2089

- Add ToolGood.Words.Pinyin package to support pinyin conversion - Implement pinyin matching in StringMatcher class - Update project dependencies and Directory.Packages.props Signed-off-by: 舰队的偶像-岛风酱! <frg2089@outlook.com>

- Added notice for the use of ToolGood.Words.Pinyin NuGet package - Included MIT License information for ToolGood.Words.Pinyin - Updated NOTICE.md to reflect the new dependency Signed-off-by: 舰队的偶像-岛风酱! <frg2089@outlook.com>

…sions.Toolkit/StringMatcher.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

- Upgraded ToolGood.Words.Pinyin package from version 3.1.0.2 to 3.1.0.3 Signed-off-by: 舰队的偶像-岛风酱! <frg2089@outlook.com>

- Add EnableChinesePinYinSupport setting to SettingsModel - Implement EnableChinesePinYinSupport property in SettingsViewModel - Create UI toggle for EnableChinesePinYinSupport in GeneralPage.xaml - Add localization strings for new Chinese PinYin support setting Signed-off-by: 舰队的偶像-岛风酱! <frg2089@outlook.com>

@sovetskyfish

- Rename "Enable Chinese PinYin Support" to "PinYin Support for Chinese" - Update description from "Allows searching for Chinese characters using PinYin" to "Search Chinese contents with PinYin" thanks @sovetskyfish Signed-off-by: 舰队的偶像-岛风酱! <frg2089@outlook.com>

moooyo · 2025-06-13T03:12:36Z

Could you please fix spellcheck issue? see: https://github.com/microsoft/PowerToys/blob/main/.github/actions/spell-check/expect.txt

Or grant the permission to me and I can help to fix this issue.

- Add 'toolgood' to the list of expected words - Maintain existing entries and order Signed-off-by: 舰队的偶像-岛风酱! <frg2089@outlook.com>

moooyo · 2025-06-14T07:55:25Z

/azp run

azure-pipelines · 2025-06-14T07:55:35Z

Azure Pipelines successfully started running 1 pipeline(s).

moooyo · 2025-06-16T05:42:24Z

Pipeline failed.

Could you please add the pinyin package name to Notice.md?
see 7d257cf#diff-53337bf7ea91d782c573ac8653c18f95b7b23c38da9de08288639bcec9993406R1500 as example.

MissingFromNotice:

ToolGood.Words.Pinyin 3.1.0.3
@frg2089

moooyo · 2025-06-18T02:50:27Z

/azp run

azure-pipelines · 2025-06-18T02:50:37Z

Azure Pipelines successfully started running 1 pipeline(s).

moooyo · 2025-06-18T06:02:19Z

/azp run

azure-pipelines · 2025-06-18T06:02:29Z

Azure Pipelines successfully started running 1 pipeline(s).

htcfreek · 2025-06-18T06:50:31Z

@moooyo
Is this up to date with main? If not merging main fixes ci.

moooyo · 2025-06-18T06:55:55Z

@moooyo Is this up to date with main? If not merging main fixes ci.

ci passed

moooyo · 2025-06-18T07:21:26Z

Oh...I missed.

Sure, it's hard to use settings in toolkit. We need to find a way. Maybe add a config parameter is a good idea?

moooyo · 2025-06-18T07:22:52Z

Oh...I missed.

Sure, it's hard to use settings in toolkit. We need to find a way. Maybe add a config parameter is a good idea?

We need to design it carefully, because it was used in so many case.

moooyo

For this PR it self, I like this idea and this implement.

But we still need to find a proper way to use it in StringMatcher.

zadjii-msft added the Product-Command Palette Refers to the Command Palette utility label May 13, 2025

yeelam-gordon requested review from Copilot and moooyo May 16, 2025 06:50

yeelam-gordon added this to the PowerToys 0.92 milestone May 16, 2025

Copilot AI reviewed May 16, 2025

View reviewed changes

This comment has been minimized.

Sign in to view

cinnamon-msft modified the milestones: PowerToys 0.92, PowerToys 0.93 Jun 6, 2025

yeelam-gordon requested a review from cinnamon-msft June 10, 2025 06:09

yeelam-gordon added the Needs-Triage For issues raised to be triaged and prioritized by internal Microsoft teams label Jun 10, 2025

yeelam-gordon assigned cinnamon-msft Jun 10, 2025

This comment has been minimized.

Sign in to view

frg2089 and others added 6 commits June 13, 2025 00:21

Update src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Exten…

34d3dbc

…sions.Toolkit/StringMatcher.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

build(deps): update ToolGood.Words.Pinyin to 3.1.0.3

68c0666

- Upgraded ToolGood.Words.Pinyin package from version 3.1.0.2 to 3.1.0.3 Signed-off-by: 舰队的偶像-岛风酱! <frg2089@outlook.com>

frg2089 force-pushed the feat/pinyin-next branch from 56696b4 to e6c6bb8 Compare June 13, 2025 00:21

This comment has been minimized.

Sign in to view

ci: update spell check whitelist

5edf89f

- Add 'toolgood' to the list of expected words - Maintain existing entries and order Signed-off-by: 舰队的偶像-岛风酱! <frg2089@outlook.com>

Update NOTICE.md

2cb5f3e

moooyo requested changes Jun 18, 2025

View reviewed changes

feat(cmdpal): add pinyin support for Chinese input method #39354

Are you sure you want to change the base?

feat(cmdpal): add pinyin support for Chinese input method #39354

Uh oh!

Conversation

frg2089 commented May 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of the Pull Request

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

Uh oh!

htcfreek commented May 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

htcfreek commented May 11, 2025

Uh oh!

frg2089 commented May 11, 2025

Uh oh!

moooyo commented May 12, 2025

Uh oh!

frg2089 commented May 14, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI May 16, 2025

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

yeelam-gordon commented Jun 10, 2025

Uh oh!

This comment has been minimized.

moooyo commented Jun 11, 2025

Uh oh!

frg2089 commented Jun 11, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

moooyo commented Jun 12, 2025

Uh oh!

This comment has been minimized.

moooyo commented Jun 13, 2025

Uh oh!

moooyo commented Jun 14, 2025

Uh oh!

azure-pipelines bot commented Jun 14, 2025

Uh oh!

moooyo commented Jun 16, 2025

Uh oh!

moooyo commented Jun 18, 2025

Uh oh!

azure-pipelines bot commented Jun 18, 2025

Uh oh!

moooyo commented Jun 18, 2025

Uh oh!

azure-pipelines bot commented Jun 18, 2025

Uh oh!

htcfreek commented Jun 18, 2025

Uh oh!

moooyo commented Jun 18, 2025

Uh oh!

moooyo commented Jun 18, 2025

Uh oh!

moooyo commented Jun 18, 2025

Uh oh!

moooyo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

frg2089 commented May 11, 2025 •

edited

Loading

htcfreek commented May 11, 2025 •

edited

Loading