starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-09-24 16:05:21 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Allow newTabMenu's matchProfile to work with regex #22896

New Issue
Closed
opened 2026-01-31 08:26:31 +00:00 by claunia · 11 comments
claunia commented 2026-01-31 08:26:31 +00:00
Owner
Copy Link

Originally created by @carlos-zamora on GitHub (Feb 10, 2025).

Description of the new feature

Currently, matchProfile has 3 ways to get a match:

  • profile name
  • profile source
  • commandline

Today, a profile automatically gets picked up by the matcher if it matches one of the 3 fields above. But it has to be an exact match!

It'd be useful if we could allow for regexes to make it easier to get a match.

(Bonus, somewhat related idea) I think it's worth replacing the text box with a dropdown in the UI too. Just let the user directly select a source from the ones already registered.

Proposed technical implementation details

No response

Originally created by @carlos-zamora on GitHub (Feb 10, 2025). ### Description of the new feature Currently, `matchProfile` has 3 ways to get a match: - profile name - profile source - commandline Today, a profile automatically gets picked up by the matcher if it matches one of the 3 fields above. But it has to be an exact match! It'd be useful if we could allow for regexes to make it easier to get a match. (Bonus, somewhat related idea) I think it's worth replacing the text box with a dropdown in the UI too. Just let the user directly select a source from the ones already registered. ### Proposed technical implementation details _No response_
claunia commented 2026-01-31 08:26:33 +00:00
Author
Owner
Copy Link

@carlos-zamora commented on GitHub (Feb 12, 2025):

Bonus: we should move ICU from TerminalCore into til and use that for the regexes

@carlos-zamora commented on GitHub (Feb 12, 2025): Bonus: we should move `ICU` from `TerminalCore` into `til` and use that for the regexes
claunia commented 2026-01-31 08:26:33 +00:00
Author
Owner
Copy Link

@VishnuSrivatsava commented on GitHub (Feb 17, 2025):

Hi @carlos-zamora
I’m interested in working on this feature. I have experience with C++ and performance optimization. Could you provide some guidance on where in the codebase the matching logic is currently implemented? Also, do you have any specific preferences for integrating ICU regex into til?
Looking forward to your input!

@VishnuSrivatsava commented on GitHub (Feb 17, 2025): Hi @carlos-zamora I’m interested in working on this feature. I have experience with C++ and performance optimization. Could you provide some guidance on where in the codebase the matching logic is currently implemented? Also, do you have any specific preferences for integrating ICU regex into til? Looking forward to your input!
claunia commented 2026-01-31 08:26:33 +00:00
Author
Owner
Copy Link

@carlos-zamora commented on GitHub (Feb 19, 2025):

Hi @VishnuSrivatsava! Thanks for expressing your interest. 😊 Here's some notes that might be helpful for you:

The idea here is basically to move the ICU code into TIL so that we can use it throughout the codebase. Once that's done, it should be pretty easy to update MatchProfilesEntry::MatchesProfile with regex matching.

(Bonus, somewhat related idea) I think it's worth replacing the text box with a dropdown in the UI too. Just let the user directly select a source from the ones already registered.

If this is of interest to you, here's a quick walkthrough of what needs to be done:

  • NewTabmenu.xaml:
    • Currently, we use 3 text boxes in the match profiles UI: 13e7c9314d/src/cascadia/TerminalSettingsEditor/NewTabMenu.xaml (L452-L457)
    • The idea is to replace the second one (the one for "Source") with a dropdown. The options there would be auto-generated from all the profile sources we have available.
      • Thinking through this, we need a way to query the settings model for all the known sources. I'm working on that change right now as I'm currently working on adding in an Extensions page, which already required a lot of similar changes to the settings model. So, this part with the dropdown might not make sense to do just yet.

Hope this helps!

@carlos-zamora commented on GitHub (Feb 19, 2025): Hi @VishnuSrivatsava! Thanks for expressing your interest. 😊 Here's some notes that might be helpful for you: - Looks like this is the function where a match is determined: https://github.com/microsoft/terminal/blob/13e7c9314df5422679ff2bf2a78978cb66af9ace/src/cascadia/TerminalSettingsModel/MatchProfilesEntry.cpp#L45-L74 - ICU notes: - Introduced in PR #15858 - Looks like all the ICU code is stored here: https://github.com/microsoft/terminal/blob/main/src/buffer/out/UTextAdapter.h - with some tests stored here: https://github.com/microsoft/terminal/blob/main/src/buffer/out/ut_textbuffer/UTextAdapterTests.cpp - `til` is our namespace for a bunch of useful tools/classes/etc. - implementation code stored here: https://github.com/microsoft/terminal/tree/main/src/inc/til - tests stored here: https://github.com/microsoft/terminal/tree/main/src/til The idea here is basically to move the ICU code into TIL so that we can use it throughout the codebase. Once that's done, it should be pretty easy to update `MatchProfilesEntry::MatchesProfile` with regex matching. > (Bonus, somewhat related idea) I think it's worth replacing the text box with a dropdown in the UI too. Just let the user directly select a source from the ones already registered. If this is of interest to you, here's a quick walkthrough of what needs to be done: - NewTabmenu.xaml: - Currently, we use 3 text boxes in the match profiles UI: https://github.com/microsoft/terminal/blob/13e7c9314df5422679ff2bf2a78978cb66af9ace/src/cascadia/TerminalSettingsEditor/NewTabMenu.xaml#L452-L457 - The idea is to replace the second one (the one for "Source") with a dropdown. The options there would be auto-generated from all the profile sources we have available. - Thinking through this, we need a way to query the settings model for all the known sources. I'm working on that change right now as I'm currently working on adding in an Extensions page, which already required a lot of similar changes to the settings model. So, this part with the dropdown might not make sense to do just yet. Hope this helps!
claunia commented 2026-01-31 08:26:34 +00:00
Author
Owner
Copy Link

