Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2026-02-23 19:49:43 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev/migrie/b/core-run-nits' into dev/migrie/f/run-telem

Browse Source
This commit is contained in:
Mike Griese
2025-09-30 13:16:47 -05:00
parent 5da2e74622 de5fee2ca6
commit fd9f523d5d
143 changed files with 6153 additions and 972 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/actions/spell-check/allow/names.txt vendored
View File

@@ -210,6 +210,7 @@ capturevideosample
cmdow
Controlz
cortana
devhints
dlnilsson
fancymouse
firefox
@@ -229,6 +230,7 @@ regedit
roslyn
Skia
Spotify
tldr
Vanara
wangyi
WEX

4
.github/actions/spell-check/expect.txt vendored
View File

@@ -160,6 +160,7 @@ BUILDARCH
BUILDNUMBER
buildtransitive
builttoroam
BUNDLEINFO
BVal
BValue
byapp
@@ -863,6 +864,7 @@ LOCKTYPE
LOGFONT
LOGFONTW
logon
LOGMSG
LOGPIXELSX
LOGPIXELSY
LOn
@@ -1040,6 +1042,7 @@ MWBEx
MYICON
NAMECHANGE
namespaceanddescendants
Namotion
nao
NCACTIVATE
ncc
@@ -1077,6 +1080,7 @@ NEWPLUSSHELLEXTENSIONWIN
newrow
nicksnettravels
NIF
NJson
NLog
NLSTEXT
NMAKE

2
.gitignore vendored
View File

