mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-01-06 04:17:04 +01:00
Compare commits
17 Commits
leilzh/fan
...
user/yeela
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
856d8f6a0a | ||
|
|
075ea126df | ||
|
|
5d91cd6fb0 | ||
|
|
e4d1de036c | ||
|
|
6a7f76408d | ||
|
|
4751ceaeb5 | ||
|
|
2b0845b28e | ||
|
|
9ed0ef9139 | ||
|
|
0cc1207b21 | ||
|
|
05ae867ac8 | ||
|
|
377d134d40 | ||
|
|
be160d93f5 | ||
|
|
0c45799bb5 | ||
|
|
077af2c74b | ||
|
|
a0ac7efd2d | ||
|
|
3882db4479 | ||
|
|
eb35b3a249 |
1
.github/actions/spell-check/expect.txt
vendored
1
.github/actions/spell-check/expect.txt
vendored
@@ -70,6 +70,7 @@ APPMODEL
|
||||
APPNAME
|
||||
appref
|
||||
appsettings
|
||||
appsfeatures
|
||||
appwindow
|
||||
appwiz
|
||||
appxpackage
|
||||
|
||||
43
.github/copilot-instructions.md
vendored
Normal file
43
.github/copilot-instructions.md
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
# PowerToys – Copilot guide (concise)
|
||||
|
||||
This is the top-level guide for AI changes. Keep edits small, follow existing patterns, and cite exact paths in PRs.
|
||||
|
||||
Repo map (1‑line per area)
|
||||
- Core apps: `src/runner/**` (tray/loader), `src/settings-ui/**` (Settings app)
|
||||
- Shared libs: `src/common/**`
|
||||
- Modules: `src/modules/*` (one per utility; Command Palette in `src/modules/cmdpal/**`)
|
||||
- Build tools/docs: `tools/**`, `doc/devdocs/**`
|
||||
|
||||
Build and test (defaults)
|
||||
- Prerequisites: Visual Studio 2022 17.4+, minimal Windows 10 1803+.
|
||||
- Build discipline:
|
||||
- One terminal per operation (build → test). Don’t switch/open new ones mid-flow.
|
||||
- After making changes, `cd` to the project folder that changed (`.csproj`/`.vcxproj`).
|
||||
- Use script(s) to build, synchronously block and wait in foreground for it to finish: `tools/build/build.ps1|.cmd` (current folder), `build-essentials.*` (once per brand new build for missing nuget packages)
|
||||
- Treat build **exit code 0** as success; any non-zero exit code is a failure, have Copilot read the errors log in the build folder (e.g., `build.*.*.errors.log`) and surface problems.
|
||||
- Don’t start tests or launch Runner until the previous step succeeded.
|
||||
- Tests (fast + targeted):
|
||||
- Find the test project by product code prefix (e.g., FancyZones, AdvancedPaste). Look for a sibling folder or 1–2 levels up named like `<Product>*UnitTests` or `<Product>*UITests`.
|
||||
- Build the test project, wait for **exit**, then run only those tests via VS Test Explorer or `vstest.console.exe` with filters. Avoid `dotnet test` in this repo.
|
||||
- Add/adjust tests when changing behavior; if skipped, state why (e.g., comment-only, string rename).
|
||||
|
||||
Pull requests (expectations)
|
||||
- Atomic: one logical change; no drive‑by refactors.
|
||||
- Describe: problem / approach / risk / test evidence.
|
||||
- List: touched paths if not obvious.
|
||||
|
||||
When to ask for clarification
|
||||
- Ambiguous spec after scanning relevant docs (see below).
|
||||
- Cross-module impact (shared enum/struct) not clear.
|
||||
- Security / elevation / installer changes.
|
||||
|
||||
Logging (use existing stacks)
|
||||
- C++: `src/common/logger/**` (`Logger::info|warn|error|debug`). Keep hot paths quiet (hooks, tight loops).
|
||||
- C#: `ManagedCommon.Logger` (`LogInfo|LogWarning|LogError|LogDebug|LogTrace`). Some UIs use injected `ILogger` via `LoggerInstance.Logger`.
|
||||
|
||||
Docs to consult
|
||||
- `tools/build/BUILD-GUIDELINES.md`
|
||||
- `doc/devdocs/core/architecture.md`, `doc/devdocs/core/runner.md`, `doc/devdocs/core/settings/readme.md`, `doc/devdocs/modules/readme.md`
|
||||
|
||||
Done checklist (self review before finishing)
|
||||
- Build clean? Tests updated/passed? No unintended formatting? Any new dependency? Documented skips?
|
||||
16
src/common/common.instructions.md
Normal file
16
src/common/common.instructions.md
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
applyTo: "**/*.cs,**/*.cpp,**/*.c,**/*.h,**/*.hpp"
|
||||
---
|
||||
# Common – shared libraries guidance (concise)
|
||||
|
||||
Scope
|
||||
- Logging, IPC, settings, DPI, telemetry, utilities consumed by multiple modules.
|
||||
|
||||
Guidelines
|
||||
- Avoid breaking public headers/APIs; if changed, search & update all callers.
|
||||
- Coordinate ABI-impacting struct/class layout changes; keep binary compatibility.
|
||||
- Watch perf in hot paths (hooks, timers, serialization); avoid avoidable allocations.
|
||||
- Ask before adding third‑party deps or changing serialization formats.
|
||||
|
||||
Acceptance
|
||||
- No unintended ABI breaks, no noisy logs, new non-obvious symbols briefly commented.
|
||||
@@ -20,30 +20,15 @@
|
||||
<RowDefinition Height="Auto" />
|
||||
<RowDefinition Height="*" />
|
||||
</Grid.RowDefinitions>
|
||||
<Grid
|
||||
x:Name="AppTitleBar"
|
||||
Height="32"
|
||||
ColumnSpacing="16">
|
||||
<Grid.ColumnDefinitions>
|
||||
<ColumnDefinition x:Name="LeftPaddingColumn" Width="0" />
|
||||
<ColumnDefinition x:Name="IconColumn" Width="Auto" />
|
||||
<ColumnDefinition x:Name="TitleColumn" Width="Auto" />
|
||||
<ColumnDefinition x:Name="RightDragColumn" Width="*" />
|
||||
<ColumnDefinition x:Name="RightPaddingColumn" Width="0" />
|
||||
</Grid.ColumnDefinitions>
|
||||
<Image
|
||||
Grid.Column="1"
|
||||
Width="16"
|
||||
Height="16"
|
||||
VerticalAlignment="Center"
|
||||
Source="../Assets/FileLocksmith/Icon.ico" />
|
||||
<TextBlock
|
||||
x:Name="AppTitleTextBlock"
|
||||
Grid.Column="2"
|
||||
VerticalAlignment="Center"
|
||||
Style="{StaticResource CaptionTextBlockStyle}" />
|
||||
</Grid>
|
||||
|
||||
<TitleBar x:Name="titleBar">
|
||||
<!-- 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
|
||||
Height="16"
|
||||
Margin="16,0,0,0"
|
||||
Source="/Assets/FileLocksmith/Icon.ico" />
|
||||
</TitleBar.LeftHeader>
|
||||
</TitleBar>
|
||||
<views:MainPage x:Name="mainPage" Grid.Row="1" />
|
||||
</Grid>
|
||||
</winuiex:WindowEx>
|
||||
</winuiex:WindowEx>
|
||||
@@ -18,30 +18,16 @@ namespace FileLocksmithUI
|
||||
{
|
||||
InitializeComponent();
|
||||
mainPage.ViewModel.IsElevated = isElevated;
|
||||
SetTitleBar(titleBar);
|
||||
ExtendsContentIntoTitleBar = true;
|
||||
SetTitleBar(AppTitleBar);
|
||||
Activated += MainWindow_Activated;
|
||||
AppWindow.TitleBar.PreferredHeightOption = TitleBarHeightOption.Tall;
|
||||
AppWindow.SetIcon("Assets/FileLocksmith/Icon.ico");
|
||||
WindowHelpers.ForceTopBorder1PixelInsetOnWindows10(this.GetWindowHandle());
|
||||
|
||||
var loader = ResourceLoaderInstance.ResourceLoader;
|
||||
var title = isElevated ? loader.GetString("AppAdminTitle") : loader.GetString("AppTitle");
|
||||
Title = title;
|
||||
AppTitleTextBlock.Text = title;
|
||||
}
|
||||
|
||||
private void MainWindow_Activated(object sender, WindowActivatedEventArgs args)
|
||||
{
|
||||
if (args.WindowActivationState == WindowActivationState.Deactivated)
|
||||
{
|
||||
AppTitleTextBlock.Foreground =
|
||||
(SolidColorBrush)App.Current.Resources["WindowCaptionForegroundDisabled"];
|
||||
}
|
||||
else
|
||||
{
|
||||
AppTitleTextBlock.Foreground =
|
||||
(SolidColorBrush)App.Current.Resources["WindowCaptionForeground"];
|
||||
}
|
||||
titleBar.Title = title;
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
|
||||
@@ -190,7 +190,7 @@
|
||||
TextWrapping="Wrap" />
|
||||
</ContentDialog>
|
||||
<ContentDialog x:Name="ProcessFilesListDialog" x:Uid="ProcessFilesListDialog">
|
||||
<ScrollViewer Padding="15" HorizontalScrollBarVisibility="Auto">
|
||||
<ScrollViewer Padding="16" HorizontalScrollBarVisibility="Auto">
|
||||
<TextBlock
|
||||
x:Name="ProcessFilesListDialogTextBlock"
|
||||
x:Uid="ProcessFilesListDialogTextBlock"
|
||||
|
||||
@@ -49,7 +49,9 @@ namespace Awake.Core
|
||||
|
||||
private static DateTimeOffset ExpireAt { get; set; }
|
||||
|
||||
private static readonly CompositeFormat AwakeMinute = CompositeFormat.Parse(Resources.AWAKE_MINUTE);
|
||||
private static readonly CompositeFormat AwakeMinutes = CompositeFormat.Parse(Resources.AWAKE_MINUTES);
|
||||
private static readonly CompositeFormat AwakeHour = CompositeFormat.Parse(Resources.AWAKE_HOUR);
|
||||
private static readonly CompositeFormat AwakeHours = CompositeFormat.Parse(Resources.AWAKE_HOURS);
|
||||
private static readonly BlockingCollection<ExecutionState> _stateQueue;
|
||||
private static CancellationTokenSource _tokenSource;
|
||||
@@ -451,7 +453,7 @@ namespace Awake.Core
|
||||
Dictionary<string, uint> optionsList = new()
|
||||
{
|
||||
{ string.Format(CultureInfo.InvariantCulture, AwakeMinutes, 30), 1800 },
|
||||
{ string.Format(CultureInfo.InvariantCulture, AwakeHours, 1), 3600 },
|
||||
{ string.Format(CultureInfo.InvariantCulture, AwakeHour, 1), 3600 },
|
||||
{ string.Format(CultureInfo.InvariantCulture, AwakeHours, 2), 7200 },
|
||||
};
|
||||
return optionsList;
|
||||
|
||||
@@ -159,6 +159,15 @@ namespace Awake.Properties {
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks up a localized string similar to {0} hour.
|
||||
/// </summary>
|
||||
internal static string AWAKE_HOUR {
|
||||
get {
|
||||
return ResourceManager.GetString("AWAKE_HOUR", resourceCulture);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks up a localized string similar to {0} hours.
|
||||
/// </summary>
|
||||
@@ -240,6 +249,15 @@ namespace Awake.Properties {
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks up a localized string similar to {0} minute.
|
||||
/// </summary>
|
||||
internal static string AWAKE_MINUTE {
|
||||
get {
|
||||
return ResourceManager.GetString("AWAKE_MINUTE", resourceCulture);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks up a localized string similar to {0} minutes.
|
||||
/// </summary>
|
||||
|
||||
@@ -123,6 +123,10 @@
|
||||
<data name="AWAKE_EXIT" xml:space="preserve">
|
||||
<value>Exit</value>
|
||||
</data>
|
||||
<data name="AWAKE_HOUR" xml:space="preserve">
|
||||
<value>{0} hour</value>
|
||||
<comment>{0} shouldn't be removed. It will be replaced by the number 1 at runtime by the application. Used for defining a period to keep the PC awake.</comment>
|
||||
</data>
|
||||
<data name="AWAKE_HOURS" xml:space="preserve">
|
||||
<value>{0} hours</value>
|
||||
<comment>{0} shouldn't be removed. It will be replaced by a number greater than 1 at runtime by the application. Used for defining a period to keep the PC awake.</comment>
|
||||
@@ -142,6 +146,10 @@
|
||||
<value>Keep awake until expiration date and time</value>
|
||||
<comment>Keep the system awake until expiration date and time</comment>
|
||||
</data>
|
||||
<data name="AWAKE_MINUTE" xml:space="preserve">
|
||||
<value>{0} minute</value>
|
||||
<comment>{0} shouldn't be removed. It will be replaced by the number 1 at runtime by the application. Used for defining a period to keep the PC awake.</comment>
|
||||
</data>
|
||||
<data name="AWAKE_MINUTES" xml:space="preserve">
|
||||
<value>{0} minutes</value>
|
||||
<comment>{0} shouldn't be removed. It will be replaced by a number greater than 1 at runtime by the application. Used for defining a period to keep the PC awake.</comment>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<XesUseOneStoreVersioning>true</XesUseOneStoreVersioning>
|
||||
<XesBaseYearForStoreVersion>2025</XesBaseYearForStoreVersion>
|
||||
<VersionMajor>0</VersionMajor>
|
||||
<VersionMinor>4</VersionMinor>
|
||||
<VersionMinor>5</VersionMinor>
|
||||
<VersionInfoProductName>Microsoft Command Palette</VersionInfoProductName>
|
||||
</PropertyGroup>
|
||||
</Project>
|
||||
|
||||
@@ -0,0 +1,130 @@
|
||||
// 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.Diagnostics;
|
||||
using System.Globalization;
|
||||
using System.Text;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using ManagedCommon;
|
||||
using Microsoft.CmdPal.Ext.Apps.Programs;
|
||||
using Microsoft.CmdPal.Ext.Apps.Properties;
|
||||
using Microsoft.CommandPalette.Extensions.Toolkit;
|
||||
using Windows.Management.Deployment;
|
||||
|
||||
namespace Microsoft.CmdPal.Ext.Apps.Commands;
|
||||
|
||||
internal sealed partial class UninstallApplicationCommand : InvokableCommand
|
||||
{
|
||||
// This is a ms-settings URI that opens the Apps & Features page in Windows Settings.
|
||||
// It's correct and follows the Microsoft documentation:
|
||||
// https://learn.microsoft.com/en-us/windows/apps/develop/launch/launch-settings-app#apps
|
||||
private const string AppsFeaturesUri = "ms-settings:appsfeatures";
|
||||
|
||||
private readonly UWPApplication? _uwpTarget;
|
||||
private readonly Win32Program? _win32Target;
|
||||
|
||||
public UninstallApplicationCommand(UWPApplication target)
|
||||
{
|
||||
Name = Resources.uninstall_application;
|
||||
Icon = Icons.UninstallApplicationIcon;
|
||||
_uwpTarget = target ?? throw new ArgumentNullException(nameof(target));
|
||||
}
|
||||
|
||||
public UninstallApplicationCommand(Win32Program target)
|
||||
{
|
||||
Name = Resources.uninstall_application;
|
||||
Icon = Icons.UninstallApplicationIcon;
|
||||
_win32Target = target ?? throw new ArgumentNullException(nameof(target));
|
||||
}
|
||||
|
||||
private async Task<CommandResult> UninstallUwpAppAsync(UWPApplication app)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(app.Package.FullName))
|
||||
{
|
||||
Logger.LogError($"Critical error while uninstalling: packageFullName cannot be null or empty.");
|
||||
return CommandResult.ShowToast(new ToastArgs()
|
||||
{
|
||||
Message = string.Format(CultureInfo.CurrentCulture, CompositeFormat.Parse(Resources.uninstall_application_failed), app.DisplayName),
|
||||
Result = CommandResult.KeepOpen(),
|
||||
});
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
// Which timeout to use for the uninstallation operation?
|
||||
using (var cts = new CancellationTokenSource(TimeSpan.FromSeconds(60)))
|
||||
{
|
||||
var packageManager = new PackageManager();
|
||||
var result = await packageManager.RemovePackageAsync(app.Package.FullName).AsTask(cts.Token);
|
||||
|
||||
if (result.ErrorText is not null && result.ErrorText.Length > 0)
|
||||
{
|
||||
Logger.LogError($"Failed to uninstall {app.Package.FullName}: {result.ErrorText}");
|
||||
return CommandResult.ShowToast(new ToastArgs()
|
||||
{
|
||||
Message = string.Format(CultureInfo.CurrentCulture, CompositeFormat.Parse(Resources.uninstall_application_failed), app.DisplayName),
|
||||
Result = CommandResult.KeepOpen(),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: Update the Search results after uninstalling the app - unsure how to do this yet.
|
||||
return CommandResult.ShowToast(new ToastArgs()
|
||||
{
|
||||
Message = string.Format(CultureInfo.CurrentCulture, CompositeFormat.Parse(Resources.uninstall_application_successful), app.DisplayName),
|
||||
Result = CommandResult.GoHome(),
|
||||
});
|
||||
}
|
||||
catch (OperationCanceledException)
|
||||
{
|
||||
Logger.LogError($"Timeout exceeded while uninstalling {app.Package.FullName}");
|
||||
return CommandResult.ShowToast(new ToastArgs()
|
||||
{
|
||||
Message = string.Format(CultureInfo.CurrentCulture, CompositeFormat.Parse(Resources.uninstall_application_failed), app.DisplayName),
|
||||
Result = CommandResult.KeepOpen(),
|
||||
});
|
||||
}
|
||||
catch (UnauthorizedAccessException ex)
|
||||
{
|
||||
Logger.LogError($"Permission denied to uninstall {app.Package.FullName}. Elevated privileges may be required. Error: {ex.Message}");
|
||||
return CommandResult.ShowToast(new ToastArgs()
|
||||
{
|
||||
Message = string.Format(CultureInfo.CurrentCulture, CompositeFormat.Parse(Resources.uninstall_application_failed), app.DisplayName),
|
||||
Result = CommandResult.KeepOpen(),
|
||||
});
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Logger.LogError($"An unexpected error occurred during uninstallation of {app.Package.FullName}: {ex.Message}");
|
||||
return CommandResult.ShowToast(new ToastArgs()
|
||||
{
|
||||
Message = string.Format(CultureInfo.CurrentCulture, CompositeFormat.Parse(Resources.uninstall_application_failed), app.DisplayName),
|
||||
Result = CommandResult.KeepOpen(),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
public override CommandResult Invoke()
|
||||
{
|
||||
if (_uwpTarget is not null)
|
||||
{
|
||||
return UninstallUwpAppAsync(_uwpTarget).ConfigureAwait(false).GetAwaiter().GetResult();
|
||||
}
|
||||
|
||||
if (_win32Target is not null)
|
||||
{
|
||||
Process.Start(new ProcessStartInfo
|
||||
{
|
||||
FileName = AppsFeaturesUri,
|
||||
UseShellExecute = true,
|
||||
});
|
||||
return CommandResult.Dismiss();
|
||||
}
|
||||
|
||||
Logger.LogError("UninstallApplicationCommand invoked with no target.");
|
||||
return CommandResult.Dismiss();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,66 @@
|
||||
// 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.Globalization;
|
||||
using System.Text;
|
||||
using ManagedCommon;
|
||||
using Microsoft.CmdPal.Ext.Apps.Programs;
|
||||
using Microsoft.CmdPal.Ext.Apps.Properties;
|
||||
using Microsoft.CommandPalette.Extensions.Toolkit;
|
||||
|
||||
namespace Microsoft.CmdPal.Ext.Apps.Commands;
|
||||
|
||||
internal sealed partial class UninstallApplicationConfirmation : InvokableCommand
|
||||
{
|
||||
private readonly UWPApplication? _uwpTarget;
|
||||
private readonly Win32Program? _win32Target;
|
||||
|
||||
public UninstallApplicationConfirmation(UWPApplication target)
|
||||
{
|
||||
Name = Resources.uninstall_application;
|
||||
Icon = Icons.UninstallApplicationIcon;
|
||||
_uwpTarget = target ?? throw new ArgumentNullException(nameof(target));
|
||||
}
|
||||
|
||||
public UninstallApplicationConfirmation(Win32Program target)
|
||||
{
|
||||
Name = Resources.uninstall_application;
|
||||
Icon = Icons.UninstallApplicationIcon;
|
||||
_win32Target = target ?? throw new ArgumentNullException(nameof(target));
|
||||
}
|
||||
|
||||
public override CommandResult Invoke()
|
||||
{
|
||||
UninstallApplicationCommand uninstallCommand;
|
||||
|
||||
var applicationTitle = Resources.uninstall_application;
|
||||
|
||||
if (_uwpTarget is not null)
|
||||
{
|
||||
uninstallCommand = new UninstallApplicationCommand(_uwpTarget);
|
||||
applicationTitle = _uwpTarget.DisplayName;
|
||||
}
|
||||
else if (_win32Target is not null)
|
||||
{
|
||||
uninstallCommand = new UninstallApplicationCommand(_win32Target);
|
||||
applicationTitle = _win32Target.Name;
|
||||
}
|
||||
else
|
||||
{
|
||||
Logger.LogError("UninstallApplicationCommand invoked with no target.");
|
||||
return CommandResult.Dismiss();
|
||||
}
|
||||
|
||||
var confirmArgs = new ConfirmationArgs()
|
||||
{
|
||||
Title = string.Format(CultureInfo.CurrentCulture, CompositeFormat.Parse(Resources.uninstall_application_confirm_title), applicationTitle),
|
||||
Description = Resources.uninstall_application_confirm_description,
|
||||
PrimaryCommand = uninstallCommand,
|
||||
IsPrimaryCommandCritical = true,
|
||||
};
|
||||
|
||||
return CommandResult.Confirm(confirmArgs);
|
||||
}
|
||||
}
|
||||
@@ -21,4 +21,6 @@ internal sealed class Icons
|
||||
public static IconInfo UnpinIcon { get; } = new("\uE77A"); // Unpin icon
|
||||
|
||||
public static IconInfo PinIcon { get; } = new("\uE840"); // Pin icon
|
||||
|
||||
public static IconInfo UninstallApplicationIcon { get; } = new("\uE74D"); // Uninstall icon
|
||||
}
|
||||
|
||||
@@ -117,6 +117,14 @@ public class UWPApplication : IUWPApplication
|
||||
RequestedShortcut = KeyChordHelpers.FromModifiers(ctrl: true, shift: true, vkey: VirtualKey.R),
|
||||
});
|
||||
|
||||
commands.Add(
|
||||
new CommandContextItem(
|
||||
new UninstallApplicationConfirmation(this))
|
||||
{
|
||||
RequestedShortcut = KeyChordHelpers.FromModifiers(ctrl: true, shift: true, vkey: VirtualKey.Delete),
|
||||
IsCritical = true,
|
||||
});
|
||||
|
||||
return commands;
|
||||
}
|
||||
|
||||
|
||||
@@ -219,6 +219,16 @@ public class Win32Program : IProgram
|
||||
RequestedShortcut = KeyChordHelpers.FromModifiers(ctrl: true, shift: true, vkey: VirtualKey.R),
|
||||
});
|
||||
|
||||
if (AppType == ApplicationType.ShortcutApplication || AppType == ApplicationType.ApprefApplication || AppType == ApplicationType.Win32Application)
|
||||
{
|
||||
commands.Add(new CommandContextItem(
|
||||
new UninstallApplicationConfirmation(this))
|
||||
{
|
||||
RequestedShortcut = KeyChordHelpers.FromModifiers(ctrl: true, shift: true, vkey: VirtualKey.Delete),
|
||||
IsCritical = true,
|
||||
});
|
||||
}
|
||||
|
||||
return commands;
|
||||
}
|
||||
|
||||
|
||||
@@ -330,6 +330,51 @@ namespace Microsoft.CmdPal.Ext.Apps.Properties {
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks up a localized string similar to Uninstall.
|
||||
/// </summary>
|
||||
internal static string uninstall_application {
|
||||
get {
|
||||
return ResourceManager.GetString("uninstall_application", resourceCulture);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks up a localized string similar to This app and its related information will be removed..
|
||||
/// </summary>
|
||||
internal static string uninstall_application_confirm_description {
|
||||
get {
|
||||
return ResourceManager.GetString("uninstall_application_confirm_description", resourceCulture);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks up a localized string similar to Uninstall "{0}"?.
|
||||
/// </summary>
|
||||
internal static string uninstall_application_confirm_title {
|
||||
get {
|
||||
return ResourceManager.GetString("uninstall_application_confirm_title", resourceCulture);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks up a localized string similar to Error while uninstalling '{0}'.
|
||||
/// </summary>
|
||||
internal static string uninstall_application_failed {
|
||||
get {
|
||||
return ResourceManager.GetString("uninstall_application_failed", resourceCulture);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks up a localized string similar to '{0}' has been successfully uninstalled..
|
||||
/// </summary>
|
||||
internal static string uninstall_application_successful {
|
||||
get {
|
||||
return ResourceManager.GetString("uninstall_application_successful", resourceCulture);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks up a localized string similar to Unpin.
|
||||
/// </summary>
|
||||
|
||||
@@ -198,6 +198,21 @@
|
||||
<data name="unpin_app" xml:space="preserve">
|
||||
<value>Unpin</value>
|
||||
</data>
|
||||
<data name="uninstall_application" xml:space="preserve">
|
||||
<value>Uninstall</value>
|
||||
</data>
|
||||
<data name="uninstall_application_successful" xml:space="preserve">
|
||||
<value>'{0}' has been successfully uninstalled.</value>
|
||||
</data>
|
||||
<data name="uninstall_application_failed" xml:space="preserve">
|
||||
<value>Error while uninstalling '{0}'</value>
|
||||
</data>
|
||||
<data name="uninstall_application_confirm_description" xml:space="preserve">
|
||||
<value>This app and its related information will be removed.</value>
|
||||
</data>
|
||||
<data name="uninstall_application_confirm_title" xml:space="preserve">
|
||||
<value>Uninstall "{0}"?</value>
|
||||
</data>
|
||||
<data name="limit_1" xml:space="preserve">
|
||||
<value>1</value>
|
||||
</data>
|
||||
|
||||
17
src/runner/runner.instructions.md
Normal file
17
src/runner/runner.instructions.md
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
applyTo: "**/*.cpp,**/*.c,**/*.h,**/*.hpp,**/*.rc"
|
||||
---
|
||||
# Runner – tray / host process guidance
|
||||
|
||||
Scope
|
||||
- Module bootstrap, hotkey management, settings bridge, update/elevation handling.
|
||||
|
||||
Guidelines
|
||||
- If IPC/JSON contracts change, mirror updates in `src/settings-ui/**`.
|
||||
- Keep module discovery in `src/runner/main.cpp` in sync when adding/removing modules.
|
||||
- Keep startup lean: avoid blocking/network calls in early init path.
|
||||
- Preserve GPO & elevation behaviors; confirm no regression in policy handling.
|
||||
- Ask before modifying update workflow or elevation logic.
|
||||
|
||||
Acceptance
|
||||
- Stable startup, consistent contracts, no unnecessary logging noise.
|
||||
@@ -269,7 +269,7 @@
|
||||
</controls:Card>
|
||||
<controls:Card
|
||||
x:Name="ModulesCard"
|
||||
Title="Modules"
|
||||
x:Uid="UtilitiesHeader"
|
||||
Grid.RowSpan="2"
|
||||
Grid.Column="1"
|
||||
MinWidth="400"
|
||||
|
||||
@@ -639,17 +639,17 @@ opera.exe</value>
|
||||
<value>Additional actions</value>
|
||||
</data>
|
||||
<data name="RemapKeysList.[using:Microsoft.UI.Xaml.Automation]AutomationProperties.Name" xml:space="preserve">
|
||||
<value>Current Key Remappings</value>
|
||||
<value>Current key remappings</value>
|
||||
</data>
|
||||
<data name="RemapShortcutsList.[using:Microsoft.UI.Xaml.Automation]AutomationProperties.Name" xml:space="preserve">
|
||||
<value>Current Shortcut Remappings</value>
|
||||
<value>Current shortcut remappings</value>
|
||||
</data>
|
||||
<data name="KeyboardManager_RemappedKeysListItem.[using:Microsoft.UI.Xaml.Automation]AutomationProperties.Name" xml:space="preserve">
|
||||
<value>Key Remapping</value>
|
||||
<value>Key remapping</value>
|
||||
<comment>key as in keyboard key</comment>
|
||||
</data>
|
||||
<data name="KeyboardManager_RemappedShortcutsListItem.[using:Microsoft.UI.Xaml.Automation]AutomationProperties.Name" xml:space="preserve">
|
||||
<value>Shortcut Remapping</value>
|
||||
<value>Shortcut remapping</value>
|
||||
</data>
|
||||
<data name="KeyboardManager_RemappedTo.[using:Microsoft.UI.Xaml.Automation]AutomationProperties.Name" xml:space="preserve">
|
||||
<value>Remapped to</value>
|
||||
@@ -658,7 +658,7 @@ opera.exe</value>
|
||||
<value>Remapped to</value>
|
||||
</data>
|
||||
<data name="KeyboardManager_TargetApp.[using:Microsoft.UI.Xaml.Automation]AutomationProperties.Name" xml:space="preserve">
|
||||
<value>For Target Application</value>
|
||||
<value>For target application</value>
|
||||
<comment>What computer application would this be for</comment>
|
||||
</data>
|
||||
<data name="KeyboardManager_Image.[using:Microsoft.UI.Xaml.Automation]AutomationProperties.Name" xml:space="preserve">
|
||||
@@ -4405,7 +4405,7 @@ Activate by holding the key for the character you want to add an accent to, then
|
||||
<value>Show minimap</value>
|
||||
</data>
|
||||
<data name="PrivacyLink.Text" xml:space="preserve">
|
||||
<value>OpenAI Privacy</value>
|
||||
<value>OpenAI privacy</value>
|
||||
</data>
|
||||
<data name="TermsLink.Text" xml:space="preserve">
|
||||
<value>OpenAI Terms</value>
|
||||
@@ -4626,7 +4626,7 @@ Activate by holding the key for the character you want to add an accent to, then
|
||||
Copy a zoomed screen with Ctrl+C or save it by typing Ctrl+S. Crop the copy or save region by entering Ctrl+Shift instead of Ctrl.</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Zoom_Shortcut.Header" xml:space="preserve">
|
||||
<value>Zoom Toggle Hotkey</value>
|
||||
<value>Zoom hotkey</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Toggle_AnimateZoom.Header" xml:space="preserve">
|
||||
<value>Animate zoom in and zoom out</value>
|
||||
@@ -4647,7 +4647,7 @@ Use LiveDraw to draw and annotate the live desktop. To activate LiveDraw, enter
|
||||
To enter and exit LiveZoom, enter the hotkey specified below.</value>
|
||||
</data>
|
||||
<data name="ZoomIt_LiveZoom_Shortcut.Header" xml:space="preserve">
|
||||
<value>Live Zoom Toggle Hotkey</value>
|
||||
<value>Live Zoom hotkey</value>
|
||||
</data>
|
||||
<data name="ZoomIt_DrawGroup.Header" xml:space="preserve">
|
||||
<value>Draw</value>
|
||||
@@ -4666,7 +4666,7 @@ Shapes - Draw a line by holding down the Shift key, a rectangle with the Ctrl ke
|
||||
Screen - Clear the screen for a sketch pad by pressing W (white) or K (black). Copy a zoomed screen with Ctrl+C or save it by typing Ctrl+S. Crop the copy or save region by entering Ctrl+Shift instead of Ctrl.</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Draw_Shortcut.Header" xml:space="preserve">
|
||||
<value>Draw without Zoom Hotkey</value>
|
||||
<value>Draw without zoom hotkey</value>
|
||||
</data>
|
||||
<data name="ZoomIt_TypeGroup.Header" xml:space="preserve">
|
||||
<value>Type</value>
|
||||
@@ -4680,11 +4680,11 @@ The text color is the current drawing color.</value>
|
||||
<value>Text font</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Type_Font_Button.Content" xml:space="preserve">
|
||||
<value>Choose Font</value>
|
||||
<value>Choose font</value>
|
||||
<comment>Font refers to text font</comment>
|
||||
</data>
|
||||
<data name="ZoomIt_DemoTypeGroup.Header" xml:space="preserve">
|
||||
<value>Demo Type</value>
|
||||
<value>DemoType</value>
|
||||
</data>
|
||||
<data name="ZoomIt_DemoTypeGroup.Description" xml:space="preserve">
|
||||
<value>Use DemoType to have ZoomIt type text specified in the input file when you enter the DemoType toggle. You can also pull input from the clipboard if it is prefixed with the [start] keyword.
|
||||
@@ -4698,7 +4698,7 @@ When driving input, hit the space bar to unblock keyboard input at the end of a
|
||||
When you reach the end of the file, ZoomIt will reload the file and start at the beginning. Enter the hotkey with the Shift key in the opposite mode to step back to the last [end].</value>
|
||||
</data>
|
||||
<data name="ZoomIt_DemoType_Shortcut.Header" xml:space="preserve">
|
||||
<value>Demo Type Toggle Hotkey</value>
|
||||
<value>DemoType toggle hotkey</value>
|
||||
</data>
|
||||
<data name="ZoomIt_DemoType_File.Header" xml:space="preserve">
|
||||
<value>Input file</value>
|
||||
@@ -4707,7 +4707,7 @@ When you reach the end of the file, ZoomIt will reload the file and start at the
|
||||
<value>Browse</value>
|
||||
</data>
|
||||
<data name="ZoomIt_DemoType_File_Picker_Dialog_Title" xml:space="preserve">
|
||||
<value>Specify DemoType file...</value>
|
||||
<value>Specify DemoType file..</value>
|
||||
</data>
|
||||
<data name="FilePicker_AllFilesFilter" xml:space="preserve">
|
||||
<value>All Files</value>
|
||||
@@ -4730,19 +4730,19 @@ When you reach the end of the file, ZoomIt will reload the file and start at the
|
||||
Change the break timer color using the same keys that the drawing color. The break timer font is the same as text font.</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_Shortcut.Header" xml:space="preserve">
|
||||
<value>Start Break Timer Hotkey</value>
|
||||
<value>Start break timer hotkey</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_Timeout.Header" xml:space="preserve">
|
||||
<value>Timer (minutes)</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_ShowExpiredTime.Header" xml:space="preserve">
|
||||
<value>Show Time Elapsed After Expiration</value>
|
||||
<value>Show time elapsed after expiration</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_PlaySoundsFile.Header" xml:space="preserve">
|
||||
<value>Play Sound on Expiration</value>
|
||||
<value>Play sound on expiration</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_SoundFile.Header" xml:space="preserve">
|
||||
<value>Alarm Sound File</value>
|
||||
<value>Alarm sound file</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_SoundFile_BrowseButton.Content" xml:space="preserve">
|
||||
<value>Browse</value>
|
||||
@@ -4754,7 +4754,7 @@ Change the break timer color using the same keys that the drawing color. The bre
|
||||
<value>Sounds</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_TimerOpacity.Header" xml:space="preserve">
|
||||
<value>Timer Opacity</value>
|
||||
<value>Timer opacity</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_TimerOpacity_10Percent.Content" xml:space="preserve">
|
||||
<value>10%</value>
|
||||
@@ -4787,7 +4787,7 @@ Change the break timer color using the same keys that the drawing color. The bre
|
||||
<value>100%</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_TimerPosition.Header" xml:space="preserve">
|
||||
<value>Timer Position</value>
|
||||
<value>Timer position</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_TimerPosition_TopLeftCorner.Content" xml:space="preserve">
|
||||
<value>Top left corner</value>
|
||||
@@ -4817,7 +4817,7 @@ Change the break timer color using the same keys that the drawing color. The bre
|
||||
<value>Bottom right corner</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_ShowBackgroundBitmap.Header" xml:space="preserve">
|
||||
<value>Show Background Bitmap</value>
|
||||
<value>Show background bitmap</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_ShowFadedDesktop.Content" xml:space="preserve">
|
||||
<value>Use faded desktop as background</value>
|
||||
@@ -4826,7 +4826,7 @@ Change the break timer color using the same keys that the drawing color. The bre
|
||||
<value>Use image file as background</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_BackgroundFile.Header" xml:space="preserve">
|
||||
<value>Background Image File</value>
|
||||
<value>Background image file</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Break_BackgroundFile_BrowseButton.Content" xml:space="preserve">
|
||||
<value>Browse</value>
|
||||
@@ -4847,14 +4847,14 @@ Change the break timer color using the same keys that the drawing color. The bre
|
||||
<value>Record</value>
|
||||
</data>
|
||||
<data name="ZoomIt_RecordGroup.Description" xml:space="preserve">
|
||||
<value>Record video of the unzoomed live screen or a static zoomed session by entering the recording hot key and finish the recording by entering it again.
|
||||
<value>Record video of the unzoomed live screen or a static zoomed session by entering the recording hotkey and finish the recording by entering it again.
|
||||
|
||||
To crop the portion of the screen that will be recorded, enter the hotkey with the Shift key in the opposite mode.
|
||||
|
||||
To record a specific window, enter the hotkey with the Alt key in the opposite mode.</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Record_Shortcut.Header" xml:space="preserve">
|
||||
<value>Record Toggle Hotkey</value>
|
||||
<value>Record hotkey</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Record_Scaling.Header" xml:space="preserve">
|
||||
<value>Scaling</value>
|
||||
@@ -4875,7 +4875,7 @@ To record a specific window, enter the hotkey with the Alt key in the opposite m
|
||||
<value>Copy a region of the screen to the clipboard or enter the hotkey with the Shift key in the opposite mode to save it to a file.</value>
|
||||
</data>
|
||||
<data name="ZoomIt_Snip_Shortcut.Header" xml:space="preserve">
|
||||
<value>Snip Toggle Hotkey</value>
|
||||
<value>Snip hotkey</value>
|
||||
</data>
|
||||
<data name="Oobe_ZoomIt.Description" xml:space="preserve">
|
||||
<value>ZoomIt is a screen zoom, annotation, and recording tool for technical presentations and demos. You can also use ZoomIt to snip screenshots to the clipboard or to a file.</value>
|
||||
@@ -4992,7 +4992,7 @@ To record a specific window, enter the hotkey with the Alt key in the opposite m
|
||||
<value>File Management</value>
|
||||
</data>
|
||||
<data name="Shell_TopLevelInputOutput.Content" xml:space="preserve">
|
||||
<value>Input / Output</value>
|
||||
<value>Input & Output</value>
|
||||
</data>
|
||||
<data name="Shell_TopLevelWindowsAndLayouts.Content" xml:space="preserve">
|
||||
<value>Windowing & Layouts</value>
|
||||
@@ -5145,7 +5145,7 @@ To record a specific window, enter the hotkey with the Alt key in the opposite m
|
||||
<value>Quick access</value>
|
||||
</data>
|
||||
<data name="ShortcutsOverview.Title" xml:space="preserve">
|
||||
<value>Shortcuts overview</value>
|
||||
<value>Shortcuts</value>
|
||||
</data>
|
||||
<data name="NoActionsToShow.Text" xml:space="preserve">
|
||||
<value>No actions to show..</value>
|
||||
@@ -5296,4 +5296,7 @@ To record a specific window, enter the hotkey with the Alt key in the opposite m
|
||||
<value>Results for</value>
|
||||
<comment>Prefix for search string. E.g. "Results for 'shortcut'"</comment>
|
||||
</data>
|
||||
<data name="UtilitiesHeader.Title" xml:space="preserve">
|
||||
<value>Utilities</value>
|
||||
</data>
|
||||
</root>
|
||||
17
src/settings-ui/settings-ui.instructions.md
Normal file
17
src/settings-ui/settings-ui.instructions.md
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
applyTo: "**/*.cs,**/*.xaml"
|
||||
---
|
||||
# Settings UI – configuration app guidance
|
||||
|
||||
Scope
|
||||
- WinUI/WPF UI, communicates with Runner over named pipes; manages persisted settings schema.
|
||||
|
||||
Guidelines
|
||||
- Don’t break settings schema silently; add migration when shape changes.
|
||||
- If IPC/JSON contracts change, align with `src/runner/**` implementation.
|
||||
- Keep UI responsive: marshal to UI thread for UI-bound operations.
|
||||
- Reuse existing styles/resources; avoid duplicate theme keys.
|
||||
- Add/adjust migration or serialization tests when changing persisted settings.
|
||||
|
||||
Acceptance
|
||||
- Schema integrity preserved, responsive UI, consistent contracts, no style duplication.
|
||||
48
tools/build/BUILD-GUIDELINES.md
Normal file
48
tools/build/BUILD-GUIDELINES.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# Build scripts – quick guideline
|
||||
|
||||
Use these scripts to build PowerToys locally. They auto-detect your platform (x64/arm64), initialize the Visual Studio developer environment, and write helpful logs on failure.
|
||||
|
||||
## Quick start (from cmd.exe)
|
||||
- Fast essentials (runner + settings) and NuGet restore first:
|
||||
- `tools\build\build-essentials.cmd`
|
||||
- Build projects in the current folder:
|
||||
- `tools\build\build.cmd`
|
||||
|
||||
Tip: Add `D:\PowerToys\tools\build` to your PATH to use the wrappers anywhere.
|
||||
|
||||
## When to use which
|
||||
1) `build-essentials.ps1`
|
||||
- Restores NuGet for `PowerToys.sln` and builds essentials (runner, settings).
|
||||
- Auto-detects Platform; initializes VS Dev environment automatically.
|
||||
- Example (PowerShell):
|
||||
- `./tools/build/build-essentials.ps1`
|
||||
- `./tools/build/build-essentials.ps1 -Platform arm64 -Configuration Release`
|
||||
|
||||
2) `build.ps1` (from any folder)
|
||||
- Builds any `.sln/.csproj/.vcxproj` in the current directory.
|
||||
- Auto-detects Platform; initializes VS Dev environment automatically.
|
||||
- Accepts extra MSBuild args (forwarded to msbuild):
|
||||
- `./tools/build/build.ps1 '/p:CIBuild=true' '/p:SomeProp=Value'`
|
||||
- Restore only:
|
||||
- `./tools/build/build.ps1 -RestoreOnly`
|
||||
|
||||
3) `build-installer.ps1` (use with caution)
|
||||
- Full local packaging pipeline (restore, build, sign MSIX, WiX v5 MSI/bootstrapper).
|
||||
- Auto-inits VS Dev environment. Cleans some output (keeps *.exe) under `installer/`.
|
||||
- Key options: `-PerUser true|false`, `-InstallerSuffix wix5|vnext`.
|
||||
- Example:
|
||||
- `./tools/build/build-installer.ps1 -Platform x64 -Configuration Release -PerUser true -InstallerSuffix wix5`
|
||||
|
||||
## Logs and troubleshooting
|
||||
- On failure, see logs next to the solution/project being built:
|
||||
- `build.<configuration>.<platform>.all.log` — full text log
|
||||
- `build.<configuration>.<platform>.errors.log` — errors only
|
||||
- `build.<configuration>.<platform>.warnings.log` — warnings only
|
||||
- `build.<configuration>.<platform>.trace.binlog` — open with MSBuild Structured Log Viewer
|
||||
- VS environment init:
|
||||
- Scripts try DevShell first (`Microsoft.VisualStudio.DevShell.dll` / `Enter-VsDevShell`), then fall back to `VsDevCmd.bat`.
|
||||
- If VS isn’t found, run from “Developer PowerShell for VS 2022”, or ensure `vswhere.exe` exists under `Program Files (x86)\Microsoft Visual Studio\Installer`.
|
||||
|
||||
## Notes
|
||||
- Override platform explicitly with `-Platform x64|arm64` if needed.
|
||||
- CMD wrappers: `build.cmd`, `build-essentials.cmd` forward all arguments to the PowerShell scripts.
|
||||
272
tools/build/build-common.ps1
Normal file
272
tools/build/build-common.ps1
Normal file
@@ -0,0 +1,272 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Shared build helper functions for PowerToys build scripts.
|
||||
|
||||
.DESCRIPTION
|
||||
This file provides reusable helper functions used by the build scripts:
|
||||
- Get-BuildPaths: returns ScriptDir, OriginalCwd, RepoRoot (repo root detection)
|
||||
- RunMSBuild: wrapper around msbuild.exe (accepts optional Platform/Configuration)
|
||||
- RestoreThenBuild: performs restore and optionally builds the solution/project
|
||||
- BuildProjectsInDirectory: discovers and builds local .sln/.csproj/.vcxproj files
|
||||
- Ensure-VsDevEnvironment: initializes the Visual Studio developer environment when possible.
|
||||
It prefers the DevShell PowerShell module (Microsoft.VisualStudio.DevShell.dll / Enter-VsDevShell),
|
||||
falls back to running VsDevCmd.bat and importing its environment into the current PowerShell session,
|
||||
and restores the caller's working directory after initialization.
|
||||
|
||||
USAGE
|
||||
Dot-source this file from a script to load helpers:
|
||||
. "$PSScriptRoot\build-common.ps1"
|
||||
|
||||
ERROR DETAILS
|
||||
When a build fails, check the logs written next to the solution/project folder:
|
||||
- build.<configuration>.<platform>.all.log — full MSBuild text log
|
||||
- build.<configuration>.<platform>.errors.log — extracted errors only
|
||||
- build.<configuration>.<platform>.warnings.log — extracted warnings only
|
||||
- build.<configuration>.<platform>.trace.binlog — binary log (open with the MSBuild Structured Log Viewer)
|
||||
|
||||
.NOTES
|
||||
Do not execute this file directly; dot-source it from `build.ps1` or `build-installer.ps1` so helpers are available in your script scope.
|
||||
#>
|
||||
|
||||
function RunMSBuild {
|
||||
param (
|
||||
[string]$Solution,
|
||||
[string]$ExtraArgs,
|
||||
[string]$Platform,
|
||||
[string]$Configuration
|
||||
)
|
||||
|
||||
# Prefer the solution's folder for logs; fall back to current directory
|
||||
$logRoot = Split-Path -Path $Solution
|
||||
if (-not $logRoot) { $logRoot = '.' }
|
||||
|
||||
$cfg = $null
|
||||
if ($Configuration) { $cfg = $Configuration.ToLower() } else { $cfg = 'unknown' }
|
||||
$plat = $null
|
||||
if ($Platform) { $plat = $Platform.ToLower() } else { $plat = 'unknown' }
|
||||
|
||||
$allLog = Join-Path $logRoot ("build.{0}.{1}.all.log" -f $cfg, $plat)
|
||||
$warningLog = Join-Path $logRoot ("build.{0}.{1}.warnings.log" -f $cfg, $plat)
|
||||
$errorsLog = Join-Path $logRoot ("build.{0}.{1}.errors.log" -f $cfg, $plat)
|
||||
$binLog = Join-Path $logRoot ("build.{0}.{1}.trace.binlog" -f $cfg, $plat)
|
||||
|
||||
$base = @(
|
||||
$Solution
|
||||
"/p:Platform=$Platform"
|
||||
"/p:Configuration=$Configuration"
|
||||
"/verbosity:normal"
|
||||
'/clp:Summary;PerformanceSummary;ErrorsOnly;WarningsOnly'
|
||||
"/fileLoggerParameters:LogFile=$allLog;Verbosity=detailed"
|
||||
"/fileLoggerParameters1:LogFile=$warningLog;WarningsOnly"
|
||||
"/fileLoggerParameters2:LogFile=$errorsLog;ErrorsOnly"
|
||||
"/bl:$binLog"
|
||||
'/nologo'
|
||||
)
|
||||
|
||||
$cmd = $base + ($ExtraArgs -split ' ')
|
||||
Write-Host (("[MSBUILD] {0}" -f ($cmd -join ' ')))
|
||||
|
||||
Push-Location $script:RepoRoot
|
||||
try {
|
||||
& msbuild.exe @cmd
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
Write-Error (("Build failed: {0} {1}`nSee logs:`n All: {2}`n Errors: {3}`n Binlog: {4}" -f $Solution, $ExtraArgs, $allLog, $errorsLog, $binLog))
|
||||
exit $LASTEXITCODE
|
||||
}
|
||||
} finally {
|
||||
Pop-Location
|
||||
}
|
||||
}
|
||||
|
||||
function RestoreThenBuild {
|
||||
param (
|
||||
[string]$Solution,
|
||||
[string]$ExtraArgs,
|
||||
[string]$Platform,
|
||||
[string]$Configuration,
|
||||
[bool]$RestoreOnly=$false
|
||||
)
|
||||
|
||||
$restoreArgs = '/t:restore /p:RestorePackagesConfig=true'
|
||||
if ($ExtraArgs) { $restoreArgs = "$restoreArgs $ExtraArgs" }
|
||||
RunMSBuild $Solution $restoreArgs $Platform $Configuration
|
||||
|
||||
if (-not $RestoreOnly) {
|
||||
$buildArgs = '/m'
|
||||
if ($ExtraArgs) { $buildArgs = "$buildArgs $ExtraArgs" }
|
||||
RunMSBuild $Solution $buildArgs $Platform $Configuration
|
||||
}
|
||||
}
|
||||
|
||||
function BuildProjectsInDirectory {
|
||||
param(
|
||||
[string]$DirectoryPath,
|
||||
[string]$ExtraArgs,
|
||||
[string]$Platform,
|
||||
[string]$Configuration,
|
||||
[switch]$RestoreOnly
|
||||
)
|
||||
|
||||
if (-not (Test-Path $DirectoryPath)) {
|
||||
return $false
|
||||
}
|
||||
|
||||
$files = @()
|
||||
try {
|
||||
$files = Get-ChildItem -Path (Join-Path $DirectoryPath '*') -Include *.sln,*.csproj,*.vcxproj -File -ErrorAction SilentlyContinue
|
||||
} catch {
|
||||
$files = @()
|
||||
}
|
||||
|
||||
if (-not $files -or $files.Count -eq 0) {
|
||||
return $false
|
||||
}
|
||||
|
||||
$names = ($files | ForEach-Object { $_.Name }) -join ', '
|
||||
Write-Host ("[LOCAL BUILD] Found {0} project(s) in {1}: {2}" -f $files.Count, $DirectoryPath, $names)
|
||||
|
||||
$preferredOrder = @('.sln', '.csproj', '.vcxproj')
|
||||
$files = $files | Sort-Object @{Expression = { [array]::IndexOf($preferredOrder, $_.Extension.ToLower()) }}
|
||||
|
||||
foreach ($f in $files) {
|
||||
Write-Host ("[LOCAL BUILD] Building {0}" -f $f.FullName)
|
||||
if ($f.Extension -eq '.sln') {
|
||||
RestoreThenBuild $f.FullName $ExtraArgs $Platform $Configuration $RestoreOnly
|
||||
} else {
|
||||
$buildArgs = '/m'
|
||||
if ($ExtraArgs) { $buildArgs = "$buildArgs $ExtraArgs" }
|
||||
RunMSBuild $f.FullName $buildArgs $Platform $Configuration
|
||||
}
|
||||
}
|
||||
|
||||
return $true
|
||||
}
|
||||
|
||||
function Get-DefaultPlatform {
|
||||
<#
|
||||
Returns a default target platform string based on the host machine (x64, arm64, x86).
|
||||
#>
|
||||
try {
|
||||
$envArch = $env:PROCESSOR_ARCHITECTURE
|
||||
if ($envArch) { $envArch = $envArch.ToLower() }
|
||||
if ($envArch -eq 'amd64' -or $envArch -eq 'x86_64') { return 'x64' }
|
||||
if ($envArch -match 'arm64') { return 'arm64' }
|
||||
if ($envArch -eq 'x86') { return 'x86' }
|
||||
|
||||
if ($env:PROCESSOR_ARCHITEW6432) {
|
||||
$envArch2 = $env:PROCESSOR_ARCHITEW6432.ToLower()
|
||||
if ($envArch2 -eq 'amd64') { return 'x64' }
|
||||
if ($envArch2 -match 'arm64') { return 'arm64' }
|
||||
}
|
||||
|
||||
try {
|
||||
$osArch = [System.Runtime.InteropServices.RuntimeInformation]::OSArchitecture
|
||||
switch ($osArch.ToString().ToLower()) {
|
||||
'x64' { return 'x64' }
|
||||
'arm64' { return 'arm64' }
|
||||
'x86' { return 'x86' }
|
||||
}
|
||||
} catch {
|
||||
# ignore - RuntimeInformation may not be available
|
||||
}
|
||||
} catch {
|
||||
# ignore any errors and fall back
|
||||
}
|
||||
|
||||
return 'x64'
|
||||
}
|
||||
|
||||
function Ensure-VsDevEnvironment {
|
||||
$OriginalLocationForVsInit = Get-Location
|
||||
try {
|
||||
|
||||
if ($env:VSINSTALLDIR -or $env:VCINSTALLDIR -or $env:DevEnvDir -or $env:VCToolsInstallDir) {
|
||||
Write-Host "[VS] VS developer environment already present"
|
||||
return $true
|
||||
}
|
||||
|
||||
# Locate vswhere if available
|
||||
$vswhereCandidates = @(
|
||||
"$env:ProgramFiles (x86)\Microsoft Visual Studio\Installer\vswhere.exe",
|
||||
"$env:ProgramFiles\Microsoft Visual Studio\Installer\vswhere.exe"
|
||||
)
|
||||
$vswhere = $vswhereCandidates | Where-Object { Test-Path $_ } | Select-Object -First 1
|
||||
if ($vswhere) { Write-Host "[VS] vswhere found: $vswhere" } else { Write-Host "[VS] vswhere not found" }
|
||||
|
||||
$instPaths = @()
|
||||
if ($vswhere) {
|
||||
# First try with the VC tools requirement (preferred)
|
||||
try { $p = & $vswhere -latest -products * -requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64 -property installationPath 2>$null; if ($p) { $instPaths += $p } } catch {}
|
||||
# Fallback: try without -requires to find any VS installations
|
||||
if (-not $instPaths) {
|
||||
try { $p2 = & $vswhere -latest -products * -property installationPath 2>$null; if ($p2) { $instPaths += $p2 } } catch {}
|
||||
}
|
||||
}
|
||||
|
||||
# Add explicit common year-based candidates as a last resort
|
||||
if (-not $instPaths) {
|
||||
$explicit = @(
|
||||
"$env:ProgramFiles (x86)\Microsoft Visual Studio\2022\Community",
|
||||
"$env:ProgramFiles (x86)\Microsoft Visual Studio\2022\Professional",
|
||||
"$env:ProgramFiles (x86)\Microsoft Visual Studio\2022\Enterprise",
|
||||
"$env:ProgramFiles\Microsoft Visual Studio\2022\Community",
|
||||
"$env:ProgramFiles\Microsoft Visual Studio\2022\Professional",
|
||||
"$env:ProgramFiles\Microsoft Visual Studio\2022\Enterprise"
|
||||
)
|
||||
foreach ($c in $explicit) { if (Test-Path $c) { $instPaths += $c } }
|
||||
}
|
||||
|
||||
if (-not $instPaths -or $instPaths.Count -eq 0) {
|
||||
Write-Warning "[VS] Could not locate Visual Studio installation (no candidates found)"
|
||||
return $false
|
||||
}
|
||||
|
||||
# Try each candidate installation path until one works
|
||||
foreach ($inst in $instPaths) {
|
||||
if (-not $inst) { continue }
|
||||
Write-Host "[VS] Checking candidate: $inst"
|
||||
|
||||
$devDll = Join-Path $inst 'Common7\Tools\Microsoft.VisualStudio.DevShell.dll'
|
||||
if (Test-Path $devDll) {
|
||||
try {
|
||||
Import-Module $devDll -DisableNameChecking -ErrorAction Stop
|
||||
|
||||
# Call Enter-VsDevShell using only the install path to avoid parameter name differences
|
||||
try {
|
||||
Enter-VsDevShell -VsInstallPath $inst -ErrorAction Stop
|
||||
Write-Host "[VS] Entered Visual Studio DevShell at $inst"
|
||||
return $true
|
||||
} catch {
|
||||
Write-Warning ("[VS] DevShell import/Enter-VsDevShell failed: {0}" -f $_)
|
||||
}
|
||||
} catch {
|
||||
Write-Warning ("[VS] DevShell import failed: {0}" -f $_)
|
||||
}
|
||||
}
|
||||
|
||||
$vsDevCmd = Join-Path $inst 'Common7\Tools\VsDevCmd.bat'
|
||||
if (Test-Path $vsDevCmd) {
|
||||
Write-Host "[VS] Running VsDevCmd.bat and importing environment from $vsDevCmd"
|
||||
try {
|
||||
$cmdOut = cmd.exe /c "`"$vsDevCmd`" && set"
|
||||
foreach ($line in $cmdOut) {
|
||||
$parts = $line -split('=',2)
|
||||
if ($parts.Length -eq 2) {
|
||||
try { [Environment]::SetEnvironmentVariable($parts[0], $parts[1], 'Process') } catch {}
|
||||
}
|
||||
}
|
||||
Write-Host "[VS] Imported environment from VsDevCmd.bat at $inst"
|
||||
return $true
|
||||
} catch {
|
||||
Write-Warning ("[VS] Failed to run/import VsDevCmd.bat at {0}: {1}" -f $inst, $_)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Write-Warning "[VS] Neither DevShell module nor VsDevCmd.bat found in any candidate paths"
|
||||
return $false
|
||||
|
||||
} finally {
|
||||
try { Set-Location $OriginalLocationForVsInit } catch {}
|
||||
}
|
||||
}
|
||||
5
tools/build/build-essentials.cmd
Normal file
5
tools/build/build-essentials.cmd
Normal file
@@ -0,0 +1,5 @@
|
||||
@echo off
|
||||
REM Wrapper to run build-essentials.ps1 from cmd.exe
|
||||
set SCRIPT_DIR=%~dp0
|
||||
powershell.exe -NoProfile -ExecutionPolicy Bypass -File "%SCRIPT_DIR%build-essentials.ps1" %*
|
||||
exit /b %ERRORLEVEL%
|
||||
@@ -1,16 +1,74 @@
|
||||
cd $PSScriptRoot
|
||||
cd ..\..
|
||||
$cwd = Get-Location
|
||||
$SolutionDir = $cwd,"" -join "\"
|
||||
cd $SolutionDir
|
||||
$BuildArgs = "/p:Configuration=Release /p:Platform=x64 /p:BuildProjectReferences=false /p:SolutionDir=$SolutionDir"
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Build essential native PowerToys projects (runner and settings), restoring NuGet packages first.
|
||||
|
||||
$ProjectsToBuild =
|
||||
".\src\runner\runner.vcxproj",
|
||||
".\src\modules\shortcut_guide\shortcut_guide.vcxproj",
|
||||
".\src\modules\fancyzones\lib\FancyZonesLib.vcxproj",
|
||||
".\src\modules\fancyzones\dll\FancyZonesModule.vcxproj"
|
||||
.DESCRIPTION
|
||||
Lightweight script to build a small set of essential C++ projects used by PowerToys' runner and native modules. This script first restores NuGet packages for the full solution (`PowerToys.sln`) and then builds the runner and settings projects. Intended for fast local builds during development.
|
||||
|
||||
$ProjectsToBuild | % {
|
||||
Invoke-Expression "msbuild $_ $BuildArgs"
|
||||
.PARAMETER Platform
|
||||
Target platform for the build (for example: 'x64', 'arm64'). If omitted the script will attempt to auto-detect the host platform.
|
||||
|
||||
.PARAMETER Configuration
|
||||
Build configuration (for example: 'Debug' or 'Release'). Default is 'Debug'.
|
||||
|
||||
.EXAMPLE
|
||||
.\tools\build\build-essentials.ps1
|
||||
Restores packages for the solution and builds the default set of native projects using the auto-detected platform and Debug configuration.
|
||||
|
||||
.EXAMPLE
|
||||
.\tools\build\build-essentials.ps1 -Platform arm64 -Configuration Release
|
||||
Restores packages and builds the essentials in Release mode for ARM64, even if your machine is running on x64.
|
||||
|
||||
.NOTES
|
||||
- This script dot-sources `build-common.ps1` and uses the shared helper `RunMSBuild`.
|
||||
- It will call `RestoreThenBuild 'PowerToys.sln'` before building the essential projects to ensure NuGet packages are restored.
|
||||
- The script attempts to locate the repository root automatically and can be run from any folder inside the repo.
|
||||
#>
|
||||
|
||||
param (
|
||||
[string]$Platform = '',
|
||||
[string]$Configuration = 'Debug'
|
||||
)
|
||||
|
||||
# Find repository root starting from the script location
|
||||
$ScriptDir = Split-Path -Parent $MyInvocation.MyCommand.Definition
|
||||
$repoRoot = $ScriptDir
|
||||
while ($repoRoot -and -not (Test-Path (Join-Path $repoRoot "PowerToys.sln"))) {
|
||||
$parent = Split-Path -Parent $repoRoot
|
||||
if ($parent -eq $repoRoot) {
|
||||
Write-Error "Could not find PowerToys repository root."
|
||||
exit 1
|
||||
}
|
||||
$repoRoot = $parent
|
||||
}
|
||||
|
||||
# Export script-scope variables used by build-common helpers
|
||||
Set-Variable -Name RepoRoot -Value $repoRoot -Scope Script -Force
|
||||
|
||||
# Load shared helpers
|
||||
. "$PSScriptRoot\build-common.ps1"
|
||||
|
||||
# Initialize Visual Studio dev environment
|
||||
if (-not (Ensure-VsDevEnvironment)) { exit 1 }
|
||||
|
||||
# If platform not provided, auto-detect from host
|
||||
if (-not $Platform -or $Platform -eq '') {
|
||||
try {
|
||||
$Platform = Get-DefaultPlatform
|
||||
Write-Host ("[AUTO-PLATFORM] Detected platform: {0}" -f $Platform)
|
||||
} catch {
|
||||
Write-Warning "Failed to auto-detect platform; defaulting to 'x64'"
|
||||
$Platform = 'x64'
|
||||
}
|
||||
}
|
||||
|
||||
# Ensure solution packages are restored
|
||||
RestoreThenBuild 'PowerToys.sln' '' $Platform $Configuration $true
|
||||
|
||||
# Build both runner and settings
|
||||
$ProjectsToBuild = @(".\src\runner\runner.vcxproj", ".\src\settings-ui\Settings.UI\PowerToys.Settings.csproj")
|
||||
$ExtraArgs = "/p:SolutionDir=$repoRoot\"
|
||||
foreach ($proj in $ProjectsToBuild) {
|
||||
Write-Host ("[BUILD-ESSENTIALS] Building {0}" -f $proj)
|
||||
RunMSBuild $proj $ExtraArgs $Platform $Configuration
|
||||
}
|
||||
@@ -52,12 +52,29 @@ Runs the pipeline for x64 Release with 'vnext' suffix.
|
||||
#>
|
||||
|
||||
param (
|
||||
[string]$Platform = 'x64',
|
||||
[string]$Platform = '',
|
||||
[string]$Configuration = 'Release',
|
||||
[string]$PerUser = 'true',
|
||||
[string]$InstallerSuffix = 'wix5'
|
||||
)
|
||||
|
||||
# Ensure helpers are available
|
||||
. "$PSScriptRoot\build-common.ps1"
|
||||
|
||||
# Initialize Visual Studio dev environment
|
||||
if (-not (Ensure-VsDevEnvironment)) { exit 1 }
|
||||
|
||||
# Auto-detect platform when not provided
|
||||
if (-not $Platform -or $Platform -eq '') {
|
||||
try {
|
||||
$Platform = Get-DefaultPlatform
|
||||
Write-Host ("[AUTO-PLATFORM] Detected platform: {0}" -f $Platform)
|
||||
} catch {
|
||||
Write-Warning "Failed to auto-detect platform; defaulting to x64"
|
||||
$Platform = 'x64'
|
||||
}
|
||||
}
|
||||
|
||||
# Find the PowerToys repository root automatically
|
||||
$scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Definition
|
||||
$repoRoot = $scriptDir
|
||||
@@ -80,50 +97,7 @@ if (-not $repoRoot -or -not (Test-Path (Join-Path $repoRoot "PowerToys.sln"))) {
|
||||
}
|
||||
|
||||
Write-Host "PowerToys repository root detected: $repoRoot"
|
||||
|
||||
function RunMSBuild {
|
||||
param (
|
||||
[string]$Solution,
|
||||
[string]$ExtraArgs
|
||||
)
|
||||
|
||||
$base = @(
|
||||
$Solution
|
||||
"/p:Platform=$Platform"
|
||||
"/p:Configuration=$Configuration"
|
||||
"/p:CIBuild=true"
|
||||
'/verbosity:normal'
|
||||
'/clp:Summary;PerformanceSummary;ErrorsOnly;WarningsOnly'
|
||||
'/nologo'
|
||||
)
|
||||
|
||||
$cmd = $base + ($ExtraArgs -split ' ')
|
||||
Write-Host ("[MSBUILD] {0} {1}" -f $Solution, ($cmd -join ' '))
|
||||
|
||||
# Run MSBuild from the repository root directory
|
||||
Push-Location $repoRoot
|
||||
try {
|
||||
& msbuild.exe @cmd
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
Write-Error ("Build failed: {0} {1}" -f $Solution, $ExtraArgs)
|
||||
exit $LASTEXITCODE
|
||||
}
|
||||
} finally {
|
||||
Pop-Location
|
||||
}
|
||||
}
|
||||
|
||||
function RestoreThenBuild {
|
||||
param ([string]$Solution)
|
||||
|
||||
# 1) restore
|
||||
RunMSBuild $Solution '/t:restore /p:RestorePackagesConfig=true'
|
||||
# 2) build -------------------------------------------------
|
||||
RunMSBuild $Solution '/m'
|
||||
}
|
||||
|
||||
# WiX v5 projects use WixToolset.Sdk via NuGet/MSBuild; a separate WiX 3 installation is not required here.
|
||||
|
||||
Write-Host ("[PIPELINE] Start | Platform={0} Configuration={1} PerUser={2}" -f $Platform, $Configuration, $PerUser)
|
||||
Write-Host ''
|
||||
|
||||
@@ -134,7 +108,9 @@ if (Test-Path $cmdpalOutputPath) {
|
||||
Remove-Item $cmdpalOutputPath -Recurse -Force -ErrorAction Ignore
|
||||
}
|
||||
|
||||
RestoreThenBuild 'PowerToys.sln'
|
||||
$commonArgs = '/p:CIBuild=true'
|
||||
# No local projects found (or continuing) - build full solution and tools
|
||||
RestoreThenBuild 'PowerToys.sln' $commonArgs $Platform $Configuration
|
||||
|
||||
$msixSearchRoot = Join-Path $repoRoot "$Platform\$Configuration"
|
||||
$msixFiles = Get-ChildItem -Path $msixSearchRoot -Recurse -Filter *.msix |
|
||||
@@ -148,8 +124,8 @@ else {
|
||||
Write-Warning "[SIGN] No .msix files found in $msixSearchRoot"
|
||||
}
|
||||
|
||||
RestoreThenBuild 'tools\BugReportTool\BugReportTool.sln'
|
||||
RestoreThenBuild 'tools\StylesReportTool\StylesReportTool.sln'
|
||||
RestoreThenBuild 'tools\BugReportTool\BugReportTool.sln' $commonArgs $Platform $Configuration
|
||||
RestoreThenBuild 'tools\StylesReportTool\StylesReportTool.sln' $commonArgs $Platform $Configuration
|
||||
|
||||
Write-Host '[CLEAN] installer (keep *.exe)'
|
||||
Push-Location $repoRoot
|
||||
@@ -159,10 +135,10 @@ try {
|
||||
Pop-Location
|
||||
}
|
||||
|
||||
RunMSBuild 'installer\PowerToysSetup.sln' '/t:restore /p:RestorePackagesConfig=true'
|
||||
RunMSBuild 'installer\PowerToysSetup.sln' "$commonArgs /t:restore /p:RestorePackagesConfig=true" $Platform $Configuration
|
||||
|
||||
RunMSBuild 'installer\PowerToysSetup.sln' "/m /t:PowerToysInstallerVNext /p:PerUser=$PerUser /p:InstallerSuffix=$InstallerSuffix"
|
||||
RunMSBuild 'installer\PowerToysSetup.sln' "$commonArgs /m /t:PowerToysInstallerVNext /p:PerUser=$PerUser /p:InstallerSuffix=$InstallerSuffix" $Platform $Configuration
|
||||
|
||||
RunMSBuild 'installer\PowerToysSetup.sln' "/m /t:PowerToysBootstrapperVNext /p:PerUser=$PerUser /p:InstallerSuffix=$InstallerSuffix"
|
||||
RunMSBuild 'installer\PowerToysSetup.sln' "$commonArgs /m /t:PowerToysBootstrapperVNext /p:PerUser=$PerUser /p:InstallerSuffix=$InstallerSuffix" $Platform $Configuration
|
||||
|
||||
Write-Host '[PIPELINE] Completed'
|
||||
|
||||
5
tools/build/build.cmd
Normal file
5
tools/build/build.cmd
Normal file
@@ -0,0 +1,5 @@
|
||||
@echo off
|
||||
REM Wrapper to run the PowerShell build script from cmd.exe
|
||||
set SCRIPT_DIR=%~dp0
|
||||
powershell.exe -NoProfile -ExecutionPolicy Bypass -File "%SCRIPT_DIR%build.ps1" %*
|
||||
exit /b %ERRORLEVEL%
|
||||
92
tools/build/build.ps1
Normal file
92
tools/build/build.ps1
Normal file
@@ -0,0 +1,92 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Light-weight wrapper to build local projects (solutions/projects) in the current working directory using helpers in build-common.ps1.
|
||||
|
||||
.DESCRIPTION
|
||||
This script is intended for quick local builds. It dot-sources `build-common.ps1` and calls `BuildProjectsInDirectory` against the current directory. Use `-RestoreOnly` to only restore packages for local projects. If `-Platform` is omitted the script attempts to auto-detect the host platform.
|
||||
|
||||
.PARAMETER Platform
|
||||
Target platform (e.g., 'x64', 'arm64'). If omitted the script will try to detect the host platform automatically.
|
||||
|
||||
.PARAMETER Configuration
|
||||
Build configuration (e.g., 'Debug', 'Release'). Default: 'Debug'.
|
||||
|
||||
.PARAMETER RestoreOnly
|
||||
If specified, only perform package restore for local projects and skip the build steps for a solution file (i.e. .sln).
|
||||
|
||||
.PARAMETER ExtraArgs
|
||||
Any remaining, positional arguments passed to the script are forwarded to MSBuild as additional arguments (e.g., '/p:CIBuild=true').
|
||||
|
||||
.EXAMPLE
|
||||
.\tools\build\build.ps1
|
||||
Builds any .sln/.csproj/.vcxproj in the current working directory (auto-detects Platform).
|
||||
|
||||
.EXAMPLE
|
||||
.\tools\build\build.ps1 -Platform x64 -Configuration Release
|
||||
Builds local projects for x64 Release.
|
||||
|
||||
.EXAMPLE
|
||||
.\tools\build\build.ps1 '/p:CIBuild=true' '/p:SomeOther=Value'
|
||||
Pass additional MSBuild arguments; these are forwarded to the underlying msbuild calls.
|
||||
|
||||
.EXAMPLE
|
||||
.\tools\build\build.ps1 -RestoreOnly '/p:CIBuild=true'
|
||||
Only restores packages for local projects; ExtraArgs still forwarded to msbuild's restore phase.
|
||||
|
||||
.NOTES
|
||||
- This file expects `build-common.ps1` to be located in the same folder and dot-sources it to load helper functions.
|
||||
- ExtraArgs are captured using PowerShell's ValueFromRemainingArguments and joined before being passed to the helpers.
|
||||
#>
|
||||
|
||||
param (
|
||||
[string]$Platform = '',
|
||||
[string]$Configuration = 'Debug',
|
||||
[switch]$RestoreOnly,
|
||||
[Parameter(ValueFromRemainingArguments=$true)]
|
||||
[string[]]$ExtraArgs
|
||||
)
|
||||
|
||||
. "$PSScriptRoot\build-common.ps1"
|
||||
|
||||
# Initialize Visual Studio dev environment
|
||||
if (-not (Ensure-VsDevEnvironment)) { exit 1 }
|
||||
|
||||
# If user passed MSBuild-style args (e.g. './build.ps1 /p:CIBuild=true'),
|
||||
# those will bind to $Platform/$Configuration; detect those and move them to ExtraArgs.
|
||||
$positionalExtra = @()
|
||||
if ($Platform -and $Platform -match '^[\/-]') {
|
||||
$positionalExtra += $Platform
|
||||
$Platform = ''
|
||||
}
|
||||
if ($Configuration -and $Configuration -match '^[\/-]') {
|
||||
$positionalExtra += $Configuration
|
||||
$Configuration = 'Debug'
|
||||
}
|
||||
if ($positionalExtra.Count -gt 0) {
|
||||
if (-not $ExtraArgs) { $ExtraArgs = @() }
|
||||
$ExtraArgs = $positionalExtra + $ExtraArgs
|
||||
}
|
||||
|
||||
# Auto-detect platform when not provided
|
||||
if (-not $Platform -or $Platform -eq '') {
|
||||
try {
|
||||
$Platform = Get-DefaultPlatform
|
||||
Write-Host ("[AUTO-PLATFORM] Detected platform: {0}" -f $Platform)
|
||||
} catch {
|
||||
Write-Warning "Failed to auto-detect platform; defaulting to x64"
|
||||
$Platform = 'x64'
|
||||
}
|
||||
}
|
||||
|
||||
$cwd = (Get-Location).ProviderPath
|
||||
$extraArgsString = $null
|
||||
if ($ExtraArgs -and $ExtraArgs.Count -gt 0) { $extraArgsString = ($ExtraArgs -join ' ') }
|
||||
|
||||
$built = BuildProjectsInDirectory -DirectoryPath $cwd -ExtraArgs $extraArgsString -Platform $Platform -Configuration $Configuration -RestoreOnly:$RestoreOnly
|
||||
if ($built) {
|
||||
Write-Host "[BUILD] Local projects built; exiting."
|
||||
exit 0
|
||||
} else {
|
||||
Write-Host "[BUILD] No local projects found in $cwd"
|
||||
exit 0
|
||||
}
|
||||
Reference in New Issue
Block a user