@VishnuSrivatsava commented on GitHub (Feb 19, 2025):

That was helpful, thanks! Would you like me to work on integrating regex matching into MatchesProfile using ICU now, or should I wait until the ICU refactor in til is complete? Also, is there anything specific you’d like me to focus on? I’d love to contribute, and I recently completed my Microsoft OA—hoping this could be a great way to get started!

@VishnuSrivatsava commented on GitHub (Feb 19, 2025): That was helpful, thanks! Would you like me to work on integrating regex matching into MatchesProfile using ICU now, or should I wait until the ICU refactor in til is complete? Also, is there anything specific you’d like me to focus on? I’d love to contribute, and I recently completed my Microsoft OA—hoping this could be a great way to get started!
claunia commented 2026-01-31 08:26:34 +00:00
Author
Owner
Copy Link

@carlos-zamora commented on GitHub (Feb 20, 2025):

No need to wait. 😊 I say go ahead and add the regex matching into MatchesProfiles now. If you can handle moving over the ICU to til, great. If not, it's fine. That'll just be a task to do in the future.

As for other ways to contribute, the Help-Wanted tag and good first issue tag are probably a good place to start. Pick whatever looks interesting to you. I've mainly been working on settings UI/model things and accessibility lately so that's personally what I'm focusing on, but I bounce around to other parts of the repo too.

@carlos-zamora commented on GitHub (Feb 20, 2025): No need to wait. 😊 I say go ahead and add the regex matching into MatchesProfiles now. If you can handle moving over the ICU to `til`, great. If not, it's fine. That'll just be a task to do in the future. As for other ways to contribute, the [Help-Wanted tag](https://github.com/microsoft/terminal/issues?q=sort%3Aupdated-desc+state%3Aopen+label%3A%22Help+Wanted%22) and [good first issue tag](https://github.com/microsoft/terminal/issues?q=sort%3Aupdated-desc%20state%3Aopen%20label%3A%22good%20first%20issue%22) are probably a good place to start. Pick whatever looks interesting to you. I've mainly been working on settings UI/model things and accessibility lately so that's personally what I'm focusing on, but I bounce around to other parts of the repo too.
claunia commented 2026-01-31 08:26:34 +00:00
Author
Owner
Copy Link

@VishnuSrivatsava commented on GitHub (Feb 20, 2025):

Thanks! I’ll focus on adding regex matching for now. If I get time later, I’ll look into moving ICU to til as well.

@VishnuSrivatsava commented on GitHub (Feb 20, 2025): Thanks! I’ll focus on adding regex matching for now. If I get time later, I’ll look into moving ICU to til as well.
claunia commented 2026-01-31 08:26:34 +00:00
Author
Owner
Copy Link

@VishnuSrivatsava commented on GitHub (Feb 20, 2025):

Hey @carlos-zamora
Since TAEF is Windows-specific, how can I run the tests on macOS? Is there an alternative setup or a way to containerize the test environment? Let me know how I should proceed.

@VishnuSrivatsava commented on GitHub (Feb 20, 2025): Hey @carlos-zamora Since TAEF is Windows-specific, how can I run the tests on macOS? Is there an alternative setup or a way to containerize the test environment? Let me know how I should proceed.
claunia commented 2026-01-31 08:26:34 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Feb 20, 2025):

.... if you don't have access to a Windows machine to run the tests, then how are you running the Terminal to manually validate 🤔

@zadjii-msft commented on GitHub (Feb 20, 2025): .... if you don't have access to a Windows machine to run the tests, then how are you running the Terminal to manually validate 🤔
claunia commented 2026-01-31 08:26:35 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Feb 20, 2025):

also:

I could have swore that regex matching for profiles was in one of the https://github.com/microsoft/terminal/pull/12584 drafts, but then we cut it for some reason? I can't remember why now.

@zadjii-msft commented on GitHub (Feb 20, 2025): also: I could have _swore_ that regex matching for profiles was in one of the https://github.com/microsoft/terminal/pull/12584 drafts, but then we cut it for some reason? I can't remember why now.
claunia commented 2026-01-31 08:26:35 +00:00
Author
Owner
Copy Link