@@ -350,7 +350,9 @@ src/common/Telemetry/*.etl
# Generated installer file for Monaco source files.
/installer/PowerToysSetup/MonacoSRC.wxs
/installer/PowerToysSetup/DscResources.wxs
/installer/PowerToysSetupVNext/MonacoSRC.wxs
/installer/PowerToysSetupVNext/DscResources.wxs
# MSBuildCache
/MSBuildCacheLogs/

15
.pipelines/ESRPSigning_core.json
View File

@@ -55,7 +55,6 @@
"PowerToys.Awake.exe",
"PowerToys.Awake.dll",
"PowerToys.FancyZonesEditor.exe",
"PowerToys.FancyZonesEditor.dll",
"PowerToys.FancyZonesEditorCommon.dll",
@@ -230,7 +229,10 @@
"PowerToys.CmdPalModuleInterface.dll",
"CmdPalKeyboardService.dll",
"*Microsoft.CmdPal.UI_*.msix"
"*Microsoft.CmdPal.UI_*.msix",
"PowerToys.DSC.dll",
"PowerToys.DSC.exe"
],
"SigningInfo": {
"Operations": [
@@ -297,6 +299,9 @@
"msvcp140_1_app.dll",
"msvcp140_2_app.dll",
"msvcp140_app.dll",
"Namotion.Reflection.dll",
"NJsonSchema.Annotations.dll",
"NJsonSchema.dll",
"vcamp140_app.dll",
"vccorlib140_app.dll",
"vcomp140_app.dll",
@@ -322,6 +327,12 @@
"WinUI3Apps\\ReverseMarkdown.dll",
"WinUI3Apps\\SharpCompress.dll",
"WinUI3Apps\\ZstdSharp.dll",
"CommunityToolkit.WinUI.Controls.MarkdownTextBlock.dll",
"WinUI3Apps\\CommunityToolkit.WinUI.Controls.MarkdownTextBlock.dll",
"Markdig.dll",
"WinUI3Apps\\Markdig.dll",
"RomanNumerals.dll",
"WinUI3Apps\\RomanNumerals.dll",
"TestableIO.System.IO.Abstractions.dll",
"WinUI3Apps\\TestableIO.System.IO.Abstractions.dll",
"TestableIO.System.IO.Abstractions.Wrappers.dll",

88
.pipelines/generateDscManifests.ps1 Normal file
View File

@@ -0,0 +1,88 @@
[CmdletBinding()]
param(
[Parameter(Mandatory = $true)]
[string]$BuildPlatform,
[Parameter(Mandatory = $true)]
[string]$BuildConfiguration,
[Parameter()]
[string]$RepoRoot = (Get-Location).Path
)
$ErrorActionPreference = 'Stop'
function Resolve-PlatformDirectory {
param(
[string]$Root,
[string]$Platform
)
$normalized = $Platform.Trim()
$candidates = @()
$candidates += Join-Path $Root $normalized
$candidates += Join-Path $Root ($normalized.ToUpperInvariant())
$candidates += Join-Path $Root ($normalized.ToLowerInvariant())
$candidates = $candidates | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } | Select-Object -Unique
foreach ($candidate in $candidates) {
if (Test-Path $candidate) {
return $candidate
}
}
return $candidates[0]
}
Write-Host "Repo root: $RepoRoot"
Write-Host "Requested build platform: $BuildPlatform"
Write-Host "Requested configuration: $BuildConfiguration"
# Always use x64 PowerToys.DSC.exe since CI/CD machines are x64
$exePlatform = 'x64'
$exeRoot = Resolve-PlatformDirectory -Root $RepoRoot -Platform $exePlatform
$exeOutputDir = Join-Path $exeRoot $BuildConfiguration
$exePath = Join-Path $exeOutputDir 'PowerToys.DSC.exe'
Write-Host "Using x64 PowerToys.DSC.exe to generate DSC manifests for $BuildPlatform build"
if (-not (Test-Path $exePath)) {
throw "PowerToys.DSC.exe not found at '$exePath'. Make sure it has been built first."
}
Write-Host "Using PowerToys.DSC.exe at '$exePath'."
# Output DSC manifests to the target build platform directory (x64, ARM64, etc.)
$outputRoot = Resolve-PlatformDirectory -Root $RepoRoot -Platform $BuildPlatform
if (-not (Test-Path $outputRoot)) {
Write-Host "Creating missing platform output root at '$outputRoot'."
New-Item -Path $outputRoot -ItemType Directory -Force | Out-Null
}
$outputDir = Join-Path $outputRoot $BuildConfiguration
if (-not (Test-Path $outputDir)) {
Write-Host "Creating missing configuration output directory at '$outputDir'."
New-Item -Path $outputDir -ItemType Directory -Force | Out-Null
}
Write-Host "DSC manifests will be generated to: '$outputDir'"
Write-Host "Cleaning previously generated DSC manifest files from '$outputDir'."
Get-ChildItem -Path $outputDir -Filter 'microsoft.powertoys.*.settings.dsc.resource.json' -ErrorAction SilentlyContinue | Remove-Item -Force
$arguments = @('manifest', '--resource', 'settings', '--outputDir', $outputDir)
Write-Host "Invoking DSC manifest generator: '$exePath' $($arguments -join ' ')"
& $exePath @arguments
if ($LASTEXITCODE -ne 0) {
throw "PowerToys.DSC.exe exited with code $LASTEXITCODE"
}
$generatedFiles = Get-ChildItem -Path $outputDir -Filter 'microsoft.powertoys.*.settings.dsc.resource.json' -ErrorAction Stop
if ($generatedFiles.Count -eq 0) {
throw "No DSC manifest files were generated in '$outputDir'."
}
Write-Host "Generated $($generatedFiles.Count) DSC manifest file(s):"
foreach ($file in $generatedFiles) {
Write-Host " - $($file.FullName)"
}

7
.pipelines/v2/release.yml
View File

@@ -43,11 +43,6 @@ parameters:
displayName: "Build Using Visual Studio Preview"
default: false
- name: enableAOT
type: boolean
displayName: "Enable AOT (Ahead-of-Time) Compilation for CmdPal"
default: true
name: $(BuildDefinitionName)_$(date:yyMM).$(date:dd)$(rev:rrr)
variables:
@@ -109,8 +104,8 @@ extends:
useManagedIdentity: $(SigningUseManagedIdentity)
clientId: $(SigningOriginalClientId)
# Have msbuild use the release nuget config profile
additionalBuildOptions: /p:RestoreConfigFile="$(Build.SourcesDirectory)\.pipelines\release-nuget.config" /p:EnableCmdPalAOT=${{ parameters.enableAOT }} /p:InstallerSuffix=${{ parameters.installerSuffix }}
installerSuffix: ${{ parameters.installerSuffix }}
additionalBuildOptions: /p:RestoreConfigFile="$(Build.SourcesDirectory)\.pipelines\release-nuget.config" /p:InstallerSuffix=${{ parameters.installerSuffix }} /p:EnableCmdPalAOT=true
beforeBuildSteps:
# Sets versions for all PowerToy created DLLs
- pwsh: |-

17
.pipelines/v2/templates/job-build-project.yml
View File

@@ -271,6 +271,23 @@ jobs:
env:
SYSTEM_ACCESSTOKEN: $(System.AccessToken)
# Build PowerToys.DSC.exe for ARM64 (x64 uses existing binary from previous build)
- task: VSBuild@1
displayName: Build PowerToys.DSC.exe (x64 for generating manifests)
condition: ne(variables['BuildPlatform'], 'x64')
inputs:
solution: src/dsc/v3/PowerToys.DSC/PowerToys.DSC.csproj
msbuildArgs: /t:Build /m /restore
platform: x64
configuration: $(BuildConfiguration)
msbuildArchitecture: x64
maximumCpuCount: true
# Generate DSC manifests using PowerToys.DSC.exe
- pwsh: |-
& '.pipelines/generateDscManifests.ps1' -BuildPlatform '$(BuildPlatform)' -BuildConfiguration '$(BuildConfiguration)' -RepoRoot '$(Build.SourcesDirectory)'
displayName: Generate DSC manifests
- task: CopyFiles@2
displayName: Stage SDK/build
inputs:

3
Directory.Packages.props
View File

@@ -67,6 +67,7 @@
<!-- Moq to stay below v4.20 due to behavior change. need to be sure fixed -->
<PackageVersion Include="Moq" Version="4.18.4" />
<PackageVersion Include="MSTest" Version="3.8.3" />
<PackageVersion Include="NJsonSchema" Version="11.4.0" />
<PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
<PackageVersion Include="NLog" Version="5.2.8" />
<PackageVersion Include="NLog.Extensions.Logging" Version="5.3.8" />
@@ -107,7 +108,7 @@
<PackageVersion Include="UnicodeInformation" Version="2.6.0" />
<PackageVersion Include="UnitsNet" Version="5.56.0" />
<PackageVersion Include="UTF.Unknown" Version="2.6.0" />
<PackageVersion Include="WinUIEx" Version="2.2.0" />
<PackageVersion Include="WinUIEx" Version="2.8.0" />
<PackageVersion Include="WPF-UI" Version="3.0.5" />
<PackageVersion Include="WyHash" Version="1.0.5" />
<PackageVersion Include="WixToolset.Heat" Version="5.0.2" />

1
NOTICE.md
View File

@@ -1521,6 +1521,7 @@ SOFTWARE.
- ModernWpfUI
- Moq
- MSTest
- NJsonSchema
- NLog
- NLog.Extensions.Logging
- NLog.Schema

25
PowerToys.sln
View File

@@ -797,6 +797,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Tests", "Tests", "{E11826E1
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScreenRuler.UITests", "src\modules\MeasureTool\Tests\ScreenRuler.UITests\ScreenRuler.UITests.csproj", "{66C069F8-C548-4CA6-8CDE-239104D68E88}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "v3", "v3", "{9605B84E-FAC4-477B-B9EC-0753177EE6A8}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PowerToys.DSC", "src\dsc\v3\PowerToys.DSC\PowerToys.DSC.csproj", "{94CDC147-6137-45E9-AEDE-17FF809607C0}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PowerToys.DSC.UnitTests", "src\dsc\v3\PowerToys.DSC.UnitTests\PowerToys.DSC.UnitTests.csproj", "{A24BF1AF-79AA-4896-BAE3-CCBBE0380A78}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.CmdPal.Ext.Apps.UnitTests", "src\modules\cmdpal\Tests\Microsoft.CmdPal.Ext.Apps.UnitTests\Microsoft.CmdPal.Ext.Apps.UnitTests.csproj", "{E816D7B1-4688-4ECB-97CC-3D8E798F3830}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.CmdPal.Ext.Bookmarks.UnitTests", "src\modules\cmdpal\Tests\Microsoft.CmdPal.Ext.Bookmarks.UnitTests\Microsoft.CmdPal.Ext.Bookmarks.UnitTests.csproj", "{E816D7B3-4688-4ECB-97CC-3D8E798F3832}"
@@ -2891,6 +2897,22 @@ Global
{66C069F8-C548-4CA6-8CDE-239104D68E88}.Release|ARM64.Build.0 = Release|ARM64
{66C069F8-C548-4CA6-8CDE-239104D68E88}.Release|x64.ActiveCfg = Release|x64
{66C069F8-C548-4CA6-8CDE-239104D68E88}.Release|x64.Build.0 = Release|x64
{94CDC147-6137-45E9-AEDE-17FF809607C0}.Debug|ARM64.ActiveCfg = Debug|ARM64
{94CDC147-6137-45E9-AEDE-17FF809607C0}.Debug|ARM64.Build.0 = Debug|ARM64
{94CDC147-6137-45E9-AEDE-17FF809607C0}.Debug|x64.ActiveCfg = Debug|x64
{94CDC147-6137-45E9-AEDE-17FF809607C0}.Debug|x64.Build.0 = Debug|x64
{94CDC147-6137-45E9-AEDE-17FF809607C0}.Release|ARM64.ActiveCfg = Release|ARM64
{94CDC147-6137-45E9-AEDE-17FF809607C0}.Release|ARM64.Build.0 = Release|ARM64
{94CDC147-6137-45E9-AEDE-17FF809607C0}.Release|x64.ActiveCfg = Release|x64
{94CDC147-6137-45E9-AEDE-17FF809607C0}.Release|x64.Build.0 = Release|x64
{A24BF1AF-79AA-4896-BAE3-CCBBE0380A78}.Debug|ARM64.ActiveCfg = Debug|ARM64
{A24BF1AF-79AA-4896-BAE3-CCBBE0380A78}.Debug|ARM64.Build.0 = Debug|ARM64
{A24BF1AF-79AA-4896-BAE3-CCBBE0380A78}.Debug|x64.ActiveCfg = Debug|x64
{A24BF1AF-79AA-4896-BAE3-CCBBE0380A78}.Debug|x64.Build.0 = Debug|x64
{A24BF1AF-79AA-4896-BAE3-CCBBE0380A78}.Release|ARM64.ActiveCfg = Release|ARM64
{A24BF1AF-79AA-4896-BAE3-CCBBE0380A78}.Release|ARM64.Build.0 = Release|ARM64
{A24BF1AF-79AA-4896-BAE3-CCBBE0380A78}.Release|x64.ActiveCfg = Release|x64
{A24BF1AF-79AA-4896-BAE3-CCBBE0380A78}.Release|x64.Build.0 = Release|x64
{E816D7B1-4688-4ECB-97CC-3D8E798F3830}.Debug|ARM64.ActiveCfg = Debug|ARM64
{E816D7B1-4688-4ECB-97CC-3D8E798F3830}.Debug|ARM64.Build.0 = Debug|ARM64
{E816D7B1-4688-4ECB-97CC-3D8E798F3830}.Debug|x64.ActiveCfg = Debug|x64
@@ -3238,6 +3260,9 @@ Global
{00D8659C-2068-40B6-8B86-759CD6284BBB} = {8EF25507-2575-4ADE-BF7E-D23376903AB8}
{E11826E1-76DF-42AC-985C-164CC2EE57A1} = {7AC943C9-52E8-44CF-9083-744D8049667B}
{66C069F8-C548-4CA6-8CDE-239104D68E88} = {E11826E1-76DF-42AC-985C-164CC2EE57A1}
{9605B84E-FAC4-477B-B9EC-0753177EE6A8} = {557C4636-D7E1-4838-A504-7D19B725EE95}
{94CDC147-6137-45E9-AEDE-17FF809607C0} = {9605B84E-FAC4-477B-B9EC-0753177EE6A8}
{A24BF1AF-79AA-4896-BAE3-CCBBE0380A78} = {9605B84E-FAC4-477B-B9EC-0753177EE6A8}
{E816D7B1-4688-4ECB-97CC-3D8E798F3830} = {8EF25507-2575-4ADE-BF7E-D23376903AB8}
{E816D7B3-4688-4ECB-97CC-3D8E798F3832} = {8EF25507-2575-4ADE-BF7E-D23376903AB8}
{E816D7B2-4688-4ECB-97CC-3D8E798F3831} = {8EF25507-2575-4ADE-BF7E-D23376903AB8}

148
README.md
View File

@@ -1,38 +1,56 @@
# Microsoft PowerToys
<p align="center">
<picture>
<source media="(prefers-color-scheme: light)" srcset="./doc/images/readme/pt-hero.light.png" />
<img src="./doc/images/readme/pt-hero.dark.png" />
</picture>
</p>
<h1 align="center">
<span>Microsoft PowerToys</span>
</h1>
![Hero image for Microsoft PowerToys](doc/images/overview/PT_hero_image.png)
<h3 align="center">
<a href="#-installation">Installation</a>
<span> · </span>
<a href="https://aka.ms/powertoys-docs">Documentation</a>
<span> · </span>
<a href="https://aka.ms/powertoys-releaseblog">Blog</a>
<span> · </span>
<a href="#-whats-new">Release notes</a>
</h3>
<br/><br/>
Microsoft PowerToys is a collection of utilities that help you customize Windows and streamline everyday tasks.
<br/><br/>
[How to use PowerToys][usingPowerToys-docs-link] | [Downloads & Release notes][github-release-link] | [Contributing to PowerToys](#contributing) | [What's Happening](#whats-happening) | [Roadmap](#powertoys-roadmap)
| | | |
|---|---|---|
| [<img src="doc/images/icons/AdvancedPaste.png" alt="Advanced Paste icon" height="16"> Advanced Paste](https://aka.ms/PowerToysOverview_AdvancedPaste) | [<img src="doc/images/icons/Always%20On%20Top.png" alt="Always on Top icon" height="16"> Always on Top](https://aka.ms/PowerToysOverview_AoT) | [<img src="doc/images/icons/Awake.png" alt="Awake icon" height="16"> Awake](https://aka.ms/PowerToysOverview_Awake) |
| [<img src="doc/images/icons/Color%20Picker.png" alt="Color Picker icon" height="16"> Color Picker](https://aka.ms/PowerToysOverview_ColorPicker) | [<img src="doc/images/icons/Command%20Not%20Found.png" alt="Command Not Found icon" height="16"> Command Not Found](https://aka.ms/PowerToysOverview_CmdNotFound) | [<img src="doc/images/icons/Command Palette.png" alt="Command Palette icon" height="16"> Command Palette](https://aka.ms/PowerToysOverview_CmdPal) |
| [<img src="doc/images/icons/Crop%20And%20Lock.png" alt="Crop and Lock icon" height="16"> Crop And Lock](https://aka.ms/PowerToysOverview_CropAndLock) | [<img src="doc/images/icons/Environment%20Manager.png" alt="Environment Variables icon" height="16"> Environment Variables](https://aka.ms/PowerToysOverview_EnvironmentVariables) | [<img src="doc/images/icons/FancyZones.png" alt="FancyZones icon" height="16"> FancyZones](https://aka.ms/PowerToysOverview_FancyZones) |
| [<img src="doc/images/icons/File%20Explorer%20Preview.png" alt="File Explorer Add-ons icon" height="16"> File Explorer Add-ons](https://aka.ms/PowerToysOverview_FileExplorerAddOns) | [<img src="doc/images/icons/File%20Locksmith.png" alt="File Locksmith icon" height="16"> File Locksmith](https://aka.ms/PowerToysOverview_FileLocksmith) | [<img src="doc/images/icons/Host%20File%20Editor.png" alt="Hosts File Editor icon" height="16"> Hosts File Editor](https://aka.ms/PowerToysOverview_HostsFileEditor) |
| [<img src="doc/images/icons/Image%20Resizer.png" alt="Image Resizer icon" height="16"> Image Resizer](https://aka.ms/PowerToysOverview_ImageResizer) | [<img src="doc/images/icons/Keyboard%20Manager.png" alt="Keyboard Manager icon" height="16"> Keyboard Manager](https://aka.ms/PowerToysOverview_KeyboardManager) | [<img src="doc/images/icons/Find My Mouse.png" alt="Mouse Utilities icon" height="16"> Mouse Utilities](https://aka.ms/PowerToysOverview_MouseUtilities) |
| [<img src="doc/images/icons/MouseWithoutBorders.png" alt="Mouse Without Borders icon" height="16"> Mouse Without Borders](https://aka.ms/PowerToysOverview_MouseWithoutBorders) | [<img src="doc/images/icons/NewPlus.png" alt="New+ icon" height="16"> New+](https://aka.ms/PowerToysOverview_NewPlus) | [<img src="doc/images/icons/Peek.png" alt="Peek icon" height="16"> Peek](https://aka.ms/PowerToysOverview_Peek) |
| [<img src="doc/images/icons/PowerRename.png" alt="PowerRename icon" height="16"> PowerRename](https://aka.ms/PowerToysOverview_PowerRename) | [<img src="doc/images/icons/PowerToys%20Run.png" alt="PowerToys Run icon" height="16"> PowerToys Run](https://aka.ms/PowerToysOverview_PowerToysRun) | [<img src="doc/images/icons/PowerAccent.png" alt="Quick Accent icon" height="16"> Quick Accent](https://aka.ms/PowerToysOverview_QuickAccent) |
| [<img src="doc/images/icons/Registry%20Preview.png" alt="Registry Preview icon" height="16"> Registry Preview](https://aka.ms/PowerToysOverview_RegistryPreview) | [<img src="doc/images/icons/MeasureTool.png" alt="Screen Ruler icon" height="16"> Screen Ruler](https://aka.ms/PowerToysOverview_ScreenRuler) | [<img src="doc/images/icons/Shortcut%20Guide.png" alt="Shortcut Guide icon" height="16"> Shortcut Guide](https://aka.ms/PowerToysOverview_ShortcutGuide) |
| [<img src="doc/images/icons/PowerOCR.png" alt="Text Extractor icon" height="16"> Text Extractor](https://aka.ms/PowerToysOverview_TextExtractor) | [<img src="doc/images/icons/Workspaces.png" alt="Workspaces icon" height="16"> Workspaces](https://aka.ms/PowerToysOverview_Workspaces) | [<img src="doc/images/icons/ZoomIt.png" alt="ZoomIt icon" height="16"> ZoomIt](https://aka.ms/PowerToysOverview_ZoomIt) |
## About
Microsoft PowerToys is a set of utilities for power users to tune and streamline their Windows experience for greater productivity. For more info on [PowerToys overviews and how to use the utilities][usingPowerToys-docs-link], or any other tools and resources for [Windows development environments](https://learn.microsoft.com/windows/dev-environment/overview), head over to [learn.microsoft.com][usingPowerToys-docs-link]!
## 📋 Installation
| | Current utilities: | |
|--------------|--------------------|--------------|
| [Advanced Paste](https://aka.ms/PowerToysOverview_AdvancedPaste) | [Always on Top](https://aka.ms/PowerToysOverview_AoT) | [PowerToys Awake](https://aka.ms/PowerToysOverview_Awake) |
| [Color Picker](https://aka.ms/PowerToysOverview_ColorPicker) | [Command Not Found](https://aka.ms/PowerToysOverview_CmdNotFound) | [Command Palette](https://aka.ms/PowerToysOverview_CmdPal) |
| [Crop And Lock](https://aka.ms/PowerToysOverview_CropAndLock) | [Environment Variables](https://aka.ms/PowerToysOverview_EnvironmentVariables) | [FancyZones](https://aka.ms/PowerToysOverview_FancyZones) |
| [File Explorer Add-ons](https://aka.ms/PowerToysOverview_FileExplorerAddOns) | [File Locksmith](https://aka.ms/PowerToysOverview_FileLocksmith) | [Hosts File Editor](https://aka.ms/PowerToysOverview_HostsFileEditor) |
| [Image Resizer](https://aka.ms/PowerToysOverview_ImageResizer) | [Keyboard Manager](https://aka.ms/PowerToysOverview_KeyboardManager) | [Mouse Utilities](https://aka.ms/PowerToysOverview_MouseUtilities) |
| [Mouse Without Borders](https://aka.ms/PowerToysOverview_MouseWithoutBorders) | [New+](https://aka.ms/PowerToysOverview_NewPlus) | [Paste as Plain Text](https://aka.ms/PowerToysOverview_PastePlain) |
| [Peek](https://aka.ms/PowerToysOverview_Peek) | [PowerRename](https://aka.ms/PowerToysOverview_PowerRename) | [PowerToys Run](https://aka.ms/PowerToysOverview_PowerToysRun) |
| [Quick Accent](https://aka.ms/PowerToysOverview_QuickAccent) | [Registry Preview](https://aka.ms/PowerToysOverview_RegistryPreview) | [Screen Ruler](https://aka.ms/PowerToysOverview_ScreenRuler) |
| [Shortcut Guide](https://aka.ms/PowerToysOverview_ShortcutGuide) | [Text Extractor](https://aka.ms/PowerToysOverview_TextExtractor) | [Workspaces](https://aka.ms/PowerToysOverview_Workspaces) |
| [ZoomIt](https://aka.ms/PowerToysOverview_ZoomIt) |
For detailed installation instructions, visit the [installation docs](https://learn.microsoft.com/windows/powertoys/install).
## Installing and running Microsoft PowerToys
Before you begin, make sure your device meets the system requirements:
### Requirements
> [!NOTE]
> - Windows 11 or Windows 10 version 2004 (20H1 / build 19041) or newer
> - 64-bit processor: x64 or ARM64
> - Latest stable version of [Microsoft Edge WebView2 Runtime](https://go.microsoft.com/fwlink/p/?LinkId=2124703) is installed via the bootstrapper during setup
- Windows 11 or Windows 10 version 2004 (code name 20H1 / build number 19041) or newer.
- x64 or ARM64 processor
- Our installer will install the following items:
- [Microsoft Edge WebView2 Runtime](https://go.microsoft.com/fwlink/p/?LinkId=2124703) bootstrapper. This will install the latest version.
Choose one of the installation methods below:
### Via GitHub with EXE [Recommended]
<details>
<summary>Download .exe from GitHub</summary>
Go to the [Microsoft PowerToys GitHub releases page][github-release-link] and click on `Assets` at the bottom to show the files available in the release. Please use the appropriate PowerToys installer that matches your machine's architecture and install scope. For most, it is `x64` and per-user.
Go to the [PowerToys GitHub releases][github-release-link], click Assets to reveal the downloads, and choose the installer that matches your architecture and install scope. For most devices, that's the x64 per-user installer.
<!-- items that need to be updated release to release -->
[github-next-release-work]: https://github.com/microsoft/PowerToys/issues?q=is%3Aissue+milestone%3A%22PowerToys+0.95%22
@@ -49,57 +67,49 @@ Go to the [Microsoft PowerToys GitHub releases page][github-release-link] and cl
| Machine wide - x64 | [PowerToysSetup-0.94.0-x64.exe][ptMachineX64] |
| Machine wide - ARM64 | [PowerToysSetup-0.94.0-arm64.exe][ptMachineArm64] |
This is our preferred method.
</details>
### Via Microsoft Store
<details>
<summary>Microsoft Store</summary>
You can easily install PowerToys from the Microsoft Store:
<p>
<a style="text-decoration:none" href="https://aka.ms/getPowertoys">
<picture>
<source media="(prefers-color-scheme: light)" srcset="doc/images/readme/StoreBadge-dark.png" width="148" />
<img src="doc/images/readme/StoreBadge-light.png" width="148" />
</picture></a>
</p>
</details>
Install from the [Microsoft Store's PowerToys page][microsoft-store-link]. You must be using the [new Microsoft Store](https://blogs.windows.com/windowsExperience/2021/06/24/building-a-new-open-microsoft-store-on-windows-11/), which is available for both Windows 11 and Windows 10.
### Via WinGet
<details>
<summary>WinGet</summary>
Download PowerToys from [WinGet][winget-link]. Updating PowerToys via winget will respect the current PowerToys installation scope. To install PowerToys, run the following command from the command line / PowerShell:
#### User scope installer [default]
*User scope installer [default]*
```powershell
winget install Microsoft.PowerToys -s winget
```
#### Machine-wide scope installer
*Machine-wide scope installer*
```powershell
winget install --scope machine Microsoft.PowerToys -s winget
```
</details>
### Other install methods
<details>
<summary>Other methods</summary>
There are [community driven install methods](./doc/unofficialInstallMethods.md) such as Chocolatey and Scoop. If these are your preferred install solutions, you can find the install instructions there.
</details>
## Third-Party Run Plugins
## ✨ What's new
**Version 0.94 (September 2025)**
There is a collection of [third-party plugins](./doc/thirdPartyRunPlugins.md) created by the community that aren't distributed with PowerToys.
For an in-depth look at the latest changes, visit the [Windows Command Line blog](https://aka.ms/powertoys-releaseblog).
## Contributing
This project welcomes contributions of all types. Besides coding features / bug fixes, other ways to assist include spec writing, design, documentation, and finding bugs. We are excited to work with the power user community to build a set of tools for helping you get the most out of Windows.
We ask that **before you start work on a feature that you would like to contribute**, please read our [Contributor's Guide](CONTRIBUTING.md). We would be happy to work with you to figure out the best approach, provide guidance and mentorship throughout feature development, and help avoid any wasted or duplicate effort.
Most contributions require you to agree to a [Contributor License Agreement (CLA)][oss-CLA] declaring that you grant us the rights to use your contribution and that you have permission to do so.
For guidance on developing for PowerToys, please read the [developer docs](./doc/devdocs) for a detailed breakdown. This includes how to setup your computer to compile.
## What's Happening
### PowerToys Roadmap
Our [prioritized roadmap][roadmap] of features and utilities that the core team is focusing on.
### 0.94 - Sep 2025 Update
In this release, we focused on new features, stability, optimization improvements, and automation.
For an in-depth look at the latest changes, visit the [release blog](https://aka.ms/powertoys-releaseblog).
**✨Highlights**
**✨ Highlights**
- PowerToys Settings added a Settings search with fuzzy matching, suggestions, a results page, and UX polish to make finding options faster.
- A comprehensive hotkey conflict detection system was introduced in Settings to surface and help resolve conflicting shortcuts. Note that the default hotkey settings (Win+Ctrl+Shift+T, Win+Ctrl+V, Win+Ctrl+T, Win+Shift+T) may overlap with existing Windows system shortcuts. This is expected. You can resolve the conflict by assigning different hotkeys.
@@ -138,13 +148,13 @@ For an in-depth look at the latest changes, visit the [release blog](https://aka
- Allowed providers to override Dispose with a virtual method.
- Fixed memory leaks by cleaning up removed or cancelled list items.
- Sorted DateTime extension results by relevance for better usability.
- Reduced search text “jiggling” by avoiding redundant change notifications.
- Reduced search text "jiggling" by avoiding redundant change notifications.
- Centralized automation notifications in a UIHelper for better accessibility. Thanks [@chatasweetie](https://github.com/chatasweetie)!
- Preserved Adaptive Card action types during trimming via DynamicDependency.
- Added an acrylic backdrop and refined styling to the context menu. Thanks [@jiripolasek](https://github.com/jiripolasek)!
- Prevented disposed pages and Settings windows from handling stale messages. Thanks [@jiripolasek](https://github.com/jiripolasek)!
- Made the extension API easier to evolve without breaking clients.
- Added “evil” sample pages to help reproduce tricky bugs.
- Added "evil" sample pages to help reproduce tricky bugs.
- Fixed WinGet trim-safety issues by replacing LINQ with manual iteration.
- Cancelled stale list fetches to avoid older results overwriting newer ones in CmdPal.
@@ -220,10 +230,10 @@ For an in-depth look at the latest changes, visit the [release blog](https://aka
- Rewrote system command tests with a new test base and cleaner patterns.
- Added unit tests for WebSearch and Shell extensions with mockable settings.
- Added unit tests and abstractions for Apps and Bookmarks extensions.
- Cleans up AI‑generated tests; adds meaningful query tests across extensions.
- Cleans up AI-generated tests; adds meaningful query tests across extensions.
- Removed the obsolete debug dialog from Settings for a smoother developer loop.
### What is being planned over the next few releases
## 🛣️ Roadmap
For [v0.95][github-next-release-work], we'll work on the items below:
@@ -235,9 +245,19 @@ For [v0.95][github-next-release-work], we'll work on the items below:
- New UI automation tests
- Stability, bug fixes
## PowerToys Community
## ❤️ PowerToys Community
The PowerToys team is extremely grateful to have the [support of an amazing active community][community-link]. The work you do is incredibly important. PowerToys wouldn’t be nearly what it is today without your help filing bugs, updating documentation, guiding the design, or writing features. We want to say thank you and take time to recognize your work. Month by month, you directly help make PowerToys a better piece of software.
The PowerToys team is extremely grateful to have the [support of an amazing active community][community-link]. The work you do is incredibly important. PowerToys wouldn't be nearly what it is today without your help filing bugs, updating documentation, guiding the design, or writing features. We want to say thank you and take time to recognize your work. Your contributions and feedback improve PowerToys month after month!
## Contributing
This project welcomes contributions of all types. Besides coding features / bug fixes, other ways to assist include spec writing, design, documentation, and finding bugs. We are excited to work with the power user community to build a set of tools for helping you get the most out of Windows.
We ask that **before you start work on a feature that you would like to contribute**, please read our [Contributor's Guide](CONTRIBUTING.md). We would be happy to work with you to figure out the best approach, provide guidance and mentorship throughout feature development, and help avoid any wasted or duplicate effort.
Most contributions require you to agree to a [Contributor License Agreement (CLA)][oss-CLA] declaring that you grant us the rights to use your contribution and that you have permission to do so.
For guidance on developing for PowerToys, please read the [developer docs](./doc/devdocs) for a detailed breakdown. This includes how to setup your computer to compile.
## Code of Conduct

83
doc/dsc/Settings.md Normal file
View File

@@ -0,0 +1,83 @@
# Settings resource
Manage the settings for PowerToys modules
## Commands
### ✨ Modules
List all the modules supported by the settings resource.
```shell
PS C:\> PowerToys.DSC.exe modules --resource 'settings'
AdvancedPaste
AlwaysOnTop
App
Awake
ColorPicker
CropAndLock
EnvironmentVariables
FancyZones
FileLocksmith
FindMyMouse
Hosts
ImageResizer
KeyboardManager
MeasureTool
MouseHighlighter
MouseJump
MousePointerCrosshairs
Peek
PowerAccent
PowerOCR
PowerRename
RegistryPreview
ShortcutGuide
Workspaces
ZoomIt
```
### 📄 Get
Get the settings for a specific module.
```shell
PS C:\> PowerToys.DSC.exe get --resource 'settings' --module EnvironmentVariables
{"settings":{"properties":{"LaunchAdministrator":{"value":true}},"name":"EnvironmentVariables","version":"1.0"}}
```
### 🖨️ Export
Export the settings for a specific module.
ℹ️ Settings resource Get and Export operation output states are identical.
```shell
PS C:\> PowerToys.DSC.exe get --resource 'settings' --module EnvironmentVariables
{"settings":{"properties":{"LaunchAdministrator":{"value":true}},"name":"EnvironmentVariables","version":"1.0"}}
```
### 📝 Set
Set the settings for a specific module. This command will update the settings to the specified values.
```shell
PS C:\> PowerToys.DSC.exe set --resource 'settings' --module Awake --input '{"settings":{"properties":{"keepDisplayOn":false,"mode":0,"intervalHours":0,"intervalMinutes":1,"expirationDateTime":"2025-08-13T10:10:00.000001-07:00","customTrayTimes":{}},"name":"Awake","version":"0.0.1"}}'
{"settings":{"properties":{"keepDisplayOn":false,"mode":0,"intervalHours":0,"intervalMinutes":1,"expirationDateTime":"2025-08-13T10:10:00.000001-07:00","customTrayTimes":{}},"name":"Awake","version":"0.0.1"}}
["settings"]
```
### 🧪 Test
Test the settings for a specific module. This command will check if the current settings match the desired state.
```shell
PS C:\> PowerToys.DSC.exe test --resource 'settings' --module Awake --input '{"settings":{"properties":{"keepDisplayOn":false,"mode":0,"intervalHours":0,"intervalMinutes":1,"expirationDateTime":"2025-08-13T10:10:00.000002-07:00","customTrayTimes":{}},"name":"Awake","version":"0.0.1"}}'
{"settings":{"properties":{"keepDisplayOn":false,"mode":0,"intervalHours":0,"intervalMinutes":1,"expirationDateTime":"2025-08-13T10:10:00.000001-07:00","customTrayTimes":{}},"name":"Awake","version":"0.0.1"},"_inDesiredState":false}
["settings"]
```
### 🛠️ Schema
Generates the JSON schema for the settings resource of a specific module.
```shell
PS C:\> PowerToys.DSC.exe schema --resource 'settings' --module Awake
{"$schema":"http://json-schema.org/draft-04/schema#","title":"SettingsResourceObjectOfAwakeSettings","type":"object","additionalProperties":false,"required":["settings"],"properties":{"_inDesiredState":{"type":["boolean","null"],"description":"Indicates whether an instance is in the desired state"},"settings":{"description":"The settings content for the module."}}}
PS E:\src\powertoys> PowerToys.DSC.exe schema --resource 'settings' --module Awake | Format-Json
```
### 📦 Manifest
Generates a manifest dsc resource JSON file for the specified module.
- If the module is not specified, it will generate a manifest for all modules.
- If the output directory is not specified, it will print the manifest to the console.
```shell
PS C:\> PowerToys.DSC.exe manifest --resource settings --module 'Awake' --outputDir "C:\manifests"
```

BIN
doc/images/icons/Command Palette.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

BIN
doc/images/icons/ZoomIt.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
doc/images/overview/PT_hero_image.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 394 KiB

BIN
doc/images/overview/PT_large.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 99 KiB

BIN
doc/images/overview/PT_small.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 33 KiB

BIN
doc/images/readme/StoreBadge-dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

BIN
doc/images/readme/StoreBadge-light.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
doc/images/readme/pt-hero.dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 464 KiB

BIN
doc/images/readme/pt-hero.light.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 502 KiB

1
doc/thirdPartyRunPlugins.md
View File

@@ -50,6 +50,7 @@ Contact the developers of a plugin directly for assistance with a specific plugi
| [Hotkeys](https://github.com/ruslanlap/PowerToysRun-Hotkeys) | [ruslanlap](https://github.com/ruslanlap) | Create, manage, and trigger custom keyboard shortcuts directly from PowerToys Run. |
| [RandomGen](https://github.com/ruslanlap/PowerToysRun-RandomGen) | [ruslanlap](https://github.com/ruslanlap) | 🎲 Generate random data instantly with a single keystroke. Perfect for developers, testers, designers, and anyone who needs quick access to random data. Features include secure passwords, PINs, names, business data, dates, numbers, GUIDs, color codes, and more. Especially useful for designers who need random color codes and placeholder content. |
| [Open With Cursor](https://github.com/VictorNoxx/PowerToys-Run-Cursor/) | [VictorNoxx](https://github.com/VictorNoxx) | Open Visual Studio, VS Code recents with Cursor AI |
| [CheatSheets](https://github.com/ruslanlap/PowerToysRun-CheatSheets) | [ruslanlap](https://github.com/ruslanlap) | 📚 Find cheat sheets and command examples instantly from tldr pages, cheat.sh, and devhints.io. Features include favorites system, categories, offline mode, and smart caching. |
## Extending software plugins

3
installer/PowerToysSetup/PowerToysInstaller.wixproj
View File

@@ -16,6 +16,7 @@ SET PTRoot=$(SolutionDir)\..
call "..\..\..\publish.cmd" x64
)
call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuildThisFileDirectory)\generateMonacoWxs.ps1 -monacoWxsFile "$(MSBuildThisFileDirectory)\MonacoSRC.wxs"
call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuildThisFileDirectory)\generateDscResourcesWxs.ps1 -dscWxsFile "$(MSBuildThisFileDirectory)\DscResources.wxs" -Platform "$(Platform)" -Configuration "$(Configuration)"
</PreBuildEvent>
</PropertyGroup>
<PropertyGroup Condition="'$(Platform)' != 'x64'">
@@ -26,6 +27,7 @@ SET PTRoot=$(SolutionDir)\..
call "..\..\..\publish.cmd" arm64
)
call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuildThisFileDirectory)\generateMonacoWxs.ps1 -monacoWxsFile "$(MSBuildThisFileDirectory)\MonacoSRC.wxs"
call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuildThisFileDirectory)\generateDscResourcesWxs.ps1 -dscWxsFile "$(MSBuildThisFileDirectory)\DscResources.wxs" -Platform "$(Platform)" -Configuration "$(Configuration)"
</PreBuildEvent>
</PropertyGroup>
<PropertyGroup>
@@ -121,6 +123,7 @@ call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuil
<Compile Include="Hosts.wxs" />
<Compile Include="ImageResizer.wxs" />
<Compile Include="KeyboardManager.wxs" />
<Compile Include="DscResources.wxs" />
<Compile Include="Peek.wxs" />
<Compile Include="PowerRename.wxs" />
<Compile Include="RegistryPreview.wxs" />

2
installer/PowerToysSetup/Product.wxs
View File

@@ -75,6 +75,7 @@
<ComponentGroupRef Id="NewPlusComponentGroup" />
<ComponentGroupRef Id="NewPlusTemplatesComponentGroup" />
<ComponentGroupRef Id="ResourcesComponentGroup" />
<ComponentGroupRef Id="DscResourcesComponentGroup" />
<ComponentGroupRef Id="WindowsAppSDKComponentGroup" />
<ComponentGroupRef Id="ToolComponentGroup" />
<ComponentGroupRef Id="MonacoSRCHeatGenerated" />
@@ -324,7 +325,6 @@
BinaryKey="PTCustomActions"
DllEntry="UninstallDSCModuleCA"
/>
<CustomAction Id="UninstallServicesTask"
Return="ignore"
Impersonate="yes"

87
installer/PowerToysSetup/generateDscResourcesWxs.ps1 Normal file
View File

@@ -0,0 +1,87 @@
[CmdletBinding()]
Param(
[Parameter(Mandatory = $True)]
[string]$dscWxsFile,
[Parameter(Mandatory = $True)]
[string]$Platform,
[Parameter(Mandatory = $True)]
[string]$Configuration
)
$ErrorActionPreference = 'Stop'
$scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
$buildOutputDir = Join-Path $scriptDir "..\..\$Platform\$Configuration"
if (-not (Test-Path $buildOutputDir)) {
Write-Error "Build output directory not found: '$buildOutputDir'"
exit 1
}
$dscFiles = Get-ChildItem -Path $buildOutputDir -Filter "microsoft.powertoys.*.settings.dsc.resource.json" -File
if (-not $dscFiles) {
Write-Warning "No DSC manifest files found in '$buildOutputDir'"
$wxsContent = @"
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<?include `$(sys.CURRENTDIR)\Common.wxi?>
<Fragment>
<ComponentGroup Id="DscResourcesComponentGroup">
</ComponentGroup>
</Fragment>
</Wix>
"@
Set-Content -Path $dscWxsFile -Value $wxsContent
exit 0
}
Write-Host "Found $($dscFiles.Count) DSC manifest file(s)"
$wxsContent = @"
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<?include `$(sys.CURRENTDIR)\Common.wxi?>
<Fragment>
<DirectoryRef Id="DSCModulesReferenceFolder">
"@
$componentRefs = @()
foreach ($file in $dscFiles) {
$componentId = "DscResource_" + ($file.BaseName -replace '[^A-Za-z0-9_]', '_')
$fileId = $componentId + "_File"
$guid = [System.Guid]::NewGuid().ToString().ToUpper()
$componentRefs += $componentId
$wxsContent += @"
<Component Id="$componentId" Guid="{$guid}">
<RegistryKey Root="`$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
<RegistryValue Type="string" Name="$componentId" Value="" KeyPath="yes"/>
</RegistryKey>
<File Id="$fileId" Source="`$(var.BinDir)$($file.Name)" Vital="no"/>
</Component>
"@
}
$wxsContent += @"
</DirectoryRef>
</Fragment>
<Fragment>
<ComponentGroup Id="DscResourcesComponentGroup">
"@
foreach ($componentId in $componentRefs) {
$wxsContent += @"
<ComponentRef Id="$componentId"/>
"@
}
$wxsContent += @"
</ComponentGroup>
</Fragment>
</Wix>
"@
Set-Content -Path $dscWxsFile -Value $wxsContent
Write-Host "Generated DSC resources WiX fragment: '$dscWxsFile'"

131
installer/PowerToysSetupCustomActionsVNext/CustomAction.cpp
View File

@@ -3,6 +3,7 @@
#include "RcResource.h"
#include <ProjectTelemetry.h>
#include <spdlog/sinks/base_sink.h>
#include <filesystem>
#include "../../src/common/logger/logger.h"
#include "../../src/common/utils/gpo.h"
@@ -232,7 +233,9 @@ UINT __stdcall LaunchPowerToysCA(MSIHANDLE hInstall)
auto action = [&commandLine](HANDLE userToken)
{
STARTUPINFO startupInfo{.cb = sizeof(STARTUPINFO), .wShowWindow = SW_SHOWNORMAL};
STARTUPINFO startupInfo = { 0 };
startupInfo.cb = sizeof(STARTUPINFO);
startupInfo.wShowWindow = SW_SHOWNORMAL;
PROCESS_INFORMATION processInformation;
PVOID lpEnvironment = NULL;
@@ -271,7 +274,9 @@ UINT __stdcall LaunchPowerToysCA(MSIHANDLE hInstall)
}
else
{
STARTUPINFO startupInfo{.cb = sizeof(STARTUPINFO), .wShowWindow = SW_SHOWNORMAL};
STARTUPINFO startupInfo = { 0 };
startupInfo.cb = sizeof(STARTUPINFO);
startupInfo.wShowWindow = SW_SHOWNORMAL;
PROCESS_INFORMATION processInformation;
@@ -424,7 +429,7 @@ UINT __stdcall InstallDSCModuleCA(MSIHANDLE hInstall)
const auto modulesPath = baseModulesPath / L"Microsoft.PowerToys.Configure" / (get_product_version(false) + L".0");
std::error_code errorCode;
fs::create_directories(modulesPath, errorCode);
std::filesystem::create_directories(modulesPath, errorCode);
if (errorCode)
{
hr = E_FAIL;
@@ -433,7 +438,7 @@ UINT __stdcall InstallDSCModuleCA(MSIHANDLE hInstall)
for (const auto *filename : {DSC_CONFIGURE_PSD1_NAME, DSC_CONFIGURE_PSM1_NAME})
{
fs::copy_file(fs::path(installationFolder) / "DSCModules" / filename, modulesPath / filename, fs::copy_options::overwrite_existing, errorCode);
std::filesystem::copy_file(std::filesystem::path(installationFolder) / "DSCModules" / filename, modulesPath / filename, std::filesystem::copy_options::overwrite_existing, errorCode);
if (errorCode)
{
@@ -481,7 +486,7 @@ UINT __stdcall UninstallDSCModuleCA(MSIHANDLE hInstall)
for (const auto *filename : {DSC_CONFIGURE_PSD1_NAME, DSC_CONFIGURE_PSM1_NAME})
{
fs::remove(versionedModulePath / filename, errorCode);
std::filesystem::remove(versionedModulePath / filename, errorCode);
if (errorCode)
{
@@ -492,7 +497,7 @@ UINT __stdcall UninstallDSCModuleCA(MSIHANDLE hInstall)
for (const auto *modulePath : {&versionedModulePath, &powerToysModulePath})
{
fs::remove(*modulePath, errorCode);
std::filesystem::remove(*modulePath, errorCode);
if (errorCode)
{
@@ -1375,6 +1380,120 @@ UINT __stdcall TerminateProcessesCA(MSIHANDLE hInstall)
return WcaFinalize(er);
}
UINT __stdcall SetBundleInstallLocationCA(MSIHANDLE hInstall)
{
HRESULT hr = S_OK;
UINT er = ERROR_SUCCESS;
// Declare all variables at the beginning to avoid goto issues
std::wstring customActionData;
std::wstring installationFolder;
std::wstring bundleUpgradeCode;
std::wstring installScope;
bool isPerUser = false;
size_t pos1 = std::wstring::npos;
size_t pos2 = std::wstring::npos;
std::vector<HKEY> keysToTry;
hr = WcaInitialize(hInstall, "SetBundleInstallLocationCA");
ExitOnFailure(hr, "Failed to initialize");
// Parse CustomActionData: "installFolder;upgradeCode;installScope"
hr = getInstallFolder(hInstall, customActionData);
ExitOnFailure(hr, "Failed to get CustomActionData.");
pos1 = customActionData.find(L';');
if (pos1 == std::wstring::npos)
{
hr = E_INVALIDARG;
ExitOnFailure(hr, "Invalid CustomActionData format - missing first semicolon");
}
pos2 = customActionData.find(L';', pos1 + 1);
if (pos2 == std::wstring::npos)
{
hr = E_INVALIDARG;
ExitOnFailure(hr, "Invalid CustomActionData format - missing second semicolon");
}
installationFolder = customActionData.substr(0, pos1);
bundleUpgradeCode = customActionData.substr(pos1 + 1, pos2 - pos1 - 1);
installScope = customActionData.substr(pos2 + 1);
isPerUser = (installScope == L"perUser");
// Use the appropriate registry based on install scope
HKEY targetKey = isPerUser ? HKEY_CURRENT_USER : HKEY_LOCAL_MACHINE;
const wchar_t* keyName = isPerUser ? L"HKCU" : L"HKLM";
WcaLog(LOGMSG_STANDARD, "SetBundleInstallLocationCA: Searching for Bundle in %ls registry", keyName);
HKEY uninstallKey;
LONG openResult = RegOpenKeyExW(targetKey, L"SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall", 0, KEY_READ | KEY_ENUMERATE_SUB_KEYS, &uninstallKey);
if (openResult != ERROR_SUCCESS)
{
WcaLog(LOGMSG_STANDARD, "SetBundleInstallLocationCA: Failed to open uninstall key, error: %ld", openResult);
goto LExit;
}
DWORD index = 0;
wchar_t subKeyName[256];
DWORD subKeyNameSize = sizeof(subKeyName) / sizeof(wchar_t);
while (RegEnumKeyExW(uninstallKey, index, subKeyName, &subKeyNameSize, nullptr, nullptr, nullptr, nullptr) == ERROR_SUCCESS)
{
HKEY productKey;
if (RegOpenKeyExW(uninstallKey, subKeyName, 0, KEY_READ | KEY_WRITE, &productKey) == ERROR_SUCCESS)
{
wchar_t upgradeCode[256];
DWORD upgradeCodeSize = sizeof(upgradeCode);
DWORD valueType;
if (RegQueryValueExW(productKey, L"BundleUpgradeCode", nullptr, &valueType,
reinterpret_cast<LPBYTE>(upgradeCode), &upgradeCodeSize) == ERROR_SUCCESS)
{
// Remove brackets from registry upgradeCode for comparison (bundleUpgradeCode doesn't have brackets)
std::wstring regUpgradeCode = upgradeCode;
if (!regUpgradeCode.empty() && regUpgradeCode.front() == L'{' && regUpgradeCode.back() == L'}')
{
regUpgradeCode = regUpgradeCode.substr(1, regUpgradeCode.length() - 2);
}
if (_wcsicmp(regUpgradeCode.c_str(), bundleUpgradeCode.c_str()) == 0)
{
// Found matching Bundle, set InstallLocation
LONG setResult = RegSetValueExW(productKey, L"InstallLocation", 0, REG_SZ,
reinterpret_cast<const BYTE*>(installationFolder.c_str()),
static_cast<DWORD>((installationFolder.length() + 1) * sizeof(wchar_t)));
if (setResult == ERROR_SUCCESS)
{
WcaLog(LOGMSG_STANDARD, "SetBundleInstallLocationCA: InstallLocation set successfully");
}
else
{
WcaLog(LOGMSG_STANDARD, "SetBundleInstallLocationCA: Failed to set InstallLocation, error: %ld", setResult);
}
RegCloseKey(productKey);
RegCloseKey(uninstallKey);
goto LExit;
}
}
RegCloseKey(productKey);
}
index++;
subKeyNameSize = sizeof(subKeyName) / sizeof(wchar_t);
}
RegCloseKey(uninstallKey);
LExit:
er = SUCCEEDED(hr) ? ERROR_SUCCESS : ERROR_INSTALL_FAILURE;
return WcaFinalize(er);
}
void initSystemLogger()
{
static std::once_flag initLoggerFlag;

2
installer/PowerToysSetupCustomActionsVNext/CustomAction.def
View File

@@ -32,4 +32,4 @@ EXPORTS
CleanFileLocksmithRuntimeRegistryCA
CleanPowerRenameRuntimeRegistryCA
CleanNewPlusRuntimeRegistryCA
SetBundleInstallLocationCA

24
installer/PowerToysSetupVNext/Core.wxs
View File

@@ -9,6 +9,25 @@
<RegistryValue Type="string" Name="InstallScope" Value="$(var.InstallScope)" />
</RegistryKey>
</Component>
<?if $(var.PerUser) = "true" ?>
<Component Id="powertoys_env_path_user" Bitness="always64">
<!-- Anchor registry for component key path -->
<RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
<RegistryValue Type="string" Name="powertoys_env_path_user" Value="" KeyPath="yes" />
</RegistryKey>
<!-- Append install folder to current user's PATH -->
<Environment Id="AddPowerToysToUserPath" Name="PATH" Action="set" Part="last" System="no" Value="[INSTALLFOLDER]" />
</Component>
<?else?>
<Component Id="powertoys_env_path_machine" Bitness="always64">
<!-- Anchor registry for component key path -->
<RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
<RegistryValue Type="string" Name="powertoys_env_path_machine" Value="" KeyPath="yes" />
</RegistryKey>
<!-- Append install folder to machine PATH -->
<Environment Id="AddPowerToysToMachinePath" Name="PATH" Action="set" Part="last" System="yes" Value="[INSTALLFOLDER]" />
</Component>
<?endif?>
<Component Id="powertoys_toast_clsid" Bitness="always64">
<RemoveFolder Id="Remove_powertoys_toast_clsid" On="uninstall" />
<RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\CLSID\{DD5CACDA-7C2E-4997-A62A-04A597B58F76}">
@@ -109,6 +128,11 @@
<ComponentRef Id="powertoys_exe" />
<ComponentRef Id="PowerToysStartMenuShortcut" />
<ComponentRef Id="powertoys_per_machine_comp" />
<?if $(var.PerUser) = "true" ?>
<ComponentRef Id="powertoys_env_path_user" />
<?else?>
<ComponentRef Id="powertoys_env_path_machine" />
<?endif?>
<ComponentRef Id="powertoys_toast_clsid" />
<ComponentRef Id="License_rtf" />
<ComponentRef Id="Notice_md" />

4
installer/PowerToysSetupVNext/PowerToys.wxs
View File

@@ -28,6 +28,9 @@
<Log Disable="no" Prefix="powertoys-bootstrapper-msi-$(var.Version)" Extension=".log" />
<!-- Store Bundle UpgradeCode for CustomAction -->
<Variable Name="BundleUpgradeCode" Type="string" Value="$(var.UpgradeCode)" />
<!-- Only install/upgrade if the version is greater or equal than the currently installed version of PowerToys, to handle the case in which PowerToys was installed from old MSI (before WiX bootstrapper was used) -->
<!-- If the previous installation is a bundle installation, just let WiX run its logic. -->
<Variable Name="MinimumVersion" Type="version" Value="0.0.0.0" />
@@ -58,6 +61,7 @@
<MsiPackage DisplayName="PowerToys MSI" SourceFile="$(var.PowerToysPlatform)\Release\$(var.MSIPath)\$(var.MSIName)" Compressed="yes" bal:DisplayInternalUICondition="false">
<MsiProperty Name="BOOTSTRAPPERINSTALLFOLDER" Value="[InstallFolder]" />
<MsiProperty Name="MSIRESTARTMANAGERCONTROL" Value="Disable" />
<MsiProperty Name="BUNDLEINFO" Value="[BundleUpgradeCode]" />
</MsiPackage>
</Chain>
</Bundle>

3
installer/PowerToysSetupVNext/PowerToysInstallerVNext.wixproj
View File

@@ -14,6 +14,7 @@ SET PTRoot=$(SolutionDir)\..
call "..\..\..\publish.cmd" x64
)
call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuildThisFileDirectory)\generateMonacoWxs.ps1 -monacoWxsFile "$(MSBuildThisFileDirectory)\MonacoSRC.wxs" -Platform "$(Platform)" -nugetHeatPath "$(NUGET_PACKAGES)\wixtoolset.heat\5.0.2"
call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuildThisFileDirectory)\generateDscResourcesWxs.ps1 -dscWxsFile "$(MSBuildThisFileDirectory)\DscResources.wxs" -Platform "$(Platform)" -Configuration "$(Configuration)"
</PreBuildEvent>
</PropertyGroup>
<PropertyGroup Condition="'$(Platform)' != 'x64'">
@@ -24,6 +25,7 @@ SET PTRoot=$(SolutionDir)\..
call "..\..\..\publish.cmd" arm64
)
call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuildThisFileDirectory)\generateMonacoWxs.ps1 -monacoWxsFile "$(MSBuildThisFileDirectory)\MonacoSRC.wxs" -Platform "$(Platform)" -nugetHeatPath "$(NUGET_PACKAGES)\wixtoolset.heat\5.0.2"
call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuildThisFileDirectory)\generateDscResourcesWxs.ps1 -dscWxsFile "$(MSBuildThisFileDirectory)\DscResources.wxs" -Platform "$(Platform)" -Configuration "$(Configuration)"
</PreBuildEvent>
</PropertyGroup>
<PropertyGroup>
@@ -115,6 +117,7 @@ call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuil
<Compile Include="KeyboardManager.wxs" />
<Compile Include="Peek.wxs" />
<Compile Include="PowerRename.wxs" />
<Compile Include="DscResources.wxs" />
<Compile Include="RegistryPreview.wxs" />
<Compile Include="Run.wxs" />
<Compile Include="Settings.wxs" />

12
installer/PowerToysSetupVNext/Product.wxs
View File

@@ -62,6 +62,7 @@
<ComponentGroupRef Id="NewPlusComponentGroup" />
<ComponentGroupRef Id="NewPlusTemplatesComponentGroup" />
<ComponentGroupRef Id="ResourcesComponentGroup" />
<ComponentGroupRef Id="DscResourcesComponentGroup" />
<ComponentGroupRef Id="WindowsAppSDKComponentGroup" />
<ComponentGroupRef Id="ToolComponentGroup" />
<ComponentGroupRef Id="MonacoSRCHeatGenerated" />
@@ -69,8 +70,8 @@
<ComponentGroupRef Id="CmdPalComponentGroup" />
</Feature>
<SetProperty Id="ARPINSTALLLOCATION" Value="[INSTALLFOLDER]" After="CostFinalize" />
<SetProperty Id="ARPINSTALLLOCATION" Value="[INSTALLFOLDER]" After="CostFinalize" Sequence="execute" />
<Property Id="WIXUI_INSTALLDIR" Value="INSTALLFOLDER" />
<UI>
@@ -117,6 +118,8 @@
<Custom Action="SetUnApplyModulesRegistryChangeSetsParam" Before="UnApplyModulesRegistryChangeSets" />
<Custom Action="CheckGPO" After="InstallInitialize" Condition="NOT Installed" />
<Custom Action="SetBundleInstallLocationData" Before="SetBundleInstallLocation" Condition="NOT Installed" />
<Custom Action="SetBundleInstallLocation" After="InstallFiles" Condition="NOT Installed" />
<Custom Action="ApplyModulesRegistryChangeSets" After="InstallFiles" Condition="NOT Installed" />
<Custom Action="InstallCmdPalPackage" After="InstallFiles" Condition="NOT Installed" />
<Custom Action="override Wix4CloseApplications_$(sys.BUILDARCHSHORT)" Before="RemoveFiles" />
@@ -160,6 +163,9 @@
<CustomAction Id="SetInstallCmdPalPackageParam" Property="InstallCmdPalPackage" Value="[INSTALLFOLDER]" />
<!-- Set InstallLocation for Bundle entry as well -->
<CustomAction Id="SetBundleInstallLocationData" Property="SetBundleInstallLocation" Value="[INSTALLFOLDER];[BUNDLEINFO];[InstallScope]" />
<CustomAction Id="LaunchPowerToys" Return="ignore" Impersonate="yes" Execute="deferred" DllEntry="LaunchPowerToysCA" BinaryRef="PTCustomActions" />
<CustomAction Id="TerminateProcesses" Return="ignore" Execute="immediate" DllEntry="TerminateProcessesCA" BinaryRef="PTCustomActions" />
@@ -244,6 +250,8 @@
<CustomAction Id="InstallCmdPalPackage" Return="ignore" Impersonate="yes" Execute="deferred" DllEntry="InstallCmdPalPackageCA" BinaryRef="PTCustomActions" />
<CustomAction Id="SetBundleInstallLocation" Return="ignore" Impersonate="no" Execute="deferred" DllEntry="SetBundleInstallLocationCA" BinaryRef="PTCustomActions" />
<!-- Close 'PowerToys.exe' before uninstall-->
<Property Id="MSIRESTARTMANAGERCONTROL" Value="DisableShutdown" />
<Property Id="MSIFASTINSTALL" Value="DisableShutdown" />

102
installer/PowerToysSetupVNext/generateDscResourcesWxs.ps1 Normal file
View File

@@ -0,0 +1,102 @@
[CmdletBinding()]
Param(
[Parameter(Mandatory = $True)]
[string]$dscWxsFile,
[Parameter(Mandatory = $True)]
[string]$Platform,
[Parameter(Mandatory = $True)]
[string]$Configuration
)
$ErrorActionPreference = 'Stop'
$scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
# Find build output directory
$buildOutputDir = Join-Path $scriptDir "..\..\$Platform\$Configuration"
if (-not (Test-Path $buildOutputDir)) {
Write-Error "Build output directory not found: '$buildOutputDir'"
exit 1
}
# Find all DSC manifest JSON files
$dscFiles = Get-ChildItem -Path $buildOutputDir -Filter "microsoft.powertoys.*.settings.dsc.resource.json" -File
if (-not $dscFiles) {
Write-Warning "No DSC manifest files found in '$buildOutputDir'"
# Create empty component group
$wxsContent = @"
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
<?include `$(sys.CURRENTDIR)\Common.wxi?>
<Fragment>
<ComponentGroup Id="DscResourcesComponentGroup">
</ComponentGroup>
</Fragment>
</Wix>
"@
Set-Content -Path $dscWxsFile -Value $wxsContent
exit 0
}
Write-Host "Found $($dscFiles.Count) DSC manifest file(s)"
# Generate WiX fragment
$wxsContent = @"
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
<?include `$(sys.CURRENTDIR)\Common.wxi?>
<Fragment>
<DirectoryRef Id="DSCModulesReferenceFolder">
"@
$componentRefs = @()
foreach ($file in $dscFiles) {
$componentId = "DscResource_" + ($file.BaseName -replace '[^A-Za-z0-9_]', '_')
$fileId = $componentId + "_File"
$guid = [System.Guid]::NewGuid().ToString().ToUpper()
$componentRefs += $componentId
$wxsContent += @"
<Component Id="$componentId" Guid="{$guid}" Directory="DSCModulesReferenceFolder">
<RegistryKey Root="`$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
<RegistryValue Type="string" Name="$componentId" Value="" KeyPath="yes"/>
</RegistryKey>
<File Id="$fileId" Source="`$(var.BinDir)$($file.Name)" Vital="no"/>
</Component>
"@
}
$wxsContent += @"
</DirectoryRef>
</Fragment>
<Fragment>
<ComponentGroup Id="DscResourcesComponentGroup">
"@
foreach ($componentId in $componentRefs) {
$wxsContent += @"
<ComponentRef Id="$componentId"/>
"@
}
$wxsContent += @"
</ComponentGroup>
</Fragment>
</Wix>
"@
# Write the WiX file
Set-Content -Path $dscWxsFile -Value $wxsContent
Write-Host "Generated DSC resources WiX fragment: '$dscWxsFile'"

3
src/CmdPalVersion.props
View File

@@ -2,7 +2,10 @@
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<CmdPalVersion Condition="'$(CmdPalVersion)'=='' and '$(XES_APPXMANIFESTVERSION)'!=''">$(XES_APPXMANIFESTVERSION)</CmdPalVersion>
<!-- MIKE: The file you're looking for is src/modules/cmdpal/custom.props -->
<CmdPalVersion Condition="'$(CmdPalVersion)'==''">0.0.1.0</CmdPalVersion>
<DevEnvironment>Local</DevEnvironment>
<!-- Forcing for every DLL on by default -->

68
src/dsc/v3/PowerToys.DSC.UnitTests/BaseDscTest.cs Normal file
View File

@@ -0,0 +1,68 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.CommandLine;
using System.CommandLine.Parsing;
using System.Globalization;
using System.IO;
using System.Resources;
using PowerToys.DSC.UnitTests.Models;
namespace PowerToys.DSC.UnitTests;
public class BaseDscTest
{
private readonly ResourceManager _resourceManager;
public BaseDscTest()
{
_resourceManager = new ResourceManager("PowerToys.DSC.Properties.Resources", typeof(PowerToys.DSC.Program).Assembly);
}
/// <summary>
/// Returns the string resource for the given name, formatted with the provided arguments.
/// </summary>
/// <param name="name">The name of the resource string.</param>
/// <param name="args">The arguments to format the resource string with.</param>
/// <returns></returns>
public string GetResourceString(string name, params string[] args)
{
return string.Format(CultureInfo.InvariantCulture, _resourceManager.GetString(name, CultureInfo.InvariantCulture), args);
}
/// <summary>
/// Execute a dsc command with the provided arguments.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="args"></param>
/// <returns></returns>
protected DscExecuteResult ExecuteDscCommand<T>(params string[] args)
where T : Command, new()
{
var originalOut = Console.Out;
var originalErr = Console.Error;
var outSw = new StringWriter();
var errSw = new StringWriter();
try
{
Console.SetOut(outSw);
Console.SetError(errSw);
var executeResult = new T().Invoke(args);
var output = outSw.ToString();
var errorOutput = errSw.ToString();
return new(executeResult == 0, output, errorOutput);
}
finally
{
Console.SetOut(originalOut);
Console.SetError(originalErr);
outSw.Dispose();
errSw.Dispose();
}
}
}

37
src/dsc/v3/PowerToys.DSC.UnitTests/CommandTest.cs Normal file
View File

@@ -0,0 +1,37 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using Microsoft.VisualStudio.TestTools.UnitTesting;
using PowerToys.DSC.Commands;
using PowerToys.DSC.DSCResources;
namespace PowerToys.DSC.UnitTests;
[TestClass]
public sealed class CommandTest : BaseDscTest
{
[TestMethod]
public void GetResource_Found_Success()
{
// Act
var result = ExecuteDscCommand<GetCommand>("--resource", SettingsResource.ResourceName);
// Assert
Assert.IsTrue(result.Success);
}
[TestMethod]
public void GetResource_NotFound_Fail()
{
// Arrange
var availableResources = string.Join(", ", BaseCommand.AvailableResources);
// Act
var result = ExecuteDscCommand<GetCommand>("--resource", "ResourceNotFound");
// Assert
Assert.IsFalse(result.Success);
Assert.Contains(GetResourceString("InvalidResourceNameError", availableResources), result.Error);
}
}

103
src/dsc/v3/PowerToys.DSC.UnitTests/Models/DscExecuteResult.cs Normal file
View File

@@ -0,0 +1,103 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text.Json;
using PowerToys.DSC.Models;
namespace PowerToys.DSC.UnitTests.Models;
/// <summary>
/// Result of executing a DSC command.
/// </summary>
public class DscExecuteResult
{
/// <summary>
/// Initializes a new instance of the <see cref="DscExecuteResult"/> class.
/// </summary>
/// <param name="success">Value indicating whether the command execution was successful.</param>
/// <param name="output">Output stream content.</param>
/// <param name="error">Error stream content.</param>
public DscExecuteResult(bool success, string output, string error)
{
Success = success;
Output = output;
Error = error;
}
/// <summary>
/// Gets a value indicating whether the command execution was successful.
/// </summary>
public bool Success { get; }
/// <summary>
/// Gets the output stream content of the operation.
/// </summary>
public string Output { get; }
/// <summary>
/// Gets the error stream content of the operation.
/// </summary>
public string Error { get; }
/// <summary>
/// Gets the messages from the error stream.
/// </summary>
/// <returns>List of messages with their levels.</returns>
public List<(DscMessageLevel Level, string Message)> Messages()
{
var lines = Error.Split([Environment.NewLine], StringSplitOptions.RemoveEmptyEntries);
return lines.SelectMany(line =>
{
var map = JsonSerializer.Deserialize<Dictionary<string, string>>(line);
return map.Select(v => (GetMessageLevel(v.Key), v.Value)).ToList();
}).ToList();
}
/// <summary>
/// Gets the output as state.
/// </summary>
/// <returns>State.</returns>
public T OutputState<T>()
{
var lines = Output.Split([Environment.NewLine], StringSplitOptions.RemoveEmptyEntries);
Debug.Assert(lines.Length == 1, "Output should contain exactly one line.");
return JsonSerializer.Deserialize<T>(lines[0]);
}
/// <summary>
/// Gets the output as state and diff.
/// </summary>
/// <returns>State and diff.</returns>
public (T State, List<string> Diff) OutputStateAndDiff<T>()
{
var lines = Output.Split([Environment.NewLine], StringSplitOptions.RemoveEmptyEntries);
Debug.Assert(lines.Length == 2, "Output should contain exactly two lines.");
var obj = JsonSerializer.Deserialize<T>(lines[0]);
var diff = JsonSerializer.Deserialize<List<string>>(lines[1]);
return (obj, diff);
}
/// <summary>
/// Gets the message level from a string representation.
/// </summary>
/// <param name="level">The string representation of the message level.</param>
/// <returns>The level as <see cref="DscMessageLevel"/>.</returns>
/// <exception cref="ArgumentOutOfRangeException">Thrown when the level is unknown.</exception>
private DscMessageLevel GetMessageLevel(string level)
{
return level switch
{
"error" => DscMessageLevel.Error,
"warn" => DscMessageLevel.Warning,
"info" => DscMessageLevel.Info,
"debug" => DscMessageLevel.Debug,
"trace" => DscMessageLevel.Trace,
_ => throw new ArgumentOutOfRangeException(nameof(level), level, "Unknown message level"),
};
}
}

17
src/dsc/v3/PowerToys.DSC.UnitTests/PowerToys.DSC.UnitTests.csproj Normal file
View File

@@ -0,0 +1,17 @@
<Project Sdk="Microsoft.NET.Sdk">
<!-- Look at Directory.Build.props in root for common stuff as well -->
<Import Project="..\..\..\Common.Dotnet.CsWinRT.props" />
<PropertyGroup>
<IsPackable>false</IsPackable>
<OutputPath>..\..\..\..\$(Configuration)\$(Platform)\tests\PowerToys.DSC.Tests\</OutputPath>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="MSTest" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\PowerToys.DSC\PowerToys.DSC.csproj" />
</ItemGroup>
</Project>

34
src/dsc/v3/PowerToys.DSC.UnitTests/SettingsResourceTests/SettingsResourceAdvancedPasteModuleTest.cs Normal file
View File

@@ -0,0 +1,34 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.VisualStudio.TestTools.UnitTesting;
namespace PowerToys.DSC.UnitTests.SettingsResourceTests;
[TestClass]
public sealed class SettingsResourceAdvancedPasteModuleTest : SettingsResourceModuleTest<AdvancedPasteSettings>
{
public SettingsResourceAdvancedPasteModuleTest()
: base(nameof(ModuleType.AdvancedPaste))
{
}
protected override Action<AdvancedPasteSettings> GetSettingsModifier()
{
return s =>
{
s.Properties.ShowCustomPreview = !s.Properties.ShowCustomPreview;
s.Properties.CloseAfterLosingFocus = !s.Properties.CloseAfterLosingFocus;
s.Properties.IsAdvancedAIEnabled = !s.Properties.IsAdvancedAIEnabled;
s.Properties.AdvancedPasteUIShortcut = new HotkeySettings
{
Key = "mock",
Alt = true,
};
};
}
}

28
src/dsc/v3/PowerToys.DSC.UnitTests/SettingsResourceTests/SettingsResourceAlwaysOnTopModuleTest.cs Normal file
View File

@@ -0,0 +1,28 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.VisualStudio.TestTools.UnitTesting;
namespace PowerToys.DSC.UnitTests.SettingsResourceTests;
[TestClass]
public sealed class SettingsResourceAlwaysOnTopModuleTest : SettingsResourceModuleTest<AlwaysOnTopSettings>
{
public SettingsResourceAlwaysOnTopModuleTest()
: base(nameof(ModuleType.AlwaysOnTop))
{
}
protected override Action<AlwaysOnTopSettings> GetSettingsModifier()
{
return s =>
{
s.Properties.RoundCornersEnabled.Value = !s.Properties.RoundCornersEnabled.Value;
s.Properties.FrameEnabled.Value = !s.Properties.FrameEnabled.Value;
};
}
}

30
src/dsc/v3/PowerToys.DSC.UnitTests/SettingsResourceTests/SettingsResourceAppModuleTest.cs Normal file
View File

@@ -0,0 +1,30 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using PowerToys.DSC.DSCResources;
namespace PowerToys.DSC.UnitTests.SettingsResourceTests;
[TestClass]
public sealed class SettingsResourceAppModuleTest : SettingsResourceModuleTest<GeneralSettings>
{
public SettingsResourceAppModuleTest()
: base(SettingsResource.AppModule)
{
}
protected override Action<GeneralSettings> GetSettingsModifier()
{
return s =>
{
s.Startup = !s.Startup;
s.ShowSysTrayIcon = !s.ShowSysTrayIcon;
s.Enabled.Awake = !s.Enabled.Awake;
s.Enabled.ColorPicker = !s.Enabled.ColorPicker;
};
}
}

38
src/dsc/v3/PowerToys.DSC.UnitTests/SettingsResourceTests/SettingsResourceAwakeModuleTest.cs Normal file
View File

@@ -0,0 +1,38 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.VisualStudio.TestTools.UnitTesting;
namespace PowerToys.DSC.UnitTests.SettingsResourceTests;
[TestClass]
public sealed class SettingsResourceAwakeModuleTest : SettingsResourceModuleTest<AwakeSettings>
{
public SettingsResourceAwakeModuleTest()
: base(nameof(ModuleType.Awake))
{
}
protected override Action<AwakeSettings> GetSettingsModifier()
{
return s =>
{
s.Properties.ExpirationDateTime = DateTimeOffset.MinValue;
s.Properties.IntervalHours = DefaultSettings.Properties.IntervalHours + 1;
s.Properties.IntervalMinutes = DefaultSettings.Properties.IntervalMinutes + 1;
s.Properties.Mode = s.Properties.Mode == AwakeMode.PASSIVE ? AwakeMode.TIMED : AwakeMode.PASSIVE;
s.Properties.KeepDisplayOn = !s.Properties.KeepDisplayOn;
s.Properties.CustomTrayTimes = new Dictionary<string, uint>
{
{ "08:00", 1 },
{ "12:00", 2 },
{ "16:00", 3 },
};
};
}
}

28
src/dsc/v3/PowerToys.DSC.UnitTests/SettingsResourceTests/SettingsResourceColorPickerModuleTest.cs Normal file
View File

@@ -0,0 +1,28 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.VisualStudio.TestTools.UnitTesting;
namespace PowerToys.DSC.UnitTests.SettingsResourceTests;
[TestClass]
public sealed class SettingsResourceColorPickerModuleTest : SettingsResourceModuleTest<ColorPickerSettings>
{
public SettingsResourceColorPickerModuleTest()
: base(nameof(ModuleType.ColorPicker))
{
}
protected override Action<ColorPickerSettings> GetSettingsModifier()
{
return s =>
{
s.Properties.ShowColorName = !s.Properties.ShowColorName;
s.Properties.ColorHistoryLimit = s.Properties.ColorHistoryLimit == 0 ? 10 : 0;
};
}
}

87
src/dsc/v3/PowerToys.DSC.UnitTests/SettingsResourceTests/SettingsResourceCommandTest.cs Normal file
View File

@@ -0,0 +1,87 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.Linq;
using ManagedCommon;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using PowerToys.DSC.Commands;
using PowerToys.DSC.DSCResources;
using PowerToys.DSC.Models;
namespace PowerToys.DSC.UnitTests.SettingsResourceTests;
[TestClass]
public sealed class SettingsResourceCommandTest : BaseDscTest
{
[TestMethod]
public void Modules_ListAllSupportedModules()
{
// Arrange
var expectedModules = new List<string>()
{
SettingsResource.AppModule,
nameof(ModuleType.AdvancedPaste),
nameof(ModuleType.AlwaysOnTop),
nameof(ModuleType.Awake),
nameof(ModuleType.ColorPicker),
nameof(ModuleType.CropAndLock),
nameof(ModuleType.EnvironmentVariables),
nameof(ModuleType.FancyZones),
nameof(ModuleType.FileLocksmith),
nameof(ModuleType.FindMyMouse),
nameof(ModuleType.Hosts),
nameof(ModuleType.ImageResizer),
nameof(ModuleType.KeyboardManager),
nameof(ModuleType.MouseHighlighter),
nameof(ModuleType.MouseJump),
nameof(ModuleType.MousePointerCrosshairs),
nameof(ModuleType.Peek),
nameof(ModuleType.PowerRename),
nameof(ModuleType.PowerAccent),
nameof(ModuleType.RegistryPreview),
nameof(ModuleType.MeasureTool),
nameof(ModuleType.ShortcutGuide),
nameof(ModuleType.PowerOCR),
nameof(ModuleType.Workspaces),
nameof(ModuleType.ZoomIt),
};
// Act
var result = ExecuteDscCommand<ModulesCommand>("--resource", SettingsResource.ResourceName);
// Assert
Assert.IsTrue(result.Success);
Assert.AreEqual(string.Join(Environment.NewLine, expectedModules.Order()), result.Output.Trim());
}
[TestMethod]
public void Set_EmptyInput_Fail()
{
// Act
var result = ExecuteDscCommand<SetCommand>("--resource", SettingsResource.ResourceName, "--module", "Awake");
var messages = result.Messages();
// Assert
Assert.IsFalse(result.Success);
Assert.AreEqual(1, messages.Count);
Assert.AreEqual(DscMessageLevel.Error, messages[0].Level);
Assert.AreEqual(GetResourceString("InputEmptyOrNullError"), messages[0].Message);
}
[TestMethod]
public void Test_EmptyInput_Fail()
{
// Act
var result = ExecuteDscCommand<TestCommand>("--resource", SettingsResource.ResourceName, "--module", "Awake");
var messages = result.Messages();
// Assert
Assert.IsFalse(result.Success);
Assert.AreEqual(1, messages.Count);
Assert.AreEqual(DscMessageLevel.Error, messages[0].Level);
Assert.AreEqual(GetResourceString("InputEmptyOrNullError"), messages[0].Message);
}
}

34
src/dsc/v3/PowerToys.DSC.UnitTests/SettingsResourceTests/SettingsResourceCropAndLockModuleTest.cs Normal file
View File

@@ -0,0 +1,34 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.VisualStudio.TestTools.UnitTesting;
namespace PowerToys.DSC.UnitTests.SettingsResourceTests;
[TestClass]
public sealed class SettingsResourceCropAndLockModuleTest : SettingsResourceModuleTest<CropAndLockSettings>
{
public SettingsResourceCropAndLockModuleTest()
: base(nameof(ModuleType.CropAndLock))
{
}
protected override Action<CropAndLockSettings> GetSettingsModifier()
{
return s =>
{
s.Properties.ThumbnailHotkey = new KeyboardKeysProperty()
{
Value = new HotkeySettings
{
Key = "mock",
Alt = true,
},
};
};
}
}

267
src/dsc/v3/PowerToys.DSC.UnitTests/SettingsResourceTests/SettingsResourceModuleTest`1.cs Normal file
View File

@@ -0,0 +1,267 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Text.Json.Nodes;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using PowerToys.DSC.Commands;
using PowerToys.DSC.DSCResources;
using PowerToys.DSC.Models.ResourceObjects;
namespace PowerToys.DSC.UnitTests.SettingsResourceTests;
public abstract class SettingsResourceModuleTest<TSettingsConfig> : BaseDscTest
where TSettingsConfig : ISettingsConfig, new()
{
private readonly SettingsUtils _settingsUtils = new();
private TSettingsConfig _originalSettings;
protected TSettingsConfig DefaultSettings => new();
protected string Module { get; }
protected List<string> DiffSettings { get; } = [SettingsResourceObject<AwakeSettings>.SettingsJsonPropertyName];
protected List<string> DiffEmpty { get; } = [];
public SettingsResourceModuleTest(string module)
{
Module = module;
}
[TestInitialize]
public void TestInitialize()
{
_originalSettings = GetSettings();
ResetSettingsToDefaultValues();
}
[TestCleanup]
public void TestCleanup()
{
SaveSettings(_originalSettings);
}
[TestMethod]
public void Get_Success()
{
// Arrange
var settingsBeforeExecute = GetSettings();
// Act
var result = ExecuteDscCommand<GetCommand>("--resource", SettingsResource.ResourceName, "--module", Module);
var state = result.OutputState<SettingsResourceObject<TSettingsConfig>>();
// Assert
Assert.IsTrue(result.Success);
AssertSettingsAreEqual(settingsBeforeExecute, GetSettings());
AssertStateAndSettingsAreEqual(settingsBeforeExecute, state);
}
[TestMethod]
public void Export_Success()
{
// Arrange
var settingsBeforeExecute = GetSettings();
// Act
var result = ExecuteDscCommand<ExportCommand>("--resource", SettingsResource.ResourceName, "--module", Module);
var state = result.OutputState<SettingsResourceObject<TSettingsConfig>>();
// Assert
Assert.IsTrue(result.Success);
AssertSettingsAreEqual(settingsBeforeExecute, GetSettings());
AssertStateAndSettingsAreEqual(settingsBeforeExecute, state);
}
[TestMethod]
public void SetWithDiff_Success()
{
// Arrange
var settingsModifier = GetSettingsModifier();
var input = CreateInputResourceObject(settingsModifier);
// Act
var result = ExecuteDscCommand<SetCommand>("--resource", SettingsResource.ResourceName, "--module", Module, "--input", input);
var (state, diff) = result.OutputStateAndDiff<SettingsResourceObject<TSettingsConfig>>();
// Assert
Assert.IsTrue(result.Success);
AssertSettingsHasChanged(settingsModifier);
AssertStateAndSettingsAreEqual(GetSettings(), state);
CollectionAssert.AreEqual(DiffSettings, diff);
}
[TestMethod]
public void SetWithoutDiff_Success()
{
// Arrange
var settingsModifier = GetSettingsModifier();
UpdateSettings(settingsModifier);
var settingsBeforeExecute = GetSettings();
var input = CreateInputResourceObject(settingsModifier);
// Act
var result = ExecuteDscCommand<SetCommand>("--resource", SettingsResource.ResourceName, "--module", Module, "--input", input);
var (state, diff) = result.OutputStateAndDiff<SettingsResourceObject<TSettingsConfig>>();
// Assert
Assert.IsTrue(result.Success);
AssertSettingsAreEqual(settingsBeforeExecute, GetSettings());
AssertStateAndSettingsAreEqual(settingsBeforeExecute, state);
CollectionAssert.AreEqual(DiffEmpty, diff);
}
[TestMethod]
public void TestWithDiff_Success()
{
// Arrange
var settingsModifier = GetSettingsModifier();
var settingsBeforeExecute = GetSettings();
var input = CreateInputResourceObject(settingsModifier);
// Act
var result = ExecuteDscCommand<TestCommand>("--resource", SettingsResource.ResourceName, "--module", Module, "--input", input);
var (state, diff) = result.OutputStateAndDiff<SettingsResourceObject<TSettingsConfig>>();
// Assert
Assert.IsTrue(result.Success);
AssertSettingsAreEqual(settingsBeforeExecute, GetSettings());
AssertStateAndSettingsAreEqual(settingsBeforeExecute, state);
CollectionAssert.AreEqual(DiffSettings, diff);
Assert.IsFalse(state.InDesiredState);
}
[TestMethod]
public void TestWithoutDiff_Success()
{
// Arrange
var settingsModifier = GetSettingsModifier();
UpdateSettings(settingsModifier);
var settingsBeforeExecute = GetSettings();
var input = CreateInputResourceObject(settingsModifier);
// Act
var result = ExecuteDscCommand<TestCommand>("--resource", SettingsResource.ResourceName, "--module", Module, "--input", input);
var (state, diff) = result.OutputStateAndDiff<SettingsResourceObject<TSettingsConfig>>();
// Assert
Assert.IsTrue(result.Success);
AssertSettingsAreEqual(settingsBeforeExecute, GetSettings());
AssertStateAndSettingsAreEqual(settingsBeforeExecute, state);
CollectionAssert.AreEqual(DiffEmpty, diff);
Assert.IsTrue(state.InDesiredState);
}
/// <summary>
/// Gets the settings modifier action for the specific settings configuration.
/// </summary>
/// <returns>An action that modifies the settings configuration.</returns>
protected abstract Action<TSettingsConfig> GetSettingsModifier();
/// <summary>
/// Resets the settings to default values.
/// </summary>
private void ResetSettingsToDefaultValues()
{
SaveSettings(DefaultSettings);
}
/// <summary>
/// Get the settings for the specified module.
/// </summary>
/// <returns>An instance of the settings type with the current configuration.</returns>
private TSettingsConfig GetSettings()
{
return _settingsUtils.GetSettingsOrDefault<TSettingsConfig>(DefaultSettings.GetModuleName());
}
/// <summary>
/// Saves the settings for the specified module.
/// </summary>
/// <param name="settings">Settings to save.</param>
private void SaveSettings(TSettingsConfig settings)
{
_settingsUtils.SaveSettings(JsonSerializer.Serialize(settings), DefaultSettings.GetModuleName());
}
/// <summary>
/// Create the resource object for the operation.
/// </summary>
/// <param name="settings">Settings to include in the resource object.</param>
/// <returns>A JSON string representing the resource object.</returns>
private string CreateResourceObject(TSettingsConfig settings)
{
var resourceObject = new SettingsResourceObject<TSettingsConfig>
{
Settings = settings,
};
return JsonSerializer.Serialize(resourceObject);
}
private string CreateInputResourceObject(Action<TSettingsConfig> settingsModifier)
{
var settings = DefaultSettings;
settingsModifier(settings);
return CreateResourceObject(settings);
}
/// <summary>
/// Create the response for the Get operation.
/// </summary>
/// <returns>A JSON string representing the response.</returns>
private string CreateGetResponse()
{
return CreateResourceObject(GetSettings());
}
/// <summary>
/// Asserts that the state and settings are equal.
/// </summary>
/// <param name="settings">Settings manifest to compare against.</param>
/// <param name="state">Output state to compare.</param>
private void AssertStateAndSettingsAreEqual(TSettingsConfig settings, SettingsResourceObject<TSettingsConfig> state)
{
AssertSettingsAreEqual(settings, state.Settings);
}
/// <summary>
/// Asserts that two settings manifests are equal.
/// </summary>
/// <param name="expected">Expected settings.</param>
/// <param name="actual">Actual settings.</param>
private void AssertSettingsAreEqual(TSettingsConfig expected, TSettingsConfig actual)
{
var expectedJson = JsonSerializer.SerializeToNode(expected) as JsonObject;
var actualJson = JsonSerializer.SerializeToNode(actual) as JsonObject;
Assert.IsTrue(JsonNode.DeepEquals(expectedJson, actualJson));
}
/// <summary>
/// Asserts that the current settings have changed.
/// </summary>
/// <param name="action">Action to prepare the default settings.</param>
private void AssertSettingsHasChanged(Action<TSettingsConfig> action)
{
var currentSettings = GetSettings();
var defaultSettings = DefaultSettings;
action(defaultSettings);
AssertSettingsAreEqual(defaultSettings, currentSettings);
}
/// <summary>
/// Updates the settings.
/// </summary>
/// <param name="action">Action to modify the settings.</param>
private void UpdateSettings(Action<TSettingsConfig> action)
{
var settings = GetSettings();
action(settings);
SaveSettings(settings);
}
}

120
src/dsc/v3/PowerToys.DSC/Commands/BaseCommand.cs Normal file
View File

@@ -0,0 +1,120 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.CommandLine;
using System.CommandLine.Invocation;
using System.CommandLine.IO;
using System.Diagnostics;
using System.Globalization;
using System.Text;
using PowerToys.DSC.DSCResources;
using PowerToys.DSC.Options;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Commands;
/// <summary>
/// Base class for all DSC commands.
/// </summary>
public abstract class BaseCommand : Command
{
private static readonly CompositeFormat ModuleNotSupportedByResource = CompositeFormat.Parse(Resources.ModuleNotSupportedByResource);
// Shared options for all commands
private readonly ModuleOption _moduleOption;
private readonly ResourceOption _resourceOption;
private readonly InputOption _inputOption;
// The dictionary of available resources and their factories.
private static readonly Dictionary<string, Func<string?, BaseResource>> _resourceFactories = new()
{
{ SettingsResource.ResourceName, module => new SettingsResource(module) },
// Add other resources here
};
/// <summary>
/// Gets the list of available DSC resources that can be used with the command.
/// </summary>
public static List<string> AvailableResources => [.._resourceFactories.Keys];
/// <summary>
/// Gets the DSC resource to be used by the command.
/// </summary>
protected BaseResource? Resource { get; private set; }
/// <summary>
/// Gets the input JSON provided by the user.
/// </summary>
protected string? Input { get; private set; }
/// <summary>
/// Gets the PowerToys module to be used by the command.
/// </summary>
protected string? Module { get; private set; }
public BaseCommand(string name, string description)
: base(name, description)
{
// Register the common options for all commands
_moduleOption = new ModuleOption();
AddOption(_moduleOption);
_resourceOption = new ResourceOption(AvailableResources);
AddOption(_resourceOption);
_inputOption = new InputOption();
AddOption(_inputOption);
// Register the command handler
this.SetHandler(CommandHandler);
}
/// <summary>
/// Handles the command invocation.
/// </summary>
/// <param name="context">The invocation context containing the parsed command options.</param>
public void CommandHandler(InvocationContext context)
{
Input = context.ParseResult.GetValueForOption(_inputOption);
Module = context.ParseResult.GetValueForOption(_moduleOption);
Resource = ResolvedResource(context);
// Validate the module against the resource's supported modules
var supportedModules = Resource.GetSupportedModules();
if (!string.IsNullOrEmpty(Module) && !supportedModules.Contains(Module))
{
var errorMessage = string.Format(CultureInfo.InvariantCulture, ModuleNotSupportedByResource, Module, Resource.Name);
context.Console.Error.WriteLine(errorMessage);
context.ExitCode = 1;
return;
}
// Continue with the command handler logic
CommandHandlerInternal(context);
}
/// <summary>
/// Handles the command logic internally.
/// </summary>
/// <param name="context">Invocation context containing the parsed command options.</param>
public abstract void CommandHandlerInternal(InvocationContext context);
/// <summary>
/// Resolves the resource from the provided resource name in the context.
/// </summary>
/// <param name="context">Invocation context containing the parsed command options.</param>
/// <returns>The resolved <see cref="BaseResource"/> instance.</returns>
private BaseResource ResolvedResource(InvocationContext context)
{
// Resource option has already been validated before the command
// handler is invoked.
var resourceName = context.ParseResult.GetValueForOption(_resourceOption);
Debug.Assert(!string.IsNullOrEmpty(resourceName), "Resource name must not be null or empty.");
Debug.Assert(_resourceFactories.ContainsKey(resourceName), $"Resource '{resourceName}' is not registered.");
return _resourceFactories[resourceName](Module);
}
}

25
src/dsc/v3/PowerToys.DSC/Commands/ExportCommand.cs Normal file
View File

@@ -0,0 +1,25 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.CommandLine.Invocation;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Commands;
/// <summary>
/// Command to export all state instances.
/// </summary>
public sealed class ExportCommand : BaseCommand
{
public ExportCommand()
: base("export", Resources.ExportCommandDescription)
{
}
/// <inheritdoc/>
public override void CommandHandlerInternal(InvocationContext context)
{
context.ExitCode = Resource!.ExportState(Input) ? 0 : 1;
}
}

25
src/dsc/v3/PowerToys.DSC/Commands/GetCommand.cs Normal file
View File

@@ -0,0 +1,25 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.CommandLine.Invocation;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Commands;
/// <summary>
/// Command to get the resource state.
/// </summary>
public sealed class GetCommand : BaseCommand
{
public GetCommand()
: base("get", Resources.GetCommandDescription)
{
}
/// <inheritdoc/>
public override void CommandHandlerInternal(InvocationContext context)
{
context.ExitCode = Resource!.GetState(Input) ? 0 : 1;
}
}

34
src/dsc/v3/PowerToys.DSC/Commands/ManifestCommand.cs Normal file
View File

@@ -0,0 +1,34 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.CommandLine.Invocation;
using PowerToys.DSC.Options;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Commands;
/// <summary>
/// Command to get the manifest of the DSC resource.
/// </summary>
public sealed class ManifestCommand : BaseCommand
{
/// <summary>
/// Option to specify the output directory for the manifest.
/// </summary>
private readonly OutputDirectoryOption _outputDirectoryOption;
public ManifestCommand()
: base("manifest", Resources.ManifestCommandDescription)
{
_outputDirectoryOption = new OutputDirectoryOption();
AddOption(_outputDirectoryOption);
}
/// <inheritdoc/>
public override void CommandHandlerInternal(InvocationContext context)
{
var outputDir = context.ParseResult.GetValueForOption(_outputDirectoryOption);
context.ExitCode = Resource!.Manifest(outputDir) ? 0 : 1;
}
}

47
src/dsc/v3/PowerToys.DSC/Commands/ModulesCommand.cs Normal file
View File

@@ -0,0 +1,47 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.CommandLine;
using System.CommandLine.Invocation;
using System.Diagnostics;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Commands;
/// <summary>
/// Command to get all supported modules for a specific resource.
/// </summary>
/// <remarks>
/// This class is primarily used for debugging purposes and for build scripts.
/// </remarks>
public sealed class ModulesCommand : BaseCommand
{
public ModulesCommand()
: base("modules", Resources.ModulesCommandDescription)
{
}
/// <inheritdoc/>
public override void CommandHandlerInternal(InvocationContext context)
{
// Module is optional, if not provided, all supported modules for the
// resource will be printed. If provided, it must be one of the
// supported modules since it has been validated before this command is
// executed.
if (!string.IsNullOrEmpty(Module))
{
Debug.Assert(Resource!.GetSupportedModules().Contains(Module), "Module must be present in the list of supported modules.");
context.Console.WriteLine(Module);
}
else
{
// Print the supported modules for the specified resource
foreach (var module in Resource!.GetSupportedModules())
{
context.Console.WriteLine(module);
}
}
}
}

25
src/dsc/v3/PowerToys.DSC/Commands/SchemaCommand.cs Normal file
View File

@@ -0,0 +1,25 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.CommandLine.Invocation;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Commands;
/// <summary>
/// Command to output the schema of the resource.
/// </summary>
public sealed class SchemaCommand : BaseCommand
{
public SchemaCommand()
: base("schema", Resources.SchemaCommandDescription)
{
}
/// <inheritdoc/>
public override void CommandHandlerInternal(InvocationContext context)
{
context.ExitCode = Resource!.Schema() ? 0 : 1;
}
}

25
src/dsc/v3/PowerToys.DSC/Commands/SetCommand.cs Normal file
View File

@@ -0,0 +1,25 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.CommandLine.Invocation;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Commands;
/// <summary>
/// Command to set the resource state.
/// </summary>
public sealed class SetCommand : BaseCommand
{
public SetCommand()
: base("set", Resources.SetCommandDescription)
{
}
/// <inheritdoc/>
public override void CommandHandlerInternal(InvocationContext context)
{
context.ExitCode = Resource!.SetState(Input) ? 0 : 1;
}
}

25
src/dsc/v3/PowerToys.DSC/Commands/TestCommand.cs Normal file
View File

@@ -0,0 +1,25 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.CommandLine.Invocation;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Commands;
/// <summary>
/// Command to test the resource state.
/// </summary>
public sealed class TestCommand : BaseCommand
{
public TestCommand()
: base("test", Resources.TestCommandDescription)
{
}
/// <inheritdoc/>
public override void CommandHandlerInternal(InvocationContext context)
{
context.ExitCode = Resource!.TestState(Input) ? 0 : 1;
}
}

134
src/dsc/v3/PowerToys.DSC/DSCResources/BaseResource.cs Normal file
View File

@@ -0,0 +1,134 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.Text.Json.Nodes;
using PowerToys.DSC.Models;
namespace PowerToys.DSC.DSCResources;
/// <summary>
/// Base class for all DSC resources.
/// </summary>
public abstract class BaseResource
{
/// <summary>
/// Gets the name of the resource.
/// </summary>
public string Name { get; }
/// <summary>
/// Gets the module being used by the resource, if provided.
/// </summary>
public string? Module { get; }
public BaseResource(string name, string? module)
{
Name = name;
Module = module;
}
/// <summary>
/// Calls the get method on the resource.
/// </summary>
/// <param name="input">The input string, if any.</param>
/// <returns>True if the operation was successful; otherwise false.</returns>
public abstract bool GetState(string? input);
/// <summary>
/// Calls the set method on the resource.
/// </summary>
/// <param name="input">The input string, if any.</param>
/// <returns>True if the operation was successful; otherwise false.</returns>
public abstract bool SetState(string? input);
/// <summary>
/// Calls the test method on the resource.
/// </summary>
/// <param name="input">The input string, if any.</param>
/// <returns>True if the operation was successful; otherwise false.</returns>
public abstract bool TestState(string? input);
/// <summary>
/// Calls the export method on the resource.
/// </summary>
/// <param name="input"> The input string, if any.</param>
/// <returns>True if the operation was successful; otherwise false.</returns>
public abstract bool ExportState(string? input);
/// <summary>
/// Calls the schema method on the resource.
/// </summary>
/// <returns>True if the operation was successful; otherwise false.</returns>
public abstract bool Schema();
/// <summary>
/// Generates a DSC resource JSON manifest for the resource. If the
/// outputDir is not provided, the manifest will be printed to the console.
/// </summary>
/// <param name="outputDir"> The directory where the manifest should be
/// saved. If null, the manifest will be printed to the console.</param>
/// <returns>True if the manifest was successfully generated and saved,otherwise false.</returns>
public abstract bool Manifest(string? outputDir);
/// <summary>
/// Gets the list of supported modules for the resource.
/// </summary>
/// <returns>Gets a list of supported modules.</returns>
public abstract IList<string> GetSupportedModules();
/// <summary>
/// Writes a JSON output line to the console.
/// </summary>
/// <param name="output">The JSON output to write.</param>
protected void WriteJsonOutputLine(JsonNode output)
{
var json = output.ToJsonString(new() { WriteIndented = false });
WriteJsonOutputLine(json);
}
/// <summary>
/// Writes a JSON output line to the console.
/// </summary>
/// <param name="output">The JSON output to write.</param>
protected void WriteJsonOutputLine(string output)
{
Console.WriteLine(output);
}
/// <summary>
/// Writes a message output line to the console with the specified message level.
/// </summary>
/// <param name="level">The level of the message.</param>
/// <param name="message">The message to write.</param>
protected void WriteMessageOutputLine(DscMessageLevel level, string message)
{
var messageObj = new Dictionary<string, string>
{
[GetMessageLevel(level)] = message,
};
var messageJson = System.Text.Json.JsonSerializer.Serialize(messageObj);
Console.Error.WriteLine(messageJson);
}
/// <summary>
/// Gets the message level as a string based on the provided dsc message level enum value.
/// </summary>
/// <param name="level">The dsc message level.</param>
/// <returns>A string representation of the message level.</returns>
/// <exception cref="ArgumentOutOfRangeException">Thrown when the provided message level is not recognized.</exception>
private static string GetMessageLevel(DscMessageLevel level)
{
return level switch
{
DscMessageLevel.Error => "error",
DscMessageLevel.Warning => "warn",
DscMessageLevel.Info => "info",
DscMessageLevel.Debug => "debug",
DscMessageLevel.Trace => "trace",
_ => throw new ArgumentOutOfRangeException(nameof(level), level, null),
};
}
}

248
src/dsc/v3/PowerToys.DSC/DSCResources/SettingsResource.cs Normal file
View File

@@ -0,0 +1,248 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Text;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
using PowerToys.DSC.Models;
using PowerToys.DSC.Models.FunctionData;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.DSCResources;
/// <summary>
/// Represents the DSC resource for managing PowerToys settings.
/// </summary>
public sealed class SettingsResource : BaseResource
{
private static readonly CompositeFormat FailedToWriteManifests = CompositeFormat.Parse(Resources.FailedToWriteManifests);
public const string AppModule = "App";
public const string ResourceName = "settings";
private readonly Dictionary<string, Func<string?, ISettingsFunctionData>> _moduleFunctionData;
public string ModuleOrDefault => string.IsNullOrEmpty(Module) ? AppModule : Module;
public SettingsResource(string? module)
: base(ResourceName, module)
{
_moduleFunctionData = new()
{
{ AppModule, CreateModuleFunctionData<GeneralSettings> },
{ nameof(ModuleType.AdvancedPaste), CreateModuleFunctionData<AdvancedPasteSettings> },
{ nameof(ModuleType.AlwaysOnTop), CreateModuleFunctionData<AlwaysOnTopSettings> },
{ nameof(ModuleType.Awake), CreateModuleFunctionData<AwakeSettings> },
{ nameof(ModuleType.ColorPicker), CreateModuleFunctionData<ColorPickerSettings> },
{ nameof(ModuleType.CropAndLock), CreateModuleFunctionData<CropAndLockSettings> },
{ nameof(ModuleType.EnvironmentVariables), CreateModuleFunctionData<EnvironmentVariablesSettings> },
{ nameof(ModuleType.FancyZones), CreateModuleFunctionData<FancyZonesSettings> },
{ nameof(ModuleType.FileLocksmith), CreateModuleFunctionData<FileLocksmithSettings> },
{ nameof(ModuleType.FindMyMouse), CreateModuleFunctionData<FindMyMouseSettings> },
{ nameof(ModuleType.Hosts), CreateModuleFunctionData<HostsSettings> },
{ nameof(ModuleType.ImageResizer), CreateModuleFunctionData<ImageResizerSettings> },
{ nameof(ModuleType.KeyboardManager), CreateModuleFunctionData<KeyboardManagerSettings> },
{ nameof(ModuleType.MouseHighlighter), CreateModuleFunctionData<MouseHighlighterSettings> },
{ nameof(ModuleType.MouseJump), CreateModuleFunctionData<MouseJumpSettings> },
{ nameof(ModuleType.MousePointerCrosshairs), CreateModuleFunctionData<MousePointerCrosshairsSettings> },
{ nameof(ModuleType.Peek), CreateModuleFunctionData<PeekSettings> },
{ nameof(ModuleType.PowerRename), CreateModuleFunctionData<PowerRenameSettings> },
{ nameof(ModuleType.PowerAccent), CreateModuleFunctionData<PowerAccentSettings> },
{ nameof(ModuleType.RegistryPreview), CreateModuleFunctionData<RegistryPreviewSettings> },
{ nameof(ModuleType.MeasureTool), CreateModuleFunctionData<MeasureToolSettings> },
{ nameof(ModuleType.ShortcutGuide), CreateModuleFunctionData<ShortcutGuideSettings> },
{ nameof(ModuleType.PowerOCR), CreateModuleFunctionData<PowerOcrSettings> },
{ nameof(ModuleType.Workspaces), CreateModuleFunctionData<WorkspacesSettings> },
{ nameof(ModuleType.ZoomIt), CreateModuleFunctionData<ZoomItSettings> },
// The following modules are not currently supported:
// - MouseWithoutBorders Contains sensitive configuration values, making export/import potentially insecure.
// - PowerLauncher Uses absolute file paths in its settings, which are not portable across systems.
// - NewPlus Uses absolute file paths in its settings, which are not portable across systems.
};
}
/// <inheritdoc/>
public override bool ExportState(string? input)
{
var data = CreateFunctionData();
data.GetState();
WriteJsonOutputLine(data.Output.ToJson());
return true;
}
/// <inheritdoc/>
public override bool GetState(string? input)
{
return ExportState(input);
}
/// <inheritdoc/>
public override bool SetState(string? input)
{
if (string.IsNullOrEmpty(input))
{
WriteMessageOutputLine(DscMessageLevel.Error, Resources.InputEmptyOrNullError);
return false;
}
var data = CreateFunctionData(input);
data.GetState();
// Capture the diff before updating the output
var diff = data.GetDiffJson();
// Only call Set if the desired state is different from the current state
if (!data.TestState())
{
var inputSettings = data.Input.SettingsInternal;
data.Output.SettingsInternal = inputSettings;
data.SetState();
}
WriteJsonOutputLine(data.Output.ToJson());
WriteJsonOutputLine(diff);
return true;
}
/// <inheritdoc/>
public override bool TestState(string? input)
{
if (string.IsNullOrEmpty(input))
{
WriteMessageOutputLine(DscMessageLevel.Error, Resources.InputEmptyOrNullError);
return false;
}
var data = CreateFunctionData(input);
data.GetState();
data.Output.InDesiredState = data.TestState();
WriteJsonOutputLine(data.Output.ToJson());
WriteJsonOutputLine(data.GetDiffJson());
return true;
}
/// <inheritdoc/>
public override bool Schema()
{
var data = CreateFunctionData();
WriteJsonOutputLine(data.Schema());
return true;
}
/// <inheritdoc/>
/// <remarks>
/// If an output directory is specified, write the manifests to files,
/// otherwise output them to the console.
/// </remarks>
public override bool Manifest(string? outputDir)
{
var manifests = GenerateManifests();
if (!string.IsNullOrEmpty(outputDir))
{
try
{
foreach (var (name, manifest) in manifests)
{
File.WriteAllText(Path.Combine(outputDir, $"microsoft.powertoys.{name}.settings.dsc.resource.json"), manifest);
}
}
catch (Exception ex)
{
var errorMessage = string.Format(CultureInfo.InvariantCulture, FailedToWriteManifests, outputDir, ex.Message);
WriteMessageOutputLine(DscMessageLevel.Error, errorMessage);
return false;
}
}
else
{
foreach (var (_, manifest) in manifests)
{
WriteJsonOutputLine(manifest);
}
}
return true;
}
/// <summary>
/// Generates manifests for the specified module or all supported modules
/// if no module is specified.
/// </summary>
/// <returns>A list of tuples containing the module name and its corresponding manifest JSON.</returns>
private List<(string Name, string Manifest)> GenerateManifests()
{
List<(string Name, string Manifest)> manifests = [];
if (!string.IsNullOrEmpty(Module))
{
manifests.Add((Module, GenerateManifest(Module)));
}
else
{
foreach (var module in GetSupportedModules())
{
manifests.Add((module, GenerateManifest(module)));
}
}
return manifests;
}
/// <summary>
/// Generate a DSC resource JSON manifest for the specified module.
/// </summary>
/// <param name="module">The name of the module for which to generate the manifest.</param>
/// <returns>A JSON string representing the DSC resource manifest.</returns>
private string GenerateManifest(string module)
{
// Note: The description is not localized because the generated
// manifest file will be part of the package
return new DscManifest($"{module}Settings", "0.1.0")
.AddDescription($"Allows management of {module} settings state via the DSC v3 command line interface protocol.")
.AddStdinMethod("export", ["export", "--module", module, "--resource", "settings"])
.AddStdinMethod("get", ["get", "--module", module, "--resource", "settings"])
.AddJsonInputMethod("set", "--input", ["set", "--module", module, "--resource", "settings"], implementsPretest: true, stateAndDiff: true)
.AddJsonInputMethod("test", "--input", ["test", "--module", module, "--resource", "settings"], stateAndDiff: true)
.AddCommandMethod("schema", ["schema", "--module", module, "--resource", "settings"])
.ToJson();
}
/// <inheritdoc/>
public override IList<string> GetSupportedModules()
{
return [.. _moduleFunctionData.Keys.Order()];
}
/// <summary>
/// Creates the function data for the specified module or the default module if none is specified.
/// </summary>
/// <param name="input">The input string, if any.</param>
/// <returns>An instance of <see cref="ISettingsFunctionData"/> for the specified module.</returns>
public ISettingsFunctionData CreateFunctionData(string? input = null)
{
Debug.Assert(_moduleFunctionData.ContainsKey(ModuleOrDefault), "Module should be supported by the resource.");
return _moduleFunctionData[ModuleOrDefault](input);
}
/// <summary>
/// Creates the function data for a specific settings configuration type.
/// </summary>
/// <typeparam name="TSettingsConfig">The type of settings configuration to create function data for.</typeparam>
/// <param name="input">The input string, if any.</param>
/// <returns>An instance of <see cref="ISettingsFunctionData"/> for the specified settings configuration type.</returns>
private ISettingsFunctionData CreateModuleFunctionData<TSettingsConfig>(string? input)
where TSettingsConfig : ISettingsConfig, new()
{
return new SettingsFunctionData<TSettingsConfig>(input);
}
}

152
src/dsc/v3/PowerToys.DSC/Models/DscManifest.cs Normal file
View File

@@ -0,0 +1,152 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.Collections.Generic;
using System.Text.Json.Nodes;
namespace PowerToys.DSC.Models;
/// <summary>
/// Class for building a DSC manifest for PowerToys resources.
/// </summary>
public sealed class DscManifest
{
private const string Schema = "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.vscode.json";
private const string Executable = @"PowerToys.DSC.exe";
private readonly string _type;
private readonly string _version;
private readonly JsonObject _manifest;
public DscManifest(string type, string version)
{
_type = type;
_version = version;
_manifest = new JsonObject
{
["$schema"] = Schema,
["type"] = $"Microsoft.PowerToys/{_type}",
["version"] = _version,
["tags"] = new JsonArray("PowerToys"),
};
}
/// <summary>
/// Adds a description to the manifest.
/// </summary>
/// <param name="description">The description to add.</param>
/// <returns>Returns the current instance of <see cref="DscManifest"/>.</returns>
public DscManifest AddDescription(string description)
{
_manifest["description"] = description;
return this;
}
/// <summary>
/// Adds a method to the manifest with the specified executable and arguments.
/// </summary>
/// <param name="method">The name of the method to add.</param>
/// <param name="inputArg">The input argument for the method</param>
/// <param name="args">The list of arguments for the method.</param>
/// <param name="implementsPretest">Whether the method implements a pretest.</param>
/// <param name="stateAndDiff">Whether the method returns state and diff.</param>
/// <returns>Returns the current instance of <see cref="DscManifest"/>.</returns>
public DscManifest AddJsonInputMethod(string method, string inputArg, List<string> args, bool? implementsPretest = null, bool? stateAndDiff = null)
{
var argsJson = CreateJsonArray(args);
argsJson.Add(new JsonObject
{
["jsonInputArg"] = inputArg,
["mandatory"] = true,
});
var methodObject = AddMethod(argsJson, implementsPretest, stateAndDiff);
_manifest[method] = methodObject;
return this;
}
/// <summary>
/// Adds a method to the manifest that reads from standard input (stdin).
/// </summary>
/// <param name="method">The name of the method to add.</param>
/// <param name="args">The list of arguments for the method.</param>
/// <param name="implementsPretest">Whether the method implements a pretest.</param>
/// <param name="stateAndDiff">Whether the method returns state and diff.</param>
/// <returns>Returns the current instance of <see cref="DscManifest"/>.</returns>
public DscManifest AddStdinMethod(string method, List<string> args, bool? implementsPretest = null, bool? stateAndDiff = null)
{
var argsJson = CreateJsonArray(args);
var methodObject = AddMethod(argsJson, implementsPretest, stateAndDiff);
methodObject["input"] = "stdin";
_manifest[method] = methodObject;
return this;
}
/// <summary>
/// Adds a command method to the manifest.
/// </summary>
/// <param name="method">The name of the method to add.</param>
/// <param name="args">The list of arguments for the method.</param>
/// <returns>Returns the current instance of <see cref="DscManifest"/>.</returns>
public DscManifest AddCommandMethod(string method, List<string> args)
{
_manifest[method] = new JsonObject
{
["command"] = AddMethod(CreateJsonArray(args)),
};
return this;
}
/// <summary>
/// Gets the JSON representation of the manifest.
/// </summary>
/// <returns>Returns the JSON string of the manifest.</returns>
public string ToJson()
{
return _manifest.ToJsonString(new() { WriteIndented = true });
}
/// <summary>
/// Add a method to the manifest with the specified arguments.
/// </summary>
/// <param name="args">The list of arguments for the method.</param>
/// <param name="implementsPretest">Whether the method implements a pretest.</param>
/// <param name="stateAndDiff">Whether the method returns state and diff.</param>
/// <returns>Returns the method object.</returns>
private JsonObject AddMethod(JsonArray args, bool? implementsPretest = null, bool? stateAndDiff = null)
{
var methodObject = new JsonObject
{
["executable"] = Executable,
["args"] = args,
};
if (implementsPretest.HasValue)
{
methodObject["implementsPretest"] = implementsPretest.Value;
}
if (stateAndDiff.HasValue)
{
methodObject["return"] = stateAndDiff.Value ? "stateAndDiff" : "state";
}
return methodObject;
}
/// <summary>
/// Creates a JSON array from a list of strings.
/// </summary>
/// <param name="args">The list of strings to convert.</param>
/// <returns>Returns the JSON array.</returns>
private JsonArray CreateJsonArray(List<string> args)
{
var jsonArray = new JsonArray();
foreach (var arg in args)
{
jsonArray.Add(arg);
}
return jsonArray;
}
}

36
src/dsc/v3/PowerToys.DSC/Models/DscMessageLevel.cs Normal file
View File

@@ -0,0 +1,36 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
namespace PowerToys.DSC.Models;
/// <summary>
/// Specifies the severity level of a message.
/// </summary>
public enum DscMessageLevel
{
/// <summary>
/// Represents an error message.
/// </summary>
Error,
/// <summary>
/// Represents a warning message.
/// </summary>
Warning,
/// <summary>
/// Represents an informational message.
/// </summary>
Info,
/// <summary>
/// Represents a debug message.
/// </summary>
Debug,
/// <summary>
/// Represents a trace message.
/// </summary>
Trace,
}

36
src/dsc/v3/PowerToys.DSC/Models/FunctionData/BaseFunctionData.cs Normal file
View File

@@ -0,0 +1,36 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using Newtonsoft.Json;
using NJsonSchema.Generation;
using PowerToys.DSC.Models.ResourceObjects;
namespace PowerToys.DSC.Models.FunctionData;
/// <summary>
/// Base class for function data objects.
/// </summary>
public class BaseFunctionData
{
/// <summary>
/// Generates a JSON schema for the specified resource object type.
/// </summary>
/// <typeparam name="T">The type of the resource object.</typeparam>
/// <returns>A JSON schema string.</returns>
protected static string GenerateSchema<T>()
where T : BaseResourceObject
{
var settings = new SystemTextJsonSchemaGeneratorSettings()
{
FlattenInheritanceHierarchy = true,
SerializerOptions =
{
IgnoreReadOnlyFields = true,
},
};
var generator = new JsonSchemaGenerator(settings);
var schema = generator.Generate(typeof(T));
return schema.ToJson(Formatting.None);
}
}

52
src/dsc/v3/PowerToys.DSC/Models/FunctionData/ISettingsFunctionData.cs Normal file
View File

@@ -0,0 +1,52 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.Text.Json.Nodes;
using PowerToys.DSC.Models.ResourceObjects;
namespace PowerToys.DSC.Models.FunctionData;
/// <summary>
/// Interface for function data related to settings.
/// </summary>
public interface ISettingsFunctionData
{
/// <summary>
/// Gets the input settings resource object.
/// </summary>
public ISettingsResourceObject Input { get; }
/// <summary>
/// Gets the output settings resource object.
/// </summary>
public ISettingsResourceObject Output { get; }
/// <summary>
/// Gets the current settings.
/// </summary>
public void GetState();
/// <summary>
/// Sets the current settings.
/// </summary>
public void SetState();
/// <summary>
/// Tests if the current settings and the desired state are valid.
/// </summary>
/// <returns>True if the current settings match the desired state; otherwise false.</returns>
public bool TestState();
/// <summary>
/// Gets the difference between the current settings and the desired state in JSON format.
/// </summary>
/// <returns>A JSON array representing the differences.</returns>
public JsonArray GetDiffJson();
/// <summary>
/// Gets the schema for the settings resource object.
/// </summary>
/// <returns></returns>
public string Schema();
}

96
src/dsc/v3/PowerToys.DSC/Models/FunctionData/SettingsFunctionData`1.cs Normal file
View File

@@ -0,0 +1,96 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.Diagnostics;
using System.Text.Json;
using System.Text.Json.Nodes;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
using PowerToys.DSC.Models.ResourceObjects;
namespace PowerToys.DSC.Models.FunctionData;
/// <summary>
/// Represents function data for the settings DSC resource.
/// </summary>
/// <typeparam name="TSettingsConfig">The module settings configuration type.</typeparam>
public sealed class SettingsFunctionData<TSettingsConfig> : BaseFunctionData, ISettingsFunctionData
where TSettingsConfig : ISettingsConfig, new()
{
private static readonly SettingsUtils _settingsUtils = new();
private static readonly TSettingsConfig _settingsConfig = new();
private readonly SettingsResourceObject<TSettingsConfig> _input;
private readonly SettingsResourceObject<TSettingsConfig> _output;
/// <inheritdoc/>
public ISettingsResourceObject Input => _input;
/// <inheritdoc/>
public ISettingsResourceObject Output => _output;
public SettingsFunctionData(string? input = null)
{
_output = new();
_input = string.IsNullOrEmpty(input) ? new() : JsonSerializer.Deserialize<SettingsResourceObject<TSettingsConfig>>(input) ?? new();
}
/// <inheritdoc/>
public void GetState()
{
_output.Settings = GetSettings();
}
/// <inheritdoc/>
public void SetState()
{
Debug.Assert(_output.Settings != null, "Output settings should not be null");
SaveSettings(_output.Settings);
}
/// <inheritdoc/>
public bool TestState()
{
var input = JsonSerializer.SerializeToNode(_input.Settings);
var output = JsonSerializer.SerializeToNode(_output.Settings);
return JsonNode.DeepEquals(input, output);
}
/// <inheritdoc/>
public JsonArray GetDiffJson()
{
var diff = new JsonArray();
if (!TestState())
{
diff.Add(SettingsResourceObject<TSettingsConfig>.SettingsJsonPropertyName);
}
return diff;
}
/// <inheritdoc/>
public string Schema()
{
return GenerateSchema<SettingsResourceObject<TSettingsConfig>>();
}
/// <summary>
/// Gets the settings configuration from the settings utils for a specific module.
/// </summary>
/// <returns>The settings configuration for the module.</returns>
private static TSettingsConfig GetSettings()
{
return _settingsUtils.GetSettingsOrDefault<TSettingsConfig>(_settingsConfig.GetModuleName());
}
/// <summary>
/// Saves the settings configuration to the settings utils for a specific module.
/// </summary>
/// <param name="settings">Settings of a specific module</param>
private static void SaveSettings(TSettingsConfig settings)
{
var inputJson = JsonSerializer.Serialize(settings);
_settingsUtils.SaveSettings(inputJson, _settingsConfig.GetModuleName());
}
}

45
src/dsc/v3/PowerToys.DSC/Models/ResourceObjects/BaseResourceObject.cs Normal file
View File

@@ -0,0 +1,45 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.ComponentModel;
using System.Text.Json;
using System.Text.Json.Nodes;
using System.Text.Json.Serialization;
using System.Text.Json.Serialization.Metadata;
namespace PowerToys.DSC.Models.ResourceObjects;
/// <summary>
/// Base class for all resource objects.
/// </summary>
public class BaseResourceObject
{
private readonly JsonSerializerOptions _options;
public BaseResourceObject()
{
_options = new()
{
WriteIndented = false,
TypeInfoResolver = new DefaultJsonTypeInfoResolver(),
};
}
/// <summary>
/// Gets or sets whether an instance is in the desired state.
/// </summary>
[JsonPropertyName("_inDesiredState")]
[Description("Indicates whether an instance is in the desired state")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? InDesiredState { get; set; }
/// <summary>
/// Generates a JSON representation of the resource object.
/// </summary>
/// <returns></returns>
public JsonNode ToJson()
{
return JsonSerializer.SerializeToNode(this, GetType(), _options) ?? new JsonObject();
}
}

30
src/dsc/v3/PowerToys.DSC/Models/ResourceObjects/ISettingsResourceObject.cs Normal file
View File

@@ -0,0 +1,30 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.Text.Json.Nodes;
using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
namespace PowerToys.DSC.Models.ResourceObjects;
/// <summary>
/// Interface for settings resource objects.
/// </summary>
public interface ISettingsResourceObject
{
/// <summary>
/// Gets or sets the settings configuration.
/// </summary>
public ISettingsConfig SettingsInternal { get; set; }
/// <summary>
/// Gets or sets whether an instance is in the desired state.
/// </summary>
public bool? InDesiredState { get; set; }
/// <summary>
/// Generates a JSON representation of the resource object.
/// </summary>
/// <returns>String representation of the resource object in JSON format.</returns>
public JsonNode ToJson();
}

34
src/dsc/v3/PowerToys.DSC/Models/ResourceObjects/SettingsResourceObject`1.cs Normal file
View File

@@ -0,0 +1,34 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.Text.Json.Serialization;
using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
using NJsonSchema.Annotations;
namespace PowerToys.DSC.Models.ResourceObjects;
/// <summary>
/// Represents a settings resource object for a module's settings configuration.
/// </summary>
/// <typeparam name="TSettingsConfig">The type of the settings configuration.</typeparam>
public sealed class SettingsResourceObject<TSettingsConfig> : BaseResourceObject, ISettingsResourceObject
where TSettingsConfig : ISettingsConfig, new()
{
public const string SettingsJsonPropertyName = "settings";
/// <summary>
/// Gets or sets the settings content for the module.
/// </summary>
[JsonPropertyName(SettingsJsonPropertyName)]
[Required]
[Description("The settings content for the module.")]
[JsonSchemaType(typeof(object))]
public TSettingsConfig Settings { get; set; } = new();
/// <inheritdoc/>
[JsonIgnore]
public ISettingsConfig SettingsInternal { get => Settings; set => Settings = (TSettingsConfig)value; }
}

51
src/dsc/v3/PowerToys.DSC/Options/InputOption.cs Normal file
View File

@@ -0,0 +1,51 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.CommandLine;
using System.CommandLine.Parsing;
using System.Globalization;
using System.Text;
using System.Text.Json;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Options;
/// <summary>
/// Represents an option for specifying JSON input for the dsc command.
/// </summary>
public sealed class InputOption : Option<string>
{
private static readonly CompositeFormat InvalidJsonInputError = CompositeFormat.Parse(Resources.InvalidJsonInputError);
public InputOption()
: base("--input", Resources.InputOptionDescription)
{
AddValidator(OptionValidator);
}
/// <summary>
/// Validates the JSON input provided to the option.
/// </summary>
/// <param name="result">The option result to validate.</param>
private void OptionValidator(OptionResult result)
{
var value = result.GetValueOrDefault<string>() ?? string.Empty;
if (string.IsNullOrEmpty(value))
{
result.ErrorMessage = Resources.InputEmptyOrNullError;
}
else
{
try
{
JsonDocument.Parse(value);
}
catch (Exception e)
{
result.ErrorMessage = string.Format(CultureInfo.InvariantCulture, InvalidJsonInputError, e.Message);
}
}
}
}

19
src/dsc/v3/PowerToys.DSC/Options/ModuleOption.cs Normal file
View File

@@ -0,0 +1,19 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.CommandLine;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Options;
/// <summary>
/// Represents an option for specifying the module name for the dsc command.
/// </summary>
public sealed class ModuleOption : Option<string?>
{
public ModuleOption()
: base("--module", Resources.ModuleOptionDescription)
{
}
}

43
src/dsc/v3/PowerToys.DSC/Options/OutputDirectoryOption.cs Normal file
View File

@@ -0,0 +1,43 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.CommandLine;
using System.CommandLine.Parsing;
using System.Globalization;
using System.IO;
using System.Text;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Options;
/// <summary>
/// Represents an option for specifying the output directory for the dsc command.
/// </summary>
public sealed class OutputDirectoryOption : Option<string>
{
private static readonly CompositeFormat InvalidOutputDirectoryError = CompositeFormat.Parse(Resources.InvalidOutputDirectoryError);
public OutputDirectoryOption()
: base("--outputDir", Resources.OutputDirectoryOptionDescription)
{
AddValidator(OptionValidator);
}
/// <summary>
/// Validates the output directory option.
/// </summary>
/// <param name="result">The option result to validate.</param>
private void OptionValidator(OptionResult result)
{
var value = result.GetValueOrDefault<string>() ?? string.Empty;
if (string.IsNullOrEmpty(value))
{
result.ErrorMessage = Resources.OutputDirectoryEmptyOrNullError;
}
else if (!Directory.Exists(value))
{
result.ErrorMessage = string.Format(CultureInfo.InvariantCulture, InvalidOutputDirectoryError, value);
}
}
}

43
src/dsc/v3/PowerToys.DSC/Options/ResourceOption.cs Normal file
View File

@@ -0,0 +1,43 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.Collections.Generic;
using System.CommandLine;
using System.CommandLine.Parsing;
using System.Globalization;
using System.Text;
using PowerToys.DSC.Properties;
namespace PowerToys.DSC.Options;
/// <summary>
/// Represents an option for specifying the resource name for the dsc command.
/// </summary>
public sealed class ResourceOption : Option<string>
{
private static readonly CompositeFormat InvalidResourceNameError = CompositeFormat.Parse(Resources.InvalidResourceNameError);
private readonly IList<string> _resources = [];
public ResourceOption(IList<string> resources)
: base("--resource", Resources.ResourceOptionDescription)
{
_resources = resources;
IsRequired = true;
AddValidator(OptionValidator);
}
/// <summary>
/// Validates the resource option to ensure that the specified resource name is valid.
/// </summary>
/// <param name="result">The option result to validate.</param>
private void OptionValidator(OptionResult result)
{
var value = result.GetValueOrDefault<string>() ?? string.Empty;
if (!_resources.Contains(value))
{
result.ErrorMessage = string.Format(CultureInfo.InvariantCulture, InvalidResourceNameError, string.Join(", ", _resources));
}
}
}

48
src/dsc/v3/PowerToys.DSC/PowerToys.DSC.csproj Normal file
View File

@@ -0,0 +1,48 @@
<Project Sdk="Microsoft.NET.Sdk">
<!-- Look at Directory.Build.props in root for common stuff as well -->
<Import Project="..\..\..\Common.Dotnet.CsWinRT.props" />
<Import Project="..\..\..\Common.SelfContained.props" />
<PropertyGroup>
<OutputType>Exe</OutputType>
<OutputPath>..\..\..\..\$(Platform)\$(Configuration)</OutputPath>
<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
<AppendRuntimeIdentifierToOutputPath>false</AppendRuntimeIdentifierToOutputPath>
<AssemblyName>PowerToys.DSC</AssemblyName>
<AssemblyDescription>PowerToys DSC</AssemblyDescription>
<RootNamespace>PowerToys.DSC</RootNamespace>
<Nullable>enable</Nullable>
<!-- Ensure WindowsDesktop runtime pack is included for consistent WindowsBase.dll version -->
<UseWPF>true</UseWPF>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="NJsonSchema" />
<PackageReference Include="System.CommandLine" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\..\settings-ui\Settings.UI.Library\Settings.UI.Library.csproj" />
</ItemGroup>
<ItemGroup>
<Compile Update="Properties\Resources.Designer.cs">
<DesignTime>True</DesignTime>
<AutoGen>True</AutoGen>
<DependentUpon>Resources.resx</DependentUpon>
</Compile>
</ItemGroup>
<ItemGroup>
<EmbeddedResource Update="Properties\Resources.resx">
<Generator>ResXFileCodeGenerator</Generator>
<LastGenOutput>Resources.Designer.cs</LastGenOutput>
</EmbeddedResource>
</ItemGroup>
<!-- In debug mode, generate the DSC resource JSON files -->
<Target Name="GenerateDscResourceJsonFiles" AfterTargets="Build" Condition="'$(Configuration)' == 'Debug'">
<Message Text="Generating DSC resource JSON files inside ..." Importance="high" />
<Exec Command="dotnet &quot;$(TargetPath)&quot; manifest --resource settings --outputDir &quot;$(TargetDir)\&quot;" />
</Target>
</Project>

29
src/dsc/v3/PowerToys.DSC/Program.cs Normal file
View File

@@ -0,0 +1,29 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.CommandLine;
using System.CommandLine.Parsing;
using System.Threading.Tasks;
using PowerToys.DSC.Commands;
namespace PowerToys.DSC;
/// <summary>
/// Main entry point for the PowerToys Desired State Configuration CLI application.
/// </summary>
public class Program
{
public static async Task<int> Main(string[] args)
{
var rootCommand = new RootCommand(Properties.Resources.PowerToysDSC);
rootCommand.AddCommand(new GetCommand());
rootCommand.AddCommand(new SetCommand());
rootCommand.AddCommand(new ExportCommand());
rootCommand.AddCommand(new TestCommand());
rootCommand.AddCommand(new SchemaCommand());
rootCommand.AddCommand(new ManifestCommand());
rootCommand.AddCommand(new ModulesCommand());
return await rootCommand.InvokeAsync(args);
}
}

234
src/dsc/v3/PowerToys.DSC/Properties/Resources.Designer.cs generated Normal file
View File

@@ -0,0 +1,234 @@
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by a tool.
// Runtime Version:4.0.30319.42000
//
// Changes to this file may cause incorrect behavior and will be lost if
// the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------
namespace PowerToys.DSC.Properties {
using System;
/// <summary>
/// A strongly-typed resource class, for looking up localized strings, etc.
/// </summary>
// This class was auto-generated by the StronglyTypedResourceBuilder
// class via a tool like ResGen or Visual Studio.
// To add or remove a member, edit your .ResX file then rerun ResGen
// with the /str option, or rebuild your VS project.
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")]
[global::System.Diagnostics.DebuggerNonUserCodeAttribute()]
[global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
internal class Resources {
private static global::System.Resources.ResourceManager resourceMan;
private static global::System.Globalization.CultureInfo resourceCulture;
[global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
internal Resources() {
}
/// <summary>
/// Returns the cached ResourceManager instance used by this class.
/// </summary>
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]
internal static global::System.Resources.ResourceManager ResourceManager {
get {
if (object.ReferenceEquals(resourceMan, null)) {
global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("PowerToys.DSC.Properties.Resources", typeof(Resources).Assembly);
resourceMan = temp;
}
return resourceMan;
}
}
/// <summary>
/// Overrides the current thread's CurrentUICulture property for all
/// resource lookups using this strongly typed resource class.
/// </summary>
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]
internal static global::System.Globalization.CultureInfo Culture {
get {
return resourceCulture;
}
set {
resourceCulture = value;
}
}
/// <summary>
/// Looks up a localized string similar to Get all state instances.
/// </summary>
internal static string ExportCommandDescription {
get {
return ResourceManager.GetString("ExportCommandDescription", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Failed to write manifests to directory &apos;{0}&apos;: {1}.
/// </summary>
internal static string FailedToWriteManifests {
get {
return ResourceManager.GetString("FailedToWriteManifests", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Get the resource state.
/// </summary>
internal static string GetCommandDescription {
get {
return ResourceManager.GetString("GetCommandDescription", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Input cannot be empty or null.
/// </summary>
internal static string InputEmptyOrNullError {
get {
return ResourceManager.GetString("InputEmptyOrNullError", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to The JSON input.
/// </summary>
internal static string InputOptionDescription {
get {
return ResourceManager.GetString("InputOptionDescription", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Invalid JSON input: {0}.
/// </summary>
internal static string InvalidJsonInputError {
get {
return ResourceManager.GetString("InvalidJsonInputError", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Invalid output directory: {0}.
/// </summary>
internal static string InvalidOutputDirectoryError {
get {
return ResourceManager.GetString("InvalidOutputDirectoryError", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Invalid resource name. Valid resource names are: {0}.
/// </summary>
internal static string InvalidResourceNameError {
get {
return ResourceManager.GetString("InvalidResourceNameError", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Get the manifest of the dsc resource.
/// </summary>
internal static string ManifestCommandDescription {
get {
return ResourceManager.GetString("ManifestCommandDescription", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Module &apos;{0}&apos; is not supported for the resource {1}. Use the &apos;module&apos; command to list available modules..
/// </summary>
internal static string ModuleNotSupportedByResource {
get {
return ResourceManager.GetString("ModuleNotSupportedByResource", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to The module name.
/// </summary>
internal static string ModuleOptionDescription {
get {
return ResourceManager.GetString("ModuleOptionDescription", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Get all supported modules for a specific resource.
/// </summary>
internal static string ModulesCommandDescription {
get {
return ResourceManager.GetString("ModulesCommandDescription", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Output directory cannot be empty or null.
/// </summary>
internal static string OutputDirectoryEmptyOrNullError {
get {
return ResourceManager.GetString("OutputDirectoryEmptyOrNullError", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to The output directory.
/// </summary>
internal static string OutputDirectoryOptionDescription {
get {
return ResourceManager.GetString("OutputDirectoryOptionDescription", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to PowerToys Desired State Configuration commands.
/// </summary>
internal static string PowerToysDSC {
get {
return ResourceManager.GetString("PowerToysDSC", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to The resource name.
/// </summary>
internal static string ResourceOptionDescription {
get {
return ResourceManager.GetString("ResourceOptionDescription", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Outputs schema of the resource.
/// </summary>
internal static string SchemaCommandDescription {
get {
return ResourceManager.GetString("SchemaCommandDescription", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Set the resource state.
/// </summary>
internal static string SetCommandDescription {
get {
return ResourceManager.GetString("SetCommandDescription", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Test the resource state.
/// </summary>
internal static string TestCommandDescription {
get {
return ResourceManager.GetString("TestCommandDescription", resourceCulture);
}
}
}
}

183
src/dsc/v3/PowerToys.DSC/Properties/Resources.resx Normal file
View File

@@ -0,0 +1,183 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema
Version 2.0
The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.
Example:
... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>
There are any number of "resheader" rows that contain simple
name/value pairs.
Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.
The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:
Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.
mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="metadata">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="PowerToysDSC" xml:space="preserve">
<value>PowerToys Desired State Configuration commands</value>
<comment>{Locked="PowerToys Desired State Configuration"}</comment>
</data>
<data name="ModuleNotSupportedByResource" xml:space="preserve">
<value>Module '{0}' is not supported for the resource {1}. Use the 'module' command to list available modules.</value>
<comment>{Locked="'module'","{0}","{1}"}</comment>
</data>
<data name="ExportCommandDescription" xml:space="preserve">
<value>Get all state instances</value>
</data>
<data name="GetCommandDescription" xml:space="preserve">
<value>Get the resource state</value>
</data>
<data name="ManifestCommandDescription" xml:space="preserve">
<value>Get the manifest of the dsc resource</value>
</data>
<data name="ModulesCommandDescription" xml:space="preserve">
<value>Get all supported modules for a specific resource</value>
</data>
<data name="SchemaCommandDescription" xml:space="preserve">
<value>Outputs schema of the resource</value>
</data>
<data name="SetCommandDescription" xml:space="preserve">
<value>Set the resource state</value>
</data>
<data name="TestCommandDescription" xml:space="preserve">
<value>Test the resource state</value>
</data>
<data name="InputEmptyOrNullError" xml:space="preserve">
<value>Input cannot be empty or null</value>
</data>
<data name="FailedToWriteManifests" xml:space="preserve">
<value>Failed to write manifests to directory '{0}': {1}</value>
<comment>{Locked="{0}","{1}"}</comment>
</data>
<data name="InputOptionDescription" xml:space="preserve">
<value>The JSON input</value>
</data>
<data name="ModuleOptionDescription" xml:space="preserve">
<value>The module name</value>
</data>
<data name="OutputDirectoryOptionDescription" xml:space="preserve">
<value>The output directory</value>
</data>
<data name="ResourceOptionDescription" xml:space="preserve">
<value>The resource name</value>
</data>
<data name="InvalidJsonInputError" xml:space="preserve">
<value>Invalid JSON input: {0}</value>
<comment>{Locked="{0}"}</comment>
</data>
<data name="OutputDirectoryEmptyOrNullError" xml:space="preserve">
<value>Output directory cannot be empty or null</value>
</data>
<data name="InvalidOutputDirectoryError" xml:space="preserve">
<value>Invalid output directory: {0}</value>
<comment>{Locked="{0}"}</comment>
</data>
<data name="InvalidResourceNameError" xml:space="preserve">
<value>Invalid resource name. Valid resource names are: {0}</value>
<comment>{Locked="{0}"}</comment>
</data>
</root>

46
src/modules/MouseUtils/MousePointerCrosshairs/InclusiveCrosshairs.cpp
View File

@@ -94,6 +94,21 @@ public:
}
}
static void SetCrosshairsOrientation(CrosshairsOrientation orientation)
{
if (instance != nullptr)
{
auto dispatcherQueue = instance->m_dispatcherQueueController.DispatcherQueue();
dispatcherQueue.TryEnqueue([orientation]() {
if (instance != nullptr)
{
instance->m_crosshairs_orientation = orientation;
instance->UpdateCrosshairsPosition();
}
});
}
}
private:
enum class MouseButton
{
@@ -147,6 +162,7 @@ private:
int m_crosshairs_border_size = INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_BORDER_SIZE;
bool m_crosshairs_is_fixed_length_enabled = INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_IS_FIXED_LENGTH_ENABLED;
int m_crosshairs_fixed_length = INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_FIXED_LENGTH;
CrosshairsOrientation m_crosshairs_orientation = static_cast<CrosshairsOrientation>(INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_ORIENTATION);
float m_crosshairs_opacity = max(0.f, min(1.f, (float)INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_OPACITY / 100.0f));
bool m_crosshairs_auto_hide = INCLUSIVE_MOUSE_DEFAULT_AUTO_HIDE;
};
@@ -286,6 +302,8 @@ void InclusiveCrosshairs::UpdateCrosshairsPosition()
float halfPixelAdjustment = m_crosshairs_thickness % 2 == 1 ? 0.5f : 0.0f;
float borderSizePadding = m_crosshairs_border_size * 2.f;
// Left and Right crosshairs (horizontal line)
if (m_crosshairs_orientation == CrosshairsOrientation::Both || m_crosshairs_orientation == CrosshairsOrientation::HorizontalOnly)
{
float leftCrosshairsFullScreenLength = ptCursor.x - ptMonitorUpperLeft.x - m_crosshairs_radius + halfPixelAdjustment * 2.f;
float leftCrosshairsLength = m_crosshairs_is_fixed_length_enabled ? m_crosshairs_fixed_length : leftCrosshairsFullScreenLength;
@@ -294,9 +312,7 @@ void InclusiveCrosshairs::UpdateCrosshairsPosition()
m_left_crosshairs_border.Size({ leftCrosshairsBorderLength, m_crosshairs_thickness + borderSizePadding });
m_left_crosshairs.Offset({ ptCursor.x - m_crosshairs_radius + halfPixelAdjustment * 2.f, ptCursor.y + halfPixelAdjustment, .0f });
m_left_crosshairs.Size({ leftCrosshairsLength, static_cast<float>(m_crosshairs_thickness) });
}
{
float rightCrosshairsFullScreenLength = static_cast<float>(ptMonitorBottomRight.x) - ptCursor.x - m_crosshairs_radius;
float rightCrosshairsLength = m_crosshairs_is_fixed_length_enabled ? m_crosshairs_fixed_length : rightCrosshairsFullScreenLength;
float rightCrosshairsBorderLength = m_crosshairs_is_fixed_length_enabled ? m_crosshairs_fixed_length + borderSizePadding : rightCrosshairsFullScreenLength + m_crosshairs_border_size;
@@ -305,7 +321,17 @@ void InclusiveCrosshairs::UpdateCrosshairsPosition()
m_right_crosshairs.Offset({ static_cast<float>(ptCursor.x) + m_crosshairs_radius, ptCursor.y + halfPixelAdjustment, .0f });
m_right_crosshairs.Size({ rightCrosshairsLength, static_cast<float>(m_crosshairs_thickness) });
}
else
{
// Hide horizontal crosshairs by setting size to 0
m_left_crosshairs_border.Size({ 0.0f, 0.0f });
m_left_crosshairs.Size({ 0.0f, 0.0f });
m_right_crosshairs_border.Size({ 0.0f, 0.0f });
m_right_crosshairs.Size({ 0.0f, 0.0f });
}
// Top and Bottom crosshairs (vertical line)
if (m_crosshairs_orientation == CrosshairsOrientation::Both || m_crosshairs_orientation == CrosshairsOrientation::VerticalOnly)
{
float topCrosshairsFullScreenLength = ptCursor.y - ptMonitorUpperLeft.y - m_crosshairs_radius + halfPixelAdjustment * 2.f;
float topCrosshairsLength = m_crosshairs_is_fixed_length_enabled ? m_crosshairs_fixed_length : topCrosshairsFullScreenLength;
@@ -314,9 +340,7 @@ void InclusiveCrosshairs::UpdateCrosshairsPosition()
m_top_crosshairs_border.Size({ m_crosshairs_thickness + borderSizePadding, topCrosshairsBorderLength });
m_top_crosshairs.Offset({ ptCursor.x + halfPixelAdjustment, ptCursor.y - m_crosshairs_radius + halfPixelAdjustment * 2.f, .0f });
m_top_crosshairs.Size({ static_cast<float>(m_crosshairs_thickness), topCrosshairsLength });
}
{
float bottomCrosshairsFullScreenLength = static_cast<float>(ptMonitorBottomRight.y) - ptCursor.y - m_crosshairs_radius;
float bottomCrosshairsLength = m_crosshairs_is_fixed_length_enabled ? m_crosshairs_fixed_length : bottomCrosshairsFullScreenLength;
float bottomCrosshairsBorderLength = m_crosshairs_is_fixed_length_enabled ? m_crosshairs_fixed_length + borderSizePadding : bottomCrosshairsFullScreenLength + m_crosshairs_border_size;
@@ -325,6 +349,14 @@ void InclusiveCrosshairs::UpdateCrosshairsPosition()
m_bottom_crosshairs.Offset({ ptCursor.x + halfPixelAdjustment, static_cast<float>(ptCursor.y) + m_crosshairs_radius, .0f });
m_bottom_crosshairs.Size({ static_cast<float>(m_crosshairs_thickness), bottomCrosshairsLength });
}
else
{
// Hide vertical crosshairs by setting size to 0
m_top_crosshairs_border.Size({ 0.0f, 0.0f });
m_top_crosshairs.Size({ 0.0f, 0.0f });
m_bottom_crosshairs_border.Size({ 0.0f, 0.0f });
m_bottom_crosshairs.Size({ 0.0f, 0.0f });
}
}
LRESULT CALLBACK InclusiveCrosshairs::MouseHookProc(int nCode, WPARAM wParam, LPARAM lParam) noexcept
@@ -398,6 +430,7 @@ void InclusiveCrosshairs::ApplySettings(InclusiveCrosshairsSettings& settings, b
m_crosshairs_auto_hide = settings.crosshairsAutoHide;
m_crosshairs_is_fixed_length_enabled = settings.crosshairsIsFixedLengthEnabled;
m_crosshairs_fixed_length = settings.crosshairsFixedLength;
m_crosshairs_orientation = settings.crosshairsOrientation;
if (applyToRunTimeObjects)
{
@@ -618,6 +651,11 @@ void InclusiveCrosshairsSetExternalControl(bool enabled)
InclusiveCrosshairs::SetExternalControl(enabled);
}
void InclusiveCrosshairsSetOrientation(CrosshairsOrientation orientation)
{
InclusiveCrosshairs::SetCrosshairsOrientation(orientation);
}
int InclusiveCrosshairsMain(HINSTANCE hInstance, InclusiveCrosshairsSettings& settings)
{
Logger::info("Starting a crosshairs instance.");

10
src/modules/MouseUtils/MousePointerCrosshairs/InclusiveCrosshairs.h
View File

@@ -10,8 +10,16 @@ constexpr int INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_BORDER_SIZE = 1;
constexpr bool INCLUSIVE_MOUSE_DEFAULT_AUTO_HIDE = false;
constexpr bool INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_IS_FIXED_LENGTH_ENABLED = false;
constexpr int INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_FIXED_LENGTH = 1;
constexpr int INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_ORIENTATION = 0; // 0=Both, 1=Vertical, 2=Horizontal
constexpr bool INCLUSIVE_MOUSE_DEFAULT_AUTO_ACTIVATE = false;
enum struct CrosshairsOrientation : int
{
Both = 0,
VerticalOnly = 1,
HorizontalOnly = 2,
};
struct InclusiveCrosshairsSettings
{
winrt::Windows::UI::Color crosshairsColor = INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_COLOR;
@@ -23,6 +31,7 @@ struct InclusiveCrosshairsSettings
bool crosshairsAutoHide = INCLUSIVE_MOUSE_DEFAULT_AUTO_HIDE;
bool crosshairsIsFixedLengthEnabled = INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_IS_FIXED_LENGTH_ENABLED;
int crosshairsFixedLength = INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_FIXED_LENGTH;
CrosshairsOrientation crosshairsOrientation = static_cast<CrosshairsOrientation>(INCLUSIVE_MOUSE_DEFAULT_CROSSHAIRS_ORIENTATION);
bool autoActivate = INCLUSIVE_MOUSE_DEFAULT_AUTO_ACTIVATE;
};
@@ -35,3 +44,4 @@ void InclusiveCrosshairsRequestUpdatePosition();
void InclusiveCrosshairsEnsureOn();
void InclusiveCrosshairsEnsureOff();
void InclusiveCrosshairsSetExternalControl(bool enabled);
void InclusiveCrosshairsSetOrientation(CrosshairsOrientation orientation);

2
src/modules/MouseUtils/MousePointerCrosshairs/MousePointerCrosshairs.vcxproj
View File

@@ -80,7 +80,7 @@
</ItemDefinitionGroup>
<ItemDefinitionGroup>
<ClCompile>
<AdditionalIncludeDirectories>$(SolutionDir)src\;$(SolutionDir)src\modules;$(SolutionDir)src\common\Telemetry;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
<AdditionalIncludeDirectories>..\..\..\;..\..\..\modules;..\..\..\common\Telemetry;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
</ClCompile>
</ItemDefinitionGroup>
<ItemGroup>

610
src/modules/MouseUtils/MousePointerCrosshairs/dllmain.cpp
View File

@@ -8,6 +8,7 @@
#include <thread>
#include <chrono>
#include <memory>
#include <algorithm>
extern void InclusiveCrosshairsRequestUpdatePosition();
extern void InclusiveCrosshairsEnsureOn();
@@ -30,6 +31,7 @@ namespace
const wchar_t JSON_KEY_CROSSHAIRS_AUTO_HIDE[] = L"crosshairs_auto_hide";
const wchar_t JSON_KEY_CROSSHAIRS_IS_FIXED_LENGTH_ENABLED[] = L"crosshairs_is_fixed_length_enabled";
const wchar_t JSON_KEY_CROSSHAIRS_FIXED_LENGTH[] = L"crosshairs_fixed_length";
const wchar_t JSON_KEY_CROSSHAIRS_ORIENTATION[] = L"crosshairs_orientation";
const wchar_t JSON_KEY_AUTO_ACTIVATE[] = L"auto_activate";
const wchar_t JSON_KEY_GLIDE_TRAVEL_SPEED[] = L"gliding_travel_speed";
const wchar_t JSON_KEY_GLIDE_DELAY_SPEED[] = L"gliding_delay_speed";
@@ -62,6 +64,9 @@ const static wchar_t* MODULE_NAME = L"MousePointerCrosshairs";
// Add a description that will we shown in the module settings page.
const static wchar_t* MODULE_DESC = L"<no description>";
class MousePointerCrosshairs; // fwd
static std::atomic<MousePointerCrosshairs*> g_instance{ nullptr }; // for hook callback
// Implement the PowerToy Module Interface and all the required methods.
class MousePointerCrosshairs : public PowertoyModuleIface
{
@@ -70,8 +75,11 @@ private:
bool m_enabled = false;
// Additional hotkeys (legacy API) to support multiple shortcuts
Hotkey m_activationHotkey{}; // Crosshairs toggle
Hotkey m_glidingHotkey{}; // Gliding cursor state machine
Hotkey m_activationHotkey{}; // Crosshairs toggle
Hotkey m_glidingHotkey{}; // Gliding cursor state machine
// Low-level keyboard hook (Escape to cancel gliding)
HHOOK m_keyboardHook = nullptr;
// Shared state for worker threads (decoupled from this lifetime)
struct State
@@ -84,7 +92,7 @@ private:
int currentYPos{ 0 };
int currentXSpeed{ 0 }; // pixels per base window
int currentYSpeed{ 0 }; // pixels per base window
int xPosSnapshot{ 0 }; // xPos captured at end of horizontal scan
int xPosSnapshot{ 0 }; // xPos captured at end of horizontal scan
// Fractional accumulators to spread movement across 10ms ticks
double xFraction{ 0.0 };
@@ -92,9 +100,9 @@ private:
// Speeds represent pixels per 200ms (min 5, max 60 enforced by UI/settings)
int fastHSpeed{ 30 }; // pixels per base window
int slowHSpeed{ 5 }; // pixels per base window
int slowHSpeed{ 5 }; // pixels per base window
int fastVSpeed{ 30 }; // pixels per base window
int slowVSpeed{ 5 }; // pixels per base window
int slowVSpeed{ 5 }; // pixels per base window
};
std::shared_ptr<State> m_state;
@@ -120,13 +128,16 @@ public:
LoggerHelpers::init_logger(MODULE_NAME, L"ModuleInterface", LogSettings::mousePointerCrosshairsLoggerName);
m_state = std::make_shared<State>();
init_settings();
g_instance.store(this, std::memory_order_release);
};
// Destroy the powertoy and free memory
virtual void destroy() override
{
UninstallKeyboardHook();
StopXTimer();
StopYTimer();
g_instance.store(nullptr, std::memory_order_release);
// Release shared state so worker threads (if any) exit when weak_ptr lock fails
m_state.reset();
delete this;
@@ -196,6 +207,7 @@ public:
{
m_enabled = false;
Trace::EnableMousePointerCrosshairs(false);
UninstallKeyboardHook();
StopXTimer();
StopYTimer();
m_glideState = 0;
@@ -220,7 +232,7 @@ public:
if (buffer && buffer_size >= 2)
{
buffer[0] = m_activationHotkey; // Crosshairs toggle
buffer[1] = m_glidingHotkey; // Gliding cursor toggle
buffer[1] = m_glidingHotkey; // Gliding cursor toggle
}
return 2;
}
@@ -256,6 +268,27 @@ private:
SendInput(2, inputs, sizeof(INPUT));
}
// Cancel gliding without performing the final click (Escape handling)
void CancelGliding()
{
int state = m_glideState.load();
if (state == 0)
{
return; // nothing to cancel
}
StopXTimer();
StopYTimer();
m_glideState = 0;
InclusiveCrosshairsEnsureOff();
InclusiveCrosshairsSetExternalControl(false);
if (auto s = m_state)
{
s->xFraction = 0.0;
s->yFraction = 0.0;
}
Logger::debug("Gliding cursor cancelled via Escape key");
}
// Stateless helpers operating on shared State
static void PositionCursorX(const std::shared_ptr<State>& s)
{
@@ -398,10 +431,14 @@ private:
{
case 0:
{
// For detect for cancel key
InstallKeyboardHook();
// Ensure crosshairs on (do not toggle off if already on)
InclusiveCrosshairsEnsureOn();
// Disable internal mouse hook so we control position updates explicitly
InclusiveCrosshairsSetExternalControl(true);
// Override crosshairs to show both for Gliding Cursor
InclusiveCrosshairsSetOrientation(CrosshairsOrientation::Both);
s->currentXPos = 0;
s->currentXSpeed = s->fastHSpeed;
@@ -444,12 +481,15 @@ private:
case 4:
default:
{
UninstallKeyboardHook();
// Stop vertical, click, turn crosshairs off, re-enable internal tracking, reset state
StopYTimer();
m_glideState = 0;
LeftClick();
InclusiveCrosshairsEnsureOff();
InclusiveCrosshairsSetExternalControl(false);
// Restore original crosshairs orientation setting
InclusiveCrosshairsSetOrientation(m_inclusiveCrosshairsSettings.crosshairsOrientation);
s->xFraction = 0.0;
s->yFraction = 0.0;
break;
@@ -457,6 +497,51 @@ private:
}
}
// Low-level keyboard hook procedures
static LRESULT CALLBACK LowLevelKeyboardProc(int nCode, WPARAM wParam, LPARAM lParam)
{
if (nCode == HC_ACTION)
{
const KBDLLHOOKSTRUCT* kb = reinterpret_cast<KBDLLHOOKSTRUCT*>(lParam);
if (kb && kb->vkCode == VK_ESCAPE && (wParam == WM_KEYDOWN || wParam == WM_SYSKEYDOWN))
{
if (auto inst = g_instance.load(std::memory_order_acquire))
{
if (inst->m_enabled && inst->m_glideState.load() != 0)
{
inst->UninstallKeyboardHook();
inst->CancelGliding();
}
}
}
}
// Do not swallow Escape; pass it through
return CallNextHookEx(nullptr, nCode, wParam, lParam);
}
void InstallKeyboardHook()
{
if (m_keyboardHook)
{
return; // already installed
}
m_keyboardHook = SetWindowsHookEx(WH_KEYBOARD_LL, LowLevelKeyboardProc, m_hModule, 0);
if (!m_keyboardHook)
{
Logger::error("Failed to install low-level keyboard hook for MousePointerCrosshairs (Escape cancel). GetLastError={}.", GetLastError());
}
}
void UninstallKeyboardHook()
{
if (m_keyboardHook)
{
UnhookWindowsHookEx(m_keyboardHook);
m_keyboardHook = nullptr;
}
}
// Load the settings file.
void init_settings()
{
@@ -475,264 +560,287 @@ private:
void parse_settings(PowerToysSettings::PowerToyValues& settings)
{
// TODO: refactor to use common/utils/json.h instead
// Refactored JSON parsing: uses inline try-catch blocks for each property for clarity and error handling
auto settingsObject = settings.get_raw_json();
InclusiveCrosshairsSettings inclusiveCrosshairsSettings;
if (settingsObject.GetView().Size())
{
try
{
// Parse primary activation HotKey (for centralized hook)
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_ACTIVATION_SHORTCUT);
auto hotkey = PowerToysSettings::HotkeyObject::from_json(jsonPropertiesObject);
auto propertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES);
// Parse activation hotkey
try
{
auto jsonHotkeyObject = propertiesObject.GetNamedObject(JSON_KEY_ACTIVATION_SHORTCUT);
auto hotkey = PowerToysSettings::HotkeyObject::from_json(jsonHotkeyObject);
m_activationHotkey.win = hotkey.win_pressed();
m_activationHotkey.ctrl = hotkey.ctrl_pressed();
m_activationHotkey.shift = hotkey.shift_pressed();
m_activationHotkey.alt = hotkey.alt_pressed();
m_activationHotkey.key = static_cast<unsigned char>(hotkey.get_code());
}
catch (...)
{
Logger::warn("Failed to initialize Mouse Pointer Crosshairs activation shortcut");
}
// Map to legacy Hotkey for multi-hotkey API
m_activationHotkey.win = hotkey.win_pressed();
m_activationHotkey.ctrl = hotkey.ctrl_pressed();
m_activationHotkey.shift = hotkey.shift_pressed();
m_activationHotkey.alt = hotkey.alt_pressed();
m_activationHotkey.key = static_cast<unsigned char>(hotkey.get_code());
}
catch (...)
{
Logger::warn("Failed to initialize Mouse Pointer Crosshairs activation shortcut");
}
try
{
// Parse Gliding Cursor HotKey
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_GLIDING_ACTIVATION_SHORTCUT);
auto hotkey = PowerToysSettings::HotkeyObject::from_json(jsonPropertiesObject);
m_glidingHotkey.win = hotkey.win_pressed();
m_glidingHotkey.ctrl = hotkey.ctrl_pressed();
m_glidingHotkey.shift = hotkey.shift_pressed();
m_glidingHotkey.alt = hotkey.alt_pressed();
m_glidingHotkey.key = static_cast<unsigned char>(hotkey.get_code());
}
catch (...)
{
// note that this is also defined in src\settings-ui\Settings.UI.Library\MousePointerCrosshairsProperties.cs, DefaultGlidingCursorActivationShortcut
// both need to be kept in sync!
Logger::warn("Failed to initialize Gliding Cursor activation shortcut. Using default Win+Alt+.");
m_glidingHotkey.win = true;
m_glidingHotkey.alt = true;
m_glidingHotkey.ctrl = false;
m_glidingHotkey.shift = false;
m_glidingHotkey.key = VK_OEM_PERIOD;
}
try
{
// Parse Opacity
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_CROSSHAIRS_OPACITY);
int value = static_cast<uint8_t>(jsonPropertiesObject.GetNamedNumber(JSON_KEY_VALUE));
if (value >= 0)
// Parse gliding cursor hotkey
try
{
inclusiveCrosshairsSettings.crosshairsOpacity = value;
auto jsonHotkeyObject = propertiesObject.GetNamedObject(JSON_KEY_GLIDING_ACTIVATION_SHORTCUT);
auto hotkey = PowerToysSettings::HotkeyObject::from_json(jsonHotkeyObject);
m_glidingHotkey.win = hotkey.win_pressed();
m_glidingHotkey.ctrl = hotkey.ctrl_pressed();
m_glidingHotkey.shift = hotkey.shift_pressed();
m_glidingHotkey.alt = hotkey.alt_pressed();
m_glidingHotkey.key = static_cast<unsigned char>(hotkey.get_code());
}
else
catch (...)
{
throw std::runtime_error("Invalid Opacity value");
Logger::warn("Failed to initialize Gliding Cursor activation shortcut. Using default Win+Alt+.");
m_glidingHotkey.win = true;
m_glidingHotkey.alt = true;
m_glidingHotkey.ctrl = false;
m_glidingHotkey.shift = false;
m_glidingHotkey.key = VK_OEM_PERIOD;
}
// Parse individual properties with error handling and defaults
try
{
if (propertiesObject.HasKey(L"crosshairs_opacity"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"crosshairs_opacity");
if (propertyObj.HasKey(L"value"))
{
inclusiveCrosshairsSettings.crosshairsOpacity = static_cast<int>(propertyObj.GetNamedNumber(L"value"));
}
}
}
catch (...) { /* Use default value */ }
try
{
if (propertiesObject.HasKey(L"crosshairs_radius"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"crosshairs_radius");
if (propertyObj.HasKey(L"value"))
{
inclusiveCrosshairsSettings.crosshairsRadius = static_cast<int>(propertyObj.GetNamedNumber(L"value"));
}
}
}
catch (...) { /* Use default value */ }
try
{
if (propertiesObject.HasKey(L"crosshairs_thickness"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"crosshairs_thickness");
if (propertyObj.HasKey(L"value"))
{
inclusiveCrosshairsSettings.crosshairsThickness = static_cast<int>(propertyObj.GetNamedNumber(L"value"));
}
}
}
catch (...) { /* Use default value */ }
try
{
if (propertiesObject.HasKey(L"crosshairs_border_size"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"crosshairs_border_size");
if (propertyObj.HasKey(L"value"))
{
inclusiveCrosshairsSettings.crosshairsBorderSize = static_cast<int>(propertyObj.GetNamedNumber(L"value"));
}
}
}
catch (...) { /* Use default value */ }
try
{
if (propertiesObject.HasKey(L"crosshairs_fixed_length"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"crosshairs_fixed_length");
if (propertyObj.HasKey(L"value"))
{
inclusiveCrosshairsSettings.crosshairsFixedLength = static_cast<int>(propertyObj.GetNamedNumber(L"value"));
}
}
}
catch (...) { /* Use default value */ }
try
{
if (propertiesObject.HasKey(L"crosshairs_auto_hide"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"crosshairs_auto_hide");
if (propertyObj.HasKey(L"value"))
{
inclusiveCrosshairsSettings.crosshairsAutoHide = propertyObj.GetNamedBoolean(L"value");
}
}
}
catch (...) { /* Use default value */ }
try
{
if (propertiesObject.HasKey(L"crosshairs_is_fixed_length_enabled"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"crosshairs_is_fixed_length_enabled");
if (propertyObj.HasKey(L"value"))
{
inclusiveCrosshairsSettings.crosshairsIsFixedLengthEnabled = propertyObj.GetNamedBoolean(L"value");
}
}
}
catch (...) { /* Use default value */ }
try
{
if (propertiesObject.HasKey(L"auto_activate"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"auto_activate");
if (propertyObj.HasKey(L"value"))
{
inclusiveCrosshairsSettings.autoActivate = propertyObj.GetNamedBoolean(L"value");
}
}
}
catch (...) { /* Use default value */ }
// Parse orientation with validation - this fixes the original issue!
try
{
if (propertiesObject.HasKey(L"crosshairs_orientation"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"crosshairs_orientation");
if (propertyObj.HasKey(L"value"))
{
int orientationValue = static_cast<int>(propertyObj.GetNamedNumber(L"value"));
if (orientationValue >= 0 && orientationValue <= 2)
{
inclusiveCrosshairsSettings.crosshairsOrientation = static_cast<CrosshairsOrientation>(orientationValue);
}
}
}
}
catch (...) { /* Use default value (Both = 0) */ }
// Parse colors with validation
try
{
if (propertiesObject.HasKey(L"crosshairs_color"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"crosshairs_color");
if (propertyObj.HasKey(L"value"))
{
std::wstring crosshairsColorValue = std::wstring(propertyObj.GetNamedString(L"value").c_str());
uint8_t r, g, b;
if (checkValidRGB(crosshairsColorValue, &r, &g, &b))
{
inclusiveCrosshairsSettings.crosshairsColor = winrt::Windows::UI::ColorHelper::FromArgb(255, r, g, b);
}
}
}
}
catch (...) { /* Use default color */ }
try
{
if (propertiesObject.HasKey(L"crosshairs_border_color"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"crosshairs_border_color");
if (propertyObj.HasKey(L"value"))
{
std::wstring borderColorValue = std::wstring(propertyObj.GetNamedString(L"value").c_str());
uint8_t r, g, b;
if (checkValidRGB(borderColorValue, &r, &g, &b))
{
inclusiveCrosshairsSettings.crosshairsBorderColor = winrt::Windows::UI::ColorHelper::FromArgb(255, r, g, b);
}
}
}
}
catch (...) { /* Use default border color */ }
// Parse speed settings with validation
try
{
if (propertiesObject.HasKey(L"gliding_travel_speed"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"gliding_travel_speed");
if (propertyObj.HasKey(L"value") && m_state)
{
int travelSpeedValue = static_cast<int>(propertyObj.GetNamedNumber(L"value"));
if (travelSpeedValue >= 5 && travelSpeedValue <= 60)
{
m_state->fastHSpeed = travelSpeedValue;
m_state->fastVSpeed = travelSpeedValue;
}
else
{
// Clamp to valid range
int clampedValue = travelSpeedValue;
if (clampedValue < 5) clampedValue = 5;
if (clampedValue > 60) clampedValue = 60;
m_state->fastHSpeed = clampedValue;
m_state->fastVSpeed = clampedValue;
Logger::warn("Travel speed value out of range, clamped to valid range");
}
}
}
}
catch (...)
{
if (m_state)
{
m_state->fastHSpeed = 25;
m_state->fastVSpeed = 25;
}
}
try
{
if (propertiesObject.HasKey(L"gliding_delay_speed"))
{
auto propertyObj = propertiesObject.GetNamedObject(L"gliding_delay_speed");
if (propertyObj.HasKey(L"value") && m_state)
{
int delaySpeedValue = static_cast<int>(propertyObj.GetNamedNumber(L"value"));
if (delaySpeedValue >= 5 && delaySpeedValue <= 60)
{
m_state->slowHSpeed = delaySpeedValue;
m_state->slowVSpeed = delaySpeedValue;
}
else
{
// Clamp to valid range
int clampedValue = delaySpeedValue;
if (clampedValue < 5) clampedValue = 5;
if (clampedValue > 60) clampedValue = 60;
m_state->slowHSpeed = clampedValue;
m_state->slowVSpeed = clampedValue;
Logger::warn("Delay speed value out of range, clamped to valid range");
}
}
}
}
catch (...)
{
if (m_state)
{
m_state->slowHSpeed = 5;
m_state->slowVSpeed = 5;
}
}
}
catch (...)
{
Logger::warn("Failed to initialize Opacity from settings. Will use default value");
}
try
{
// Parse crosshairs color
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_CROSSHAIRS_COLOR);
auto crosshairsColor = (std::wstring)jsonPropertiesObject.GetNamedString(JSON_KEY_VALUE);
uint8_t r, g, b;
if (!checkValidRGB(crosshairsColor, &r, &g, &b))
{
Logger::error("Crosshairs color RGB value is invalid. Will use default value");
}
else
{
inclusiveCrosshairsSettings.crosshairsColor = winrt::Windows::UI::ColorHelper::FromArgb(255, r, g, b);
}
}
catch (...)
{
Logger::warn("Failed to initialize crosshairs color from settings. Will use default value");
}
try
{
// Parse Radius
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_CROSSHAIRS_RADIUS);
int value = static_cast<int>(jsonPropertiesObject.GetNamedNumber(JSON_KEY_VALUE));
if (value >= 0)
{
inclusiveCrosshairsSettings.crosshairsRadius = value;
}
else
{
throw std::runtime_error("Invalid Radius value");
}
}
catch (...)
{
Logger::warn("Failed to initialize Radius from settings. Will use default value");
}
try
{
// Parse Thickness
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_CROSSHAIRS_THICKNESS);
int value = static_cast<int>(jsonPropertiesObject.GetNamedNumber(JSON_KEY_VALUE));
if (value >= 0)
{
inclusiveCrosshairsSettings.crosshairsThickness = value;
}
else
{
throw std::runtime_error("Invalid Thickness value");
}
}
catch (...)
{
Logger::warn("Failed to initialize Thickness from settings. Will use default value");
}
try
{
// Parse crosshairs border color
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_CROSSHAIRS_BORDER_COLOR);
auto crosshairsBorderColor = (std::wstring)jsonPropertiesObject.GetNamedString(JSON_KEY_VALUE);
uint8_t r, g, b;
if (!checkValidRGB(crosshairsBorderColor, &r, &g, &b))
{
Logger::error("Crosshairs border color RGB value is invalid. Will use default value");
}
else
{
inclusiveCrosshairsSettings.crosshairsBorderColor = winrt::Windows::UI::ColorHelper::FromArgb(255, r, g, b);
}
}
catch (...)
{
Logger::warn("Failed to initialize crosshairs border color from settings. Will use default value");
}
try
{
// Parse border size
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_CROSSHAIRS_BORDER_SIZE);
int value = static_cast<int>(jsonPropertiesObject.GetNamedNumber(JSON_KEY_VALUE));
if (value >= 0)
{
inclusiveCrosshairsSettings.crosshairsBorderSize = value;
}
else
{
throw std::runtime_error("Invalid Border Color value");
}
}
catch (...)
{
Logger::warn("Failed to initialize border color from settings. Will use default value");
}
try
{
// Parse auto hide
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_CROSSHAIRS_AUTO_HIDE);
inclusiveCrosshairsSettings.crosshairsAutoHide = jsonPropertiesObject.GetNamedBoolean(JSON_KEY_VALUE);
}
catch (...)
{
Logger::warn("Failed to initialize auto hide from settings. Will use default value");
}
try
{
// Parse whether the fixed length is enabled
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_CROSSHAIRS_IS_FIXED_LENGTH_ENABLED);
bool value = jsonPropertiesObject.GetNamedBoolean(JSON_KEY_VALUE);
inclusiveCrosshairsSettings.crosshairsIsFixedLengthEnabled = value;
}
catch (...)
{
Logger::warn("Failed to initialize fixed length enabled from settings. Will use default value");
}
try
{
// Parse fixed length
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_CROSSHAIRS_FIXED_LENGTH);
int value = static_cast<int>(jsonPropertiesObject.GetNamedNumber(JSON_KEY_VALUE));
if (value >= 0)
{
inclusiveCrosshairsSettings.crosshairsFixedLength = value;
}
else
{
throw std::runtime_error("Invalid Fixed Length value");
}
}
catch (...)
{
Logger::warn("Failed to initialize fixed length from settings. Will use default value");
}
try
{
// Parse auto activate
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_AUTO_ACTIVATE);
inclusiveCrosshairsSettings.autoActivate = jsonPropertiesObject.GetNamedBoolean(JSON_KEY_VALUE);
}
catch (...)
{
Logger::warn("Failed to initialize auto activate from settings. Will use default value");
}
try
{
// Parse Travel speed (fast speed mapping)
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_GLIDE_TRAVEL_SPEED);
int value = static_cast<int>(jsonPropertiesObject.GetNamedNumber(JSON_KEY_VALUE));
if (value >= 5 && value <= 60)
{
m_state->fastHSpeed = value;
m_state->fastVSpeed = value;
}
else if (value < 5)
{
m_state->fastHSpeed = 5; m_state->fastVSpeed = 5;
}
else
{
m_state->fastHSpeed = 60; m_state->fastVSpeed = 60;
}
}
catch (...)
{
Logger::warn("Failed to initialize gliding travel speed from settings. Using default 25.");
if (m_state)
{
m_state->fastHSpeed = 25;
m_state->fastVSpeed = 25;
}
}
try
{
// Parse Delay speed (slow speed mapping)
auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_GLIDE_DELAY_SPEED);
int value = static_cast<int>(jsonPropertiesObject.GetNamedNumber(JSON_KEY_VALUE));
if (value >= 5 && value <= 60)
{
m_state->slowHSpeed = value;
m_state->slowVSpeed = value;
}
else if (value < 5)
{
m_state->slowHSpeed = 5; m_state->slowVSpeed = 5;
}
else
{
m_state->slowHSpeed = 60; m_state->slowVSpeed = 60;
}
}
catch (...)
{
Logger::warn("Failed to initialize gliding delay speed from settings. Using default 5.");
if (m_state)
{
m_state->slowHSpeed = 5;
m_state->slowVSpeed = 5;
}
Logger::warn("Error parsing some MousePointerCrosshairs properties. Using defaults for failed properties.");
}
}
else
@@ -740,6 +848,7 @@ private:
Logger::info("Mouse Pointer Crosshairs settings are empty");
}
// Set default hotkeys if not configured
if (m_activationHotkey.key == 0)
{
m_activationHotkey.win = true;
@@ -756,6 +865,7 @@ private:
m_glidingHotkey.shift = false;
m_glidingHotkey.key = VK_OEM_PERIOD;
}
m_inclusiveCrosshairsSettings = inclusiveCrosshairsSettings;
}
};

10
src/modules/alwaysontop/AlwaysOnTopModuleInterface/dllmain.cpp
View File

@@ -258,16 +258,6 @@ private:
{
Logger::info("AlwaysOnTop settings are empty");
}
if (!m_hotkey.key)
{
Logger::info("AlwaysOnTop is going to use default shortcut");
m_hotkey.win = true;
m_hotkey.alt = false;
m_hotkey.shift = false;
m_hotkey.ctrl = true;
m_hotkey.key = 'T';
}
}
bool is_process_running()

8
src/modules/cmdpal/Core/Microsoft.CmdPal.Core.ViewModels/Microsoft.CmdPal.Core.ViewModels.csproj
View File

@@ -9,5 +9,13 @@
<ItemGroup>
<ProjectReference Include="..\Microsoft.CmdPal.Core.Common\Microsoft.CmdPal.Core.Common.csproj" />
</ItemGroup>
<ItemGroup>
<Compile Update="Properties\Resources.Designer.cs">
<DesignTime>True</DesignTime>
<AutoGen>True</AutoGen>
<DependentUpon>Resources.resx</DependentUpon>
</Compile>
</ItemGroup>
</Project>

2
src/modules/cmdpal/Core/Microsoft.CmdPal.Core.ViewModels/Properties/Resources.Designer.cs generated
View File