@VishnuSrivatsava commented on GitHub (Feb 20, 2025):

.... if you don't have access to a Windows machine to run the tests, then how are you running the Terminal to manually validate 🤔

I own a Mac as my main machine, so I was just checking if there was a way to run the tests without switching over. I haven’t really implemented much yet—was just exploring the codebase and getting familiar with things. But yeah, I’ll grab a Windows machine when needed. 😅

@VishnuSrivatsava commented on GitHub (Feb 20, 2025): > .... if you don't have access to a Windows machine to run the tests, then how are you running the Terminal to manually validate 🤔 I own a Mac as my main machine, so I was just checking if there was a way to run the tests without switching over. I haven’t really implemented much yet—was just exploring the codebase and getting familiar with things. But yeah, I’ll grab a Windows machine when needed. 😅
claunia commented 2026-01-31 08:26:35 +00:00
Author
Owner
Copy Link

@carlos-zamora commented on GitHub (Feb 20, 2025):

also:

I could have swore that regex matching for profiles was in one of the #12584 drafts, but then we cut it for some reason? I can't remember why now.

Final spec: https://github.com/microsoft/terminal/blob/main/doc/specs/%231571%20-%20New%20Tab%20Menu%20Customization/%231571%20-%20New%20Tab%20Menu%20Customization.md

The regex section is at the bottom Future Considerations section.

Relevant discussions:

Thinking through it again, matchProfiles currently direct string matching for name, commandline, and source. Of the 3, source is pretty helpful because I can put like all my WSL profiles in one folder. commandline is still pretty useful because I can have like multiple pwsh.exe profiles that have a different startingDirectorty. name is the one that I'm struggling to find useful unless we had regex matching.

People aren't really using matchProfiles rn, so I think silently making them regex would be fine. Again, going through the options:

  • name --> upgrading from direct string matching to regex would likely return the same profile(s)
  • source --> "Microsoft.Terminal.Wsl" would return the same profiles
  • commandline --> pwsh.exe would return the same profiles

(now for a more spicy thought)
Following up on this thread, I'd really like it if name, commandline, and source were applied as an intersection, not a union. Kinda reiterating what you said at the end of that thread, this would allow users to get a union via multiple matchProfile entries and get an intersection via a single matchProfile entry.

Silently changing matchProfiles behavior also means that we can update the UI's localized strings, whereas adding functionality further complicates the UI, as it would have to expose regex and non-regex scenarios (doable, but I don't know if making it more complicated is worth it tbh).

@zadjii-msft Thoughts? Probably worth discussing at sync on Monday?

@carlos-zamora commented on GitHub (Feb 20, 2025): > also: > > I could have _swore_ that regex matching for profiles was in one of the [#12584](https://github.com/microsoft/terminal/pull/12584) drafts, but then we cut it for some reason? I can't remember why now. Final spec: https://github.com/microsoft/terminal/blob/main/doc/specs/%231571%20-%20New%20Tab%20Menu%20Customization/%231571%20-%20New%20Tab%20Menu%20Customization.md The regex section is at the bottom [Future Considerations section](https://github.com/microsoft/terminal/blob/main/doc/specs/%231571%20-%20New%20Tab%20Menu%20Customization/%231571%20-%20New%20Tab%20Menu%20Customization.md#future-considerations). Relevant discussions: - https://github.com/microsoft/terminal/pull/12584/commits/fa5ad0b108108f594e45032a9cd80f422084e6a8#r968934278 - https://github.com/microsoft/terminal/pull/12584/files#r968934688 - https://github.com/microsoft/terminal/pull/12584#issuecomment-1298914563 Thinking through it again, `matchProfiles` currently direct string matching for `name`, `commandline`, and `source`. Of the 3, `source` is pretty helpful because I can put like all my WSL profiles in one folder. `commandline` is still pretty useful because I can have like multiple `pwsh.exe` profiles that have a different `startingDirectorty`. `name` is the one that I'm struggling to find useful unless we had regex matching. People aren't really using `matchProfiles` rn, so I think silently making them regex would be fine. Again, going through the options: - `name` --> upgrading from direct string matching to regex would likely return the same profile(s) - `source` --> "Microsoft.Terminal.Wsl" would return the same profiles - `commandline` --> `pwsh.exe` would return the same profiles (now for a more spicy thought) Following up on [this thread](https://github.com/microsoft/terminal/pull/12584#discussion_r874245641), I'd _really_ like it if `name`, `commandline`, and `source` were applied as an intersection, not a union. Kinda reiterating what you said at the end of that thread, this would allow users to get a union via multiple `matchProfile` entries and get an intersection via a single `matchProfile` entry. Silently changing `matchProfiles` behavior also means that we can update the UI's localized strings, whereas adding functionality further complicates the UI, as it would have to expose regex and non-regex scenarios (doable, but I don't know if making it more complicated is worth it tbh). @zadjii-msft Thoughts? Probably worth discussing at sync on Monday?
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-Settings Help Wanted In-PR Issue-Feature Needs-Tag-Fix Product-Terminal
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#22896
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?