@@ -69,4 +69,4 @@ namespace Microsoft.CmdPal.Core.ViewModels.Properties {
}
}
}
}
}

59
src/modules/cmdpal/Core/Microsoft.CmdPal.Core.ViewModels/Properties/Resources.resx
View File

@@ -1,5 +1,64 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema
Version 2.0
The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.
Example:
... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>
There are any number of "resheader" rows that contain simple
name/value pairs.
Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.
The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:
Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.
mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">

3
src/modules/cmdpal/ExtensionTemplate/TemplateCmdPalExtension/Directory.Packages.props
View File

@@ -3,12 +3,13 @@
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
</PropertyGroup>
<ItemGroup>
<PackageVersion Include="Microsoft.CommandPalette.Extensions" Version="0.2.0" />
<PackageVersion Include="Microsoft.CommandPalette.Extensions" Version="0.5.250829002" />
<PackageVersion Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="9.0.0-preview.24508.2" />
<PackageVersion Include="Microsoft.Web.WebView2" Version="1.0.2903.40" />
<PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.183" />
<PackageVersion Include="Microsoft.Windows.CsWinRT" Version="2.2.0" />
<PackageVersion Include="Microsoft.Windows.SDK.BuildTools" Version="10.0.26100.4188" />
<PackageVersion Include="Microsoft.Windows.SDK.BuildTools.MSIX" Version="1.7.20250829.1" />
<PackageVersion Include="Microsoft.WindowsAppSDK" Version="1.8.250907003" />
<PackageVersion Include="Shmuelie.WinRTServer" Version="2.1.1" />
<PackageVersion Include="StyleCop.Analyzers" Version="1.2.0-beta.556" />

12
src/modules/cmdpal/ExtensionTemplate/TemplateCmdPalExtension/TemplateCmdPalExtension/TemplateCmdPalExtension.csproj
View File

@@ -40,10 +40,13 @@
<ItemGroup>
<PackageReference Include="Microsoft.CommandPalette.Extensions" />
<PackageReference Include="Microsoft.Windows.CsWinRT" />
<PackageReference Include="Microsoft.WindowsAppSDK" />
<PackageReference Include="Microsoft.Web.WebView2" />
<PackageReference Include="System.Text.Json" />
<PackageReference Include="Shmuelie.WinRTServer" />
<!-- Needed to enable building an MSIX package -->
<PackageReference Include="Microsoft.Windows.SDK.BuildTools.MSIX">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
</ItemGroup>
<!--
@@ -84,6 +87,9 @@
<!-- In Release builds, trimming is enabled by default.
feel free to disable this if needed -->
<PublishTrimmed>true</PublishTrimmed>
<!-- In release, also ignore the aforementioned ILLink warning -->
<ILLinkTreatWarningsAsErrors>false</ILLinkTreatWarningsAsErrors>
</PropertyGroup>

BIN
src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/Assets/template.zip
View File

Binary file not shown.

8
src/modules/cmdpal/Microsoft.CmdPal.UI/Helpers/BindTransformers.cs
View File

@@ -2,9 +2,17 @@
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using Microsoft.UI.Xaml;
namespace Microsoft.CmdPal.UI.Helpers;
internal static class BindTransformers
{
public static bool Negate(bool value) => !value;
public static Visibility EmptyToCollapsed(string? input)
=> string.IsNullOrEmpty(input) ? Visibility.Collapsed : Visibility.Visible;
public static Visibility EmptyOrWhitespaceToCollapsed(string? input)
=> string.IsNullOrWhiteSpace(input) ? Visibility.Collapsed : Visibility.Visible;
}

64
src/modules/cmdpal/Microsoft.CmdPal.UI/Pages/ShellPage.xaml
View File

@@ -41,6 +41,31 @@
FalseValue="Visible"
TrueValue="Collapsed" />
<Style
x:Key="DetailKeyTextBlockStyle"
BasedOn="{StaticResource CaptionTextBlockStyle}"
TargetType="TextBlock">
<Setter Property="IsTextSelectionEnabled" Value="True" />
<Setter Property="TextWrapping" Value="WrapWholeWords" />
<Setter Property="Foreground" Value="{ThemeResource TextFillColorSecondaryBrush}" />
</Style>
<Style
x:Key="SeparatorKeyTextBlockStyle"
BasedOn="{StaticResource BodyStrongTextBlockStyle}"
TargetType="TextBlock">
<Setter Property="IsTextSelectionEnabled" Value="True" />
<Setter Property="TextWrapping" Value="WrapWholeWords" />
</Style>
<Style
x:Key="DetailValueTextBlockStyle"
BasedOn="{StaticResource BodyTextBlockStyle}"
TargetType="TextBlock">
<Setter Property="IsTextSelectionEnabled" Value="True" />
<Setter Property="TextWrapping" Value="WrapWholeWords" />
</Style>
<DataTemplate x:Key="TagTemplate" x:DataType="coreViewModels:TagViewModel">
<cpcontrols:Tag
HorizontalAlignment="Left"
@@ -68,7 +93,7 @@
Margin="0,3,8,0"
SourceKey="{x:Bind Icon, Mode=OneWay}"
SourceRequested="{x:Bind help:IconCacheProvider.SourceRequested}" />
<TextBlock Text="{x:Bind Name}" />
<TextBlock Style="{StaticResource BodyTextBlockStyle}" Text="{x:Bind Name}" />
</StackPanel>
</Button>
</StackPanel>
@@ -76,31 +101,22 @@
<DataTemplate x:Key="DetailsLinkTemplate" x:DataType="coreViewModels:DetailsLinkViewModel">
<StackPanel Orientation="Vertical">
<TextBlock Style="{StaticResource DetailKeyTextBlockStyle}" Text="{x:Bind Key, Mode=OneWay}" />
<TextBlock
IsTextSelectionEnabled="True"
Text="{x:Bind Key, Mode=OneWay}"
TextWrapping="WrapWholeWords" />
<TextBlock
FontSize="12"
Foreground="{ThemeResource TextFillColorSecondaryBrush}"
IsTextSelectionEnabled="True"
Style="{StaticResource DetailValueTextBlockStyle}"
Text="{x:Bind Text, Mode=OneWay}"
TextWrapping="WrapWholeWords"
Visibility="{x:Bind IsText, Mode=OneWay}" />
<HyperlinkButton
Padding="0"
Content="{x:Bind Text, Mode=OneWay}"
FontSize="12"
NavigateUri="{x:Bind Link, Mode=OneWay}"
Visibility="{x:Bind IsLink, Mode=OneWay}" />
Visibility="{x:Bind IsLink, Mode=OneWay}">
<TextBlock Text="{x:Bind Text, Mode=OneWay}" TextWrapping="Wrap" />
</HyperlinkButton>
</StackPanel>
</DataTemplate>
<DataTemplate x:Key="DetailsCommandsTemplate" x:DataType="coreViewModels:DetailsCommandsViewModel">
<StackPanel Orientation="Vertical" Spacing="4">
<TextBlock
IsTextSelectionEnabled="True"
Text="{x:Bind Key, Mode=OneWay}"
TextWrapping="WrapWholeWords" />
<TextBlock Style="{StaticResource DetailKeyTextBlockStyle}" Text="{x:Bind Key, Mode=OneWay}" />
<ItemsControl
ItemTemplate="{StaticResource CommandTemplate}"
ItemsSource="{x:Bind Commands, Mode=OneWay}"
@@ -110,24 +126,20 @@
<DataTemplate x:Key="DetailsSeparatorTemplate" x:DataType="coreViewModels:DetailsSeparatorViewModel">
<StackPanel Margin="0,8,8,0" Orientation="Vertical">
<Border
Margin="8,0,0,0"
BorderBrush="{ThemeResource TextFillColorSecondaryBrush}"
Margin="0,0,0,0"
BorderBrush="{ThemeResource DividerStrokeColorDefaultBrush}"
BorderThickness="0,0,0,2">
<TextBlock
Margin="-8,0,0,8"
FontWeight="SemiBold"
IsTextSelectionEnabled="True"
Margin="0,0,0,0"
Style="{StaticResource SeparatorKeyTextBlockStyle}"
Text="{x:Bind Key, Mode=OneWay}"
TextWrapping="WrapWholeWords" />
Visibility="{x:Bind help:BindTransformers.EmptyOrWhitespaceToCollapsed(Key), FallbackValue=Collapsed}" />
</Border>
</StackPanel>
</DataTemplate>
<DataTemplate x:Key="DetailsTagsTemplate" x:DataType="coreViewModels:DetailsTagsViewModel">
<StackPanel Orientation="Vertical" Spacing="4">
<TextBlock
IsTextSelectionEnabled="True"
Text="{x:Bind Key, Mode=OneWay}"
TextWrapping="WrapWholeWords" />
<TextBlock Style="{StaticResource DetailKeyTextBlockStyle}" Text="{x:Bind Key, Mode=OneWay}" />
<ItemsControl
ItemTemplate="{StaticResource TagTemplate}"
ItemsSource="{x:Bind Tags, Mode=OneWay}"

4
src/modules/cmdpal/Microsoft.CmdPal.UI/Properties/PublishProfiles/win-arm64.pubxml
View File

@@ -11,9 +11,5 @@ https://go.microsoft.com/fwlink/?LinkID=208121.
<PublishDir>bin\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\publish\</PublishDir>
<SelfContained>true</SelfContained>
<PublishSingleFile>False</PublishSingleFile>
<PublishReadyToRun Condition="'$(Configuration)' == 'Debug'">False</PublishReadyToRun>
<PublishReadyToRun Condition="'$(Configuration)' != 'Debug'">True</PublishReadyToRun>
<PublishTrimmed Condition="'$(EnableCmdPalAOT)' == 'true'">True</PublishTrimmed>
<PublishTrimmed Condition="'$(EnableCmdPalAOT)' != 'true'">False</PublishTrimmed>
</PropertyGroup>
</Project>

4
src/modules/cmdpal/Microsoft.CmdPal.UI/Properties/PublishProfiles/win-x64.pubxml
View File

@@ -11,9 +11,5 @@ https://go.microsoft.com/fwlink/?LinkID=208121.
<PublishDir>bin\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\publish\</PublishDir>
<SelfContained>true</SelfContained>
<PublishSingleFile>False</PublishSingleFile>
<PublishReadyToRun Condition="'$(Configuration)' == 'Debug'">False</PublishReadyToRun>
<PublishReadyToRun Condition="'$(Configuration)' != 'Debug'">True</PublishReadyToRun>
<PublishTrimmed Condition="'$(EnableCmdPalAOT)' == 'true'">True</PublishTrimmed>
<PublishTrimmed Condition="'$(EnableCmdPalAOT)' != 'true'">False</PublishTrimmed>
</PropertyGroup>
</Project>

54
src/modules/cmdpal/Microsoft.CmdPal.UI/Settings/SettingsWindow.xaml
View File

@@ -24,10 +24,11 @@
<RowDefinition Height="Auto" />
<RowDefinition Height="*" />
</Grid.RowDefinitions>
<TitleBar x:Name="TitleBar">
<TitleBar x:Name="AppTitleBar" PaneToggleRequested="AppTitleBar_PaneToggleRequested">
<!-- This is a workaround for https://github.com/microsoft/microsoft-ui-xaml/issues/10374, once fixed we should just be using IconSource -->
<TitleBar.LeftHeader>
<ImageIcon
x:Name="WorkAroundIcon"
Height="16"
Margin="16,0,0,0"
Source="ms-appx:///Assets/icon.svg" />
@@ -36,18 +37,19 @@
<NavigationView
x:Name="NavView"
Grid.Row="1"
CompactModeThresholdWidth="1007"
DisplayModeChanged="NavView_DisplayModeChanged"
ExpandedModeThresholdWidth="1007"
IsBackButtonVisible="Collapsed"
IsPaneToggleButtonVisible="False"
IsSettingsVisible="False"
ItemInvoked="NavView_ItemInvoked"
Loaded="NavView_Loaded"
OpenPaneLength="200">
Loaded="NavView_Loaded">
<NavigationView.Resources>
<SolidColorBrush x:Key="NavigationViewContentBackground" Color="Transparent" />
<SolidColorBrush x:Key="NavigationViewContentGridBorderBrush" Color="Transparent" />
<Thickness x:Key="NavigationViewHeaderMargin">15,0,0,0</Thickness>
</NavigationView.Resources>
<NavigationView.MenuItems>
<NavigationViewItem
x:Uid="Settings_GeneralPage_NavigationViewItem_General"
@@ -58,34 +60,32 @@
Icon="{ui:FontIcon Glyph=&#xEA86;}"
Tag="Extensions" />
</NavigationView.MenuItems>
<Grid>
<Grid.RowDefinitions>
<RowDefinition Height="Auto" />
<RowDefinition Height="*" />
</Grid.RowDefinitions>
<BreadcrumbBar
x:Name="NavigationBreadcrumbBar"
Grid.Row="0"
MaxWidth="1000"
ItemClicked="NavigationBreadcrumbBar_ItemClicked"
ItemsSource="{x:Bind BreadCrumbs, Mode=OneWay}">
<BreadcrumbBar.ItemTemplate>
<DataTemplate x:DataType="local:Crumb">
<TextBlock Text="{x:Bind Label, Mode=OneWay}" />
</DataTemplate>
</BreadcrumbBar.ItemTemplate>
<BreadcrumbBar.Resources>
<ResourceDictionary>
<x:Double x:Key="BreadcrumbBarItemThemeFontSize">28</x:Double>
<Thickness x:Key="BreadcrumbBarChevronPadding">7,4,8,0</Thickness>
<FontWeight x:Key="BreadcrumbBarItemFontWeight">SemiBold</FontWeight>
<x:Double x:Key="BreadcrumbBarChevronFontSize">16</x:Double>
</ResourceDictionary>
</BreadcrumbBar.Resources>
</BreadcrumbBar>
<Grid Padding="16,0">
<BreadcrumbBar
x:Name="NavigationBreadcrumbBar"
MaxWidth="1000"
ItemClicked="NavigationBreadcrumbBar_ItemClicked"
ItemsSource="{x:Bind BreadCrumbs, Mode=OneWay}">
<BreadcrumbBar.ItemTemplate>
<DataTemplate x:DataType="local:Crumb">
<TextBlock Text="{x:Bind Label, Mode=OneWay}" />
</DataTemplate>
</BreadcrumbBar.ItemTemplate>
<BreadcrumbBar.Resources>
<ResourceDictionary>
<x:Double x:Key="BreadcrumbBarItemThemeFontSize">28</x:Double>
<Thickness x:Key="BreadcrumbBarChevronPadding">7,4,8,0</Thickness>
<FontWeight x:Key="BreadcrumbBarItemFontWeight">SemiBold</FontWeight>
<x:Double x:Key="BreadcrumbBarChevronFontSize">16</x:Double>
</ResourceDictionary>
</BreadcrumbBar.Resources>
</BreadcrumbBar>
</Grid>
<Frame x:Name="NavFrame" Grid.Row="1" />
</Grid>
</NavigationView>

14
src/modules/cmdpal/Microsoft.CmdPal.UI/Settings/SettingsWindow.xaml.cs
View File

@@ -14,6 +14,7 @@ using Microsoft.UI.Xaml.Automation.Peers;
using Microsoft.UI.Xaml.Controls;
using WinUIEx;
using RS_ = Microsoft.CmdPal.UI.Helpers.ResourceLoaderInstance;
using TitleBar = Microsoft.UI.Xaml.Controls.TitleBar;
namespace Microsoft.CmdPal.UI.Settings;
@@ -34,7 +35,7 @@ public sealed partial class SettingsWindow : WindowEx,
var title = RS_.GetString("SettingsWindowTitle");
this.AppWindow.Title = title;
this.AppWindow.TitleBar.PreferredHeightOption = TitleBarHeightOption.Tall;
this.TitleBar.Title = title;
this.AppTitleBar.Title = title;
PositionCentered();
WeakReferenceMessenger.Default.Register<NavigateToExtensionSettingsMessage>(this);
@@ -142,11 +143,13 @@ public sealed partial class SettingsWindow : WindowEx,
{
if (args.DisplayMode == NavigationViewDisplayMode.Compact || args.DisplayMode == NavigationViewDisplayMode.Minimal)
{
NavView.IsPaneToggleButtonVisible = false;
AppTitleBar.IsPaneToggleButtonVisible = true;
WorkAroundIcon.Margin = new Thickness(8, 0, 16, 0); // Required for workaround, see XAML comment
}
else
{
NavView.IsPaneToggleButtonVisible = true;
AppTitleBar.IsPaneToggleButtonVisible = false;
WorkAroundIcon.Margin = new Thickness(16, 0, 0, 0); // Required for workaround, see XAML comment
}
}
@@ -155,6 +158,11 @@ public sealed partial class SettingsWindow : WindowEx,
// This might come in on a background thread
DispatcherQueue.TryEnqueue(() => Close());
}
private void AppTitleBar_PaneToggleRequested(TitleBar sender, object args)
{
NavView.IsPaneOpen = !NavView.IsPaneOpen;
}
}
public readonly struct Crumb

3
src/modules/cmdpal/Tests/Microsoft.CmdPal.Ext.Shell.UnitTests/NormalizeCommandLineTests.cs
View File

@@ -23,6 +23,7 @@ public class NormalizeCommandLineTests : CommandPaletteUnitTestBase
[DataRow("ping bing.com", "c:\\Windows\\system32\\ping.exe", "bing.com")]
[DataRow("curl bing.com", "c:\\Windows\\system32\\curl.exe", "bing.com")]
[DataRow("ipconfig /all", "c:\\Windows\\system32\\ipconfig.exe", "/all")]
[DataRow("ipconfig a b \"c d\"", "c:\\Windows\\system32\\ipconfig.exe", "a b \"c d\"")]
public void NormalizeCommandLineSimple(string input, string expectedExe, string expectedArgs = "")
{
NormalizeTestCore(input, expectedExe, expectedArgs);
@@ -46,7 +47,7 @@ public class NormalizeCommandLineTests : CommandPaletteUnitTestBase
[TestMethod]
[DataRow("cmd --run --test", "C:\\Windows\\System32\\cmd.exe", "--run --test")]
[DataRow("cmd --run --test ", "C:\\Windows\\System32\\cmd.exe", "--run --test")]
[DataRow("cmd \"--run --test\" --pass", "C:\\Windows\\System32\\cmd.exe", "--run --test --pass")]
[DataRow("cmd \"--run --test\" --pass", "C:\\Windows\\System32\\cmd.exe", "\"--run --test\" --pass")]
public void NormalizeArgsWithSpaces(string input, string expectedExe, string expectedArgs = "")
{
NormalizeTestCore(input, expectedExe, expectedArgs);

2
src/modules/cmdpal/custom.props
View File

@@ -5,7 +5,7 @@
<XesUseOneStoreVersioning>true</XesUseOneStoreVersioning>
<XesBaseYearForStoreVersion>2025</XesBaseYearForStoreVersion>
<VersionMajor>0</VersionMajor>
<VersionMinor>5</VersionMinor>
<VersionMinor>6</VersionMinor>
<VersionInfoProductName>Microsoft Command Palette</VersionInfoProductName>
</PropertyGroup>
</Project>

93
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.Shell/Helpers/ShellListPageHelpers.cs
View File

@@ -120,7 +120,98 @@ public class ShellListPageHelpers
executable = segments[0];
if (segments.Length > 1)
{
arguments = string.Join(' ', segments[1..]);
arguments = ArgumentBuilder.BuildArguments(segments[1..]);
}
}
private static class ArgumentBuilder
{
internal static string BuildArguments(string[] arguments)
{
if (arguments.Length <= 0)
{
return string.Empty;
}
var stringBuilder = new StringBuilder();
foreach (var argument in arguments)
{
AppendArgument(stringBuilder, argument);
}
return stringBuilder.ToString();
}
private static void AppendArgument(StringBuilder stringBuilder, string argument)
{
if (stringBuilder.Length > 0)
{
stringBuilder.Append(' ');
}
if (argument.Length == 0 || ShouldBeQuoted(argument))
{
stringBuilder.Append('\"');
var index = 0;
while (index < argument.Length)
{
var c = argument[index++];
if (c == '\\')
{
var numBackSlash = 1;
while (index < argument.Length && argument[index] == '\\')
{
index++;
numBackSlash++;
}
if (index == argument.Length)
{
stringBuilder.Append('\\', numBackSlash * 2);
}
else if (argument[index] == '\"')
{
stringBuilder.Append('\\', (numBackSlash * 2) + 1);
stringBuilder.Append('\"');
index++;
}
else
{
stringBuilder.Append('\\', numBackSlash);
}
continue;
}
if (c == '\"')
{
stringBuilder.Append('\\');
stringBuilder.Append('\"');
continue;
}
stringBuilder.Append(c);
}
stringBuilder.Append('\"');
}
else
{
stringBuilder.Append(argument);
}
}
private static bool ShouldBeQuoted(string s)
{
foreach (var c in s)
{
if (char.IsWhiteSpace(c) || c == '\"')
{
return true;
}
}
return false;
}
}
}

BIN
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WebSearch/Assets/WebSearch.dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

34
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WebSearch/Assets/WebSearch.dark.svg Normal file
View File

@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg width="100%" height="100%" viewBox="0 0 40 40" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
<g>
<g transform="matrix(2.25,0,0,2.2493,-0.5,-4.49859)">
<path d="M10,18C14.389,18 18,14.389 18,10C18,5.611 14.389,2 10,2C5.611,2 2,5.611 2,10C2,14.389 5.611,18 10,18" style="fill:url(#_Linear1);fill-rule:nonzero;"/>
</g>
<g transform="matrix(2.25,0,0,2.2493,-0.49775,-4.48735)">
<path d="M7.853,2.291C7.52,2.759 7.246,3.266 7.037,3.801C6.669,4.707 6.387,5.796 6.211,7L2.58,7C2.45,7.323 2.34,7.657 2.25,8L6.09,8C5.969,9.331 5.969,10.669 6.091,12L2.251,12C2.341,12.343 2.451,12.677 2.581,13L6.211,13C6.387,14.204 6.669,15.293 7.037,16.199C7.246,16.734 7.52,17.241 7.853,17.709C8.552,17.903 9.274,18.001 10,18C10.726,18.001 11.448,17.903 12.147,17.709C12.48,17.241 12.754,16.734 12.963,16.199C13.331,15.293 13.613,14.204 13.789,13L17.419,13C17.549,12.677 17.659,12.343 17.748,12L13.908,12C14.032,10.67 14.032,9.33 13.908,8L17.748,8C17.66,7.66 17.55,7.326 17.418,7L13.79,7C13.614,5.796 13.332,4.707 12.964,3.801C12.755,3.266 12.481,2.759 12.148,2.291C11.449,2.097 10.726,1.999 10,2C9.274,1.999 8.552,2.097 7.853,2.291M7.223,7C7.389,5.924 7.643,4.965 7.963,4.178C8.261,3.445 8.605,2.886 8.966,2.518C9.324,2.153 9.672,2 10,2C10.328,2 10.676,2.153 11.034,2.518C11.394,2.886 11.739,3.445 12.037,4.178C12.357,4.965 12.611,5.924 12.777,7L7.223,7ZM10,18C10.328,18 10.676,17.847 11.034,17.482C11.394,17.114 11.739,16.555 12.037,15.822C12.357,15.035 12.611,14.076 12.777,13L7.223,13C7.39,14.076 7.644,15.035 7.964,15.822C8.262,16.555 8.606,17.114 8.967,17.482C9.325,17.847 9.673,18 10.001,18M7.001,10C7.001,10.692 7.034,11.362 7.097,12L12.905,12C12.968,11.335 13,10.668 13,10C13,9.308 12.967,8.638 12.904,8L7.096,8C7.032,8.665 7,9.332 7,10" style="fill:url(#_Radial2);"/>
</g>
<g transform="matrix(-2.25,0,0,2.22013,44.5,-3.97361)">
<path d="M10,18C14.389,18 18,14.389 18,10C18,5.611 14.389,2 10,2C5.611,2 2,5.611 2,10C2,14.389 5.611,18 10,18" style="fill:url(#_Radial3);fill-rule:nonzero;"/>
</g>
<g transform="matrix(-2.25,0,0,2.22013,44.5,-3.97361)">
<path d="M10,18C14.389,18 18,14.389 18,10C18,5.611 14.389,2 10,2C5.611,2 2,5.611 2,10C2,14.389 5.611,18 10,18" style="fill:url(#_Radial4);fill-rule:nonzero;"/>
</g>
<g transform="matrix(1.07186,0,0,1.07219,-1186.62,-806.111)">
<g transform="matrix(1.71182,0,0,1.71128,1106.73,763.62)">
<path d="M9.978,11.087C8.977,11.846 7.756,12.257 6.5,12.257C3.342,12.257 0.744,9.658 0.744,6.5C0.744,3.342 3.342,0.744 6.5,0.744C9.658,0.744 12.257,3.342 12.257,6.5C12.257,7.756 11.846,8.977 11.087,9.978L14.119,13.01C14.279,13.158 14.369,13.367 14.369,13.584C14.369,14.015 14.015,14.369 13.584,14.369C13.367,14.369 13.158,14.279 13.01,14.119L9.978,11.087Z" style="fill:url(#_Linear5);"/>
</g>
<g transform="matrix(1.71182,0,0,1.71128,1106.73,763.62)">
<path d="M9.978,11.087C8.977,11.846 7.756,12.257 6.5,12.257C3.342,12.257 0.744,9.658 0.744,6.5C0.744,3.342 3.342,0.744 6.5,0.744C9.658,0.744 12.257,3.342 12.257,6.5C12.257,7.756 11.846,8.977 11.087,9.978L14.119,13.01C14.279,13.158 14.369,13.367 14.369,13.584C14.369,14.015 14.015,14.369 13.584,14.369C13.367,14.369 13.158,14.279 13.01,14.119L9.978,11.087Z" style="fill:url(#_Linear6);"/>
</g>
</g>
</g>
<defs>
<linearGradient id="_Linear1" x1="0" y1="0" x2="1" y2="0.000311608" gradientUnits="userSpaceOnUse" gradientTransform="matrix(11.555,10.666,-10.666,11.555,5.556,4.667)"><stop offset="0" style="stop-color:rgb(41,195,255);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(32,82,203);stop-opacity:1"/></linearGradient>
<radialGradient id="_Radial2" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="matrix(4.20189,4.66481,-4.8129,4.338,6.091,12)"><stop offset="0" style="stop-color:rgb(59,213,255);stop-opacity:0"/><stop offset="0.45" style="stop-color:rgb(59,213,255);stop-opacity:0"/><stop offset="0.82" style="stop-color:rgb(59,213,255);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(59,213,255);stop-opacity:1"/></radialGradient>
<radialGradient id="_Radial3" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="matrix(-6.72116,-6.88408e-15,6.70252e-15,-6.72116,14,13.9512)"><stop offset="0" style="stop-color:rgb(0,53,128);stop-opacity:0.7"/><stop offset="1" style="stop-color:rgb(0,53,128);stop-opacity:0"/></radialGradient>
<radialGradient id="_Radial4" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="matrix(8.37502,6.37502,-6.91548,9.08503,13.2097,13.1926)"><stop offset="0" style="stop-color:rgb(27,68,177);stop-opacity:0.2"/><stop offset="0.41" style="stop-color:rgb(27,68,177);stop-opacity:0.2"/><stop offset="1" style="stop-color:rgb(27,68,177);stop-opacity:0"/></radialGradient>
<linearGradient id="_Linear5" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(-10.1905,10.1905,-10.1905,-10.1905,12.7341,0.475165)"><stop offset="0" style="stop-color:rgb(239,253,252);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(188,227,247);stop-opacity:1"/></linearGradient>
<linearGradient id="_Linear6" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(-10.1905,10.1905,-10.1905,-10.1905,12.7341,0.475165)"><stop offset="0" style="stop-color:rgb(239,253,252);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(188,227,247);stop-opacity:1"/></linearGradient>
</defs>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 5.8 KiB

BIN
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WebSearch/Assets/WebSearch.light.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

34
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WebSearch/Assets/WebSearch.light.svg Normal file
View File

@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg width="100%" height="100%" viewBox="0 0 40 40" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
<g>
<g transform="matrix(2.25,0,0,2.2493,-0.5,-4.49859)">
<path d="M10,18C14.389,18 18,14.389 18,10C18,5.611 14.389,2 10,2C5.611,2 2,5.611 2,10C2,14.389 5.611,18 10,18" style="fill:url(#_Linear1);fill-rule:nonzero;"/>
</g>
<g transform="matrix(2.25,0,0,2.2493,-0.49775,-4.48735)">
<path d="M7.853,2.291C7.52,2.759 7.246,3.266 7.037,3.801C6.669,4.707 6.387,5.796 6.211,7L2.58,7C2.45,7.323 2.34,7.657 2.25,8L6.09,8C5.969,9.331 5.969,10.669 6.091,12L2.251,12C2.341,12.343 2.451,12.677 2.581,13L6.211,13C6.387,14.204 6.669,15.293 7.037,16.199C7.246,16.734 7.52,17.241 7.853,17.709C8.552,17.903 9.274,18.001 10,18C10.726,18.001 11.448,17.903 12.147,17.709C12.48,17.241 12.754,16.734 12.963,16.199C13.331,15.293 13.613,14.204 13.789,13L17.419,13C17.549,12.677 17.659,12.343 17.748,12L13.908,12C14.032,10.67 14.032,9.33 13.908,8L17.748,8C17.66,7.66 17.55,7.326 17.418,7L13.79,7C13.614,5.796 13.332,4.707 12.964,3.801C12.755,3.266 12.481,2.759 12.148,2.291C11.449,2.097 10.726,1.999 10,2C9.274,1.999 8.552,2.097 7.853,2.291M7.223,7C7.389,5.924 7.643,4.965 7.963,4.178C8.261,3.445 8.605,2.886 8.966,2.518C9.324,2.153 9.672,2 10,2C10.328,2 10.676,2.153 11.034,2.518C11.394,2.886 11.739,3.445 12.037,4.178C12.357,4.965 12.611,5.924 12.777,7L7.223,7ZM10,18C10.328,18 10.676,17.847 11.034,17.482C11.394,17.114 11.739,16.555 12.037,15.822C12.357,15.035 12.611,14.076 12.777,13L7.223,13C7.39,14.076 7.644,15.035 7.964,15.822C8.262,16.555 8.606,17.114 8.967,17.482C9.325,17.847 9.673,18 10.001,18M7.001,10C7.001,10.692 7.034,11.362 7.097,12L12.905,12C12.968,11.335 13,10.668 13,10C13,9.308 12.967,8.638 12.904,8L7.096,8C7.032,8.665 7,9.332 7,10" style="fill:url(#_Radial2);"/>
</g>
<g transform="matrix(-2.25,0,0,2.22013,44.5,-3.97361)">
<path d="M10,18C14.389,18 18,14.389 18,10C18,5.611 14.389,2 10,2C5.611,2 2,5.611 2,10C2,14.389 5.611,18 10,18" style="fill:url(#_Radial3);fill-rule:nonzero;"/>
</g>
<g transform="matrix(-2.25,0,0,2.22013,44.5,-3.97361)">
<path d="M10,18C14.389,18 18,14.389 18,10C18,5.611 14.389,2 10,2C5.611,2 2,5.611 2,10C2,14.389 5.611,18 10,18" style="fill:url(#_Radial4);fill-rule:nonzero;"/>
</g>
<g transform="matrix(1.07186,0,0,1.07219,-1186.62,-806.111)">
<g transform="matrix(1.71182,0,0,1.71128,1106.73,763.62)">
<path d="M9.978,11.087C8.977,11.846 7.756,12.257 6.5,12.257C3.342,12.257 0.744,9.658 0.744,6.5C0.744,3.342 3.342,0.744 6.5,0.744C9.658,0.744 12.257,3.342 12.257,6.5C12.257,7.756 11.846,8.977 11.087,9.978L14.119,13.01C14.279,13.158 14.369,13.367 14.369,13.584C14.369,14.015 14.015,14.369 13.584,14.369C13.367,14.369 13.158,14.279 13.01,14.119L9.978,11.087Z" style="fill:url(#_Linear5);"/>
</g>
<g transform="matrix(1.71182,0,0,1.71128,1106.73,763.62)">
<path d="M9.978,11.087C8.977,11.846 7.756,12.257 6.5,12.257C3.342,12.257 0.744,9.658 0.744,6.5C0.744,3.342 3.342,0.744 6.5,0.744C9.658,0.744 12.257,3.342 12.257,6.5C12.257,7.756 11.846,8.977 11.087,9.978L14.119,13.01C14.279,13.158 14.369,13.367 14.369,13.584C14.369,14.015 14.015,14.369 13.584,14.369C13.367,14.369 13.158,14.279 13.01,14.119L9.978,11.087Z" style="fill:url(#_Linear6);"/>
</g>
</g>
</g>
<defs>
<linearGradient id="_Linear1" x1="0" y1="0" x2="1" y2="0.000311608" gradientUnits="userSpaceOnUse" gradientTransform="matrix(11.555,10.666,-10.666,11.555,5.556,4.667)"><stop offset="0" style="stop-color:rgb(41,195,255);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(32,82,203);stop-opacity:1"/></linearGradient>
<radialGradient id="_Radial2" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="matrix(4.20189,4.66481,-4.8129,4.338,6.091,12)"><stop offset="0" style="stop-color:rgb(59,213,255);stop-opacity:0"/><stop offset="0.45" style="stop-color:rgb(59,213,255);stop-opacity:0"/><stop offset="0.82" style="stop-color:rgb(59,213,255);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(59,213,255);stop-opacity:1"/></radialGradient>
<radialGradient id="_Radial3" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="matrix(-6.72116,-6.88408e-15,6.70252e-15,-6.72116,14,13.9512)"><stop offset="0" style="stop-color:rgb(0,53,128);stop-opacity:0.7"/><stop offset="1" style="stop-color:rgb(0,53,128);stop-opacity:0"/></radialGradient>
<radialGradient id="_Radial4" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="matrix(8.37502,6.37502,-6.91548,9.08503,13.2097,13.1926)"><stop offset="0" style="stop-color:rgb(27,68,177);stop-opacity:0.2"/><stop offset="0.41" style="stop-color:rgb(27,68,177);stop-opacity:0.2"/><stop offset="1" style="stop-color:rgb(27,68,177);stop-opacity:0"/></radialGradient>
<linearGradient id="_Linear5" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(-9.10051,9.10051,-9.10051,-9.10051,11.6441,1.56519)"><stop offset="0" style="stop-color:rgb(203,247,244);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(153,209,239);stop-opacity:1"/></linearGradient>
<linearGradient id="_Linear6" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(-9.10051,9.10051,-9.10051,-9.10051,11.6441,1.56519)"><stop offset="0" style="stop-color:rgb(203,247,244);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(153,209,239);stop-opacity:1"/></linearGradient>
</defs>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 5.8 KiB

BIN
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WebSearch/Assets/WebSearch.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 6.4 KiB

46
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WebSearch/Assets/WebSearch.svg
View File

@@ -1,46 +0,0 @@
<svg width="17" height="18" viewBox="0 0 17 18" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M8.5 16.5C12.9183 16.5 16.5 12.9183 16.5 8.5C16.5 4.08172 12.9183 0.5 8.5 0.5C4.08172 0.5 0.5 4.08172 0.5 8.5C0.5 12.9183 4.08172 16.5 8.5 16.5Z" fill="url(#paint0_linear_1874_17772)"/>
<g style="mix-blend-mode:overlay">
<mask id="mask0_1874_17772" style="mask-type:alpha" maskUnits="userSpaceOnUse" x="0" y="0" width="17" height="17">
<path d="M8.5 16.5C12.9183 16.5 16.5 12.9183 16.5 8.5C16.5 4.08172 12.9183 0.5 8.5 0.5C4.08172 0.5 0.5 4.08172 0.5 8.5C0.5 12.9183 4.08172 16.5 8.5 16.5Z" fill="url(#paint1_linear_1874_17772)"/>
</mask>
<g mask="url(#mask0_1874_17772)">
<g opacity="0.4">
<path d="M8.50093 16.9422C10.2322 16.9422 11.6356 13.1618 11.6356 8.49844C11.6356 3.83508 10.2322 0.0546875 8.50093 0.0546875C6.76967 0.0546875 5.36621 3.83508 5.36621 8.49844C5.36621 13.1618 6.76967 16.9422 8.50093 16.9422Z" stroke="white" stroke-width="0.888889" stroke-miterlimit="10"/>
<path d="M-1.27734 10.7227H17.3893" stroke="white" stroke-width="0.888889" stroke-miterlimit="10"/>
<path d="M-0.388672 6.27734H16.9447" stroke="white" stroke-width="0.888889" stroke-miterlimit="10"/>
</g>
</g>
</g>
<g filter="url(#filter0_dd_1874_17772)">
<path fill-rule="evenodd" clip-rule="evenodd" d="M3.49414 8.79454C3.49414 10.7549 5.0596 12.318 6.95878 12.318C8.85796 12.318 10.4234 10.7549 10.4234 8.79454C10.4234 6.8342 8.85796 5.27105 6.95878 5.27105C5.0596 5.27105 3.49414 6.8342 3.49414 8.79454ZM2.27778 8.79454C2.27778 11.4123 4.37353 13.5344 6.95878 13.5344C8.07111 13.5344 9.09282 13.1415 9.89597 12.4854L13.1894 15.8203C13.4314 16.0653 13.8237 16.0653 14.0656 15.8203C14.3076 15.5753 14.3076 15.1781 14.0656 14.9331L10.7498 11.5756C11.3096 10.7944 11.6398 9.83353 11.6398 8.79454C11.6398 6.17679 9.54403 4.05469 6.95878 4.05469C4.37353 4.05469 2.27778 6.17679 2.27778 8.79454Z" fill="url(#paint2_linear_1874_17772)"/>
</g>
<defs>
<filter id="filter0_dd_1874_17772" x="1.5678" y="3.69991" width="13.3888" height="13.3683" filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB">
<feFlood flood-opacity="0" result="BackgroundImageFix"/>
<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/>
<feOffset dy="0.354773"/>
<feGaussianBlur stdDeviation="0.354773"/>
<feColorMatrix type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0.32 0"/>
<feBlend mode="normal" in2="BackgroundImageFix" result="effect1_dropShadow_1874_17772"/>
<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/>
<feOffset dy="0.0709546"/>
<feGaussianBlur stdDeviation="0.0354773"/>
<feColorMatrix type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0.24 0"/>
<feBlend mode="normal" in2="effect1_dropShadow_1874_17772" result="effect2_dropShadow_1874_17772"/>
<feBlend mode="normal" in="SourceGraphic" in2="effect2_dropShadow_1874_17772" result="shape"/>
</filter>
<linearGradient id="paint0_linear_1874_17772" x1="4.05556" y1="3.16667" x2="15.6111" y2="13.8333" gradientUnits="userSpaceOnUse">
<stop stop-color="#30CCD7"/>
<stop offset="1" stop-color="#0669BC"/>
</linearGradient>
<linearGradient id="paint1_linear_1874_17772" x1="4.05556" y1="3.16667" x2="15.6111" y2="13.8333" gradientUnits="userSpaceOnUse">
<stop stop-color="#30CCD7"/>
<stop offset="1" stop-color="#0669BC"/>
</linearGradient>
<linearGradient id="paint2_linear_1874_17772" x1="3.84394" y1="4.05469" x2="14.6506" y2="16.7175" gradientUnits="userSpaceOnUse">
<stop stop-color="#E7ECF1"/>
<stop offset="1" stop-color="#CBCCCD"/>
</linearGradient>
</defs>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 3.6 KiB

8
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WebSearch/Icons.cs
View File

@@ -6,7 +6,11 @@ using Microsoft.CommandPalette.Extensions.Toolkit;
namespace Microsoft.CmdPal.Ext.WebSearch;
internal sealed class Icons
internal static class Icons
{
internal static IconInfo WebSearch { get; } = IconHelpers.FromRelativePath("Assets\\WebSearch.png");
internal static IconInfo WebSearch { get; } = IconHelpers.FromRelativePaths("Assets\\WebSearch.light.png", "Assets\\WebSearch.dark.png");
internal static IconInfo Search { get; } = new("\uE721");
internal static IconInfo History { get; } = new("\uE81C");
}

8
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WebSearch/Microsoft.CmdPal.Ext.WebSearch.csproj
View File

@@ -31,13 +31,7 @@
</ItemGroup>
<ItemGroup>
<None Remove="Assets\WebSearch.svg" />
</ItemGroup>
<ItemGroup>
<Content Update="Assets\WebSearch.png">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
<Content Update="Assets\WebSearch.svg">
<Content Update="Assets\**\*.*">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
</ItemGroup>

10
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WebSearch/Pages/WebSearchListPage.cs
View File

@@ -18,7 +18,6 @@ namespace Microsoft.CmdPal.Ext.WebSearch.Pages;
internal sealed partial class WebSearchListPage : DynamicListPage, IDisposable
{
private readonly IconInfo _newSearchIcon = new(string.Empty);
private readonly ISettingsInterface _settingsManager;
private readonly Lock _sync = new();
private static readonly CompositeFormat PluginInBrowserName = System.Text.CompositeFormat.Parse(Properties.Resources.plugin_in_browser_name);
@@ -32,7 +31,7 @@ internal sealed partial class WebSearchListPage : DynamicListPage, IDisposable
Name = Resources.command_item_title;
Title = Resources.command_item_title;
Icon = IconHelpers.FromRelativePath("Assets\\WebSearch.png");
Icon = Icons.WebSearch;
Id = "com.microsoft.cmdpal.websearch";
_settingsManager = settingsManager;
@@ -70,6 +69,7 @@ internal sealed partial class WebSearchListPage : DynamicListPage, IDisposable
var historyItem = items[index];
history.Add(new ListItem(new SearchWebCommand(historyItem.SearchString, _settingsManager))
{
Icon = Icons.History,
Title = historyItem.SearchString,
Subtitle = historyItem.Timestamp.ToString("g", CultureInfo.InvariantCulture),
});
@@ -82,7 +82,7 @@ internal sealed partial class WebSearchListPage : DynamicListPage, IDisposable
}
}
private static IListItem[] Query(string query, List<ListItem> historySnapshot, ISettingsInterface settingsManager, IconInfo newSearchIcon)
private static IListItem[] Query(string query, List<ListItem> historySnapshot, ISettingsInterface settingsManager)
{
ArgumentNullException.ThrowIfNull(query);
@@ -99,7 +99,7 @@ internal sealed partial class WebSearchListPage : DynamicListPage, IDisposable
{
Title = searchTerm,
Subtitle = string.Format(CultureInfo.CurrentCulture, PluginOpen, BrowserInfo.Name ?? BrowserInfo.MSEdgeName),
Icon = newSearchIcon,
Icon = Icons.Search,
};
results.Add(result);
}
@@ -117,7 +117,7 @@ internal sealed partial class WebSearchListPage : DynamicListPage, IDisposable
historySnapshot = _historyItems;
}
var items = Query(search ?? string.Empty, historySnapshot, _settingsManager, _newSearchIcon);
var items = Query(search ?? string.Empty, historySnapshot, _settingsManager);
lock (_sync)
{

Some files were not shown because too many files have changed in this diff Show More