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

Added supported modules

Browse Source
This commit is contained in:
AmirMS
2025-08-07 22:44:13 -07:00
parent fdd0ecc81d
commit 3bf8f414c8
8 changed files with 135 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/dsc/v3/PowerToys.DSC/Commands/BaseCommand.cs
View File

@@ -5,7 +5,7 @@
using System;
using System.CommandLine;
using System.CommandLine.Invocation;
using ManagedCommon;
using System.CommandLine.IO;
using PowerToys.DSC.Options;
using PowerToys.DSC.Resources;
@@ -17,12 +17,12 @@ internal abstract class BaseCommand : Command
private readonly ResourceOption _resourceOption;
private readonly InputOption _inputOption;
protected ModuleType Module { get; private set; }
protected BaseResource? Resource { get; private set; }
protected string? Input { get; private set; }
private string? Module { get; set; }
public BaseCommand(string name, string description)
: base(name, description)
{
@@ -40,17 +40,24 @@ internal abstract class BaseCommand : Command
public void CommandHandler(InvocationContext context)
{
var moduleName = context.ParseResult.GetValueForOption(_moduleOption);
var resourceName = context.ParseResult.GetValueForOption(_resourceOption);
Input = context.ParseResult.GetValueForOption(_inputOption);
Module = Enum.Parse<ModuleType>(moduleName!, ignoreCase: true);
Module = context.ParseResult.GetValueForOption(_moduleOption);
Resource = resourceName switch
{
SettingsResource.ResourceName => new SettingsResource(Module),
_ => throw new ArgumentException($"Unknown resource name: {resourceName}"),
};
var supportedModules = Resource.GetSupportedModules();
if (!string.IsNullOrEmpty(Module) && !supportedModules.Contains(Module))
{
context.Console.Error.WriteLine($"Module '{Module}' is not supported for the resource {resourceName}. Supported modules are: {string.Join(", ", supportedModules)}");
context.ExitCode = 1;
return;
}
CommandHandlerInternal(context);
}

1
src/dsc/v3/PowerToys.DSC/Commands/ManifestCommand.cs
View File

@@ -15,6 +15,7 @@ internal sealed class ManifestCommand : BaseCommand
: base("manifest", "Get the manifest of the dsc resource")
{
_outputDirectoryOption = new OutputDirectoryOption();
AddOption(_outputDirectoryOption);
}
public override void CommandHandlerInternal(InvocationContext context)

25
src/dsc/v3/PowerToys.DSC/Commands/ModulesCommand.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;
using System.CommandLine.Invocation;
namespace PowerToys.DSC.Commands;
internal sealed class ModulesCommand : BaseCommand
{
public ModulesCommand()
: base("modules", "Get all supported modules")
{
}
public override void CommandHandlerInternal(InvocationContext context)
{
// Print the supported modules for the specified resource
foreach (var module in Resource!.GetSupportedModules())
{
Console.WriteLine(module);
}
}
}

4
src/dsc/v3/PowerToys.DSC/Options/InputOption.cs
View File

@@ -8,7 +8,7 @@ using System.Text.Json;
namespace PowerToys.DSC.Options;
internal sealed class InputOption : Option<string>
internal sealed class InputOption : Option<string?>
{
public InputOption()
: base("--input", "The JSON input")
@@ -18,7 +18,7 @@ internal sealed class InputOption : Option<string>
private void OptionValidator(OptionResult result)
{
var value = result.GetValueOrDefault<string>() ?? string.Empty;
var value = result.GetValueOrDefault<string?>() ?? string.Empty;
try
{

16
src/dsc/v3/PowerToys.DSC/Options/ModuleOption.cs
View File

@@ -2,28 +2,14 @@
// 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 ManagedCommon;
namespace PowerToys.DSC.Options;
internal sealed class ModuleOption : Option<string>
internal sealed class ModuleOption : Option<string?>
{
public ModuleOption()
: base("--module", "The module name")
{
IsRequired = true;
AddValidator(OptionValidator);
}
private void OptionValidator(OptionResult result)
{
var value = result.GetValueOrDefault<string>() ?? string.Empty;
if (!Enum.TryParse<ModuleType>(value, ignoreCase: true, out _))
{
result.ErrorMessage = $"Invalid module name. Valid values are: {string.Join(", ", Enum.GetValues<ModuleType>())}";
}
}
}

1
src/dsc/v3/PowerToys.DSC/Program.cs
View File

@@ -25,6 +25,7 @@ public class Program
rootCommand.AddCommand(new TestCommand());
rootCommand.AddCommand(new SchemaCommand());
rootCommand.AddCommand(new ManifestCommand());
rootCommand.AddCommand(new ModulesCommand());
return await rootCommand.InvokeAsync(args);
}
}

7
src/dsc/v3/PowerToys.DSC/Resources/BaseResource.cs
View File

@@ -5,7 +5,6 @@
using System;
using System.Collections.Generic;
using System.Text.Json.Serialization;
using ManagedCommon;
using Newtonsoft.Json;
using NJsonSchema.Generation;
using PowerToys.DSC.Models;
@@ -14,9 +13,9 @@ namespace PowerToys.DSC.Resources;
internal abstract class BaseResource
{
public ModuleType Module { get; }
public string? Module { get; }
public BaseResource(ModuleType module)
public BaseResource(string? module)
{
Module = module;
}
@@ -33,6 +32,8 @@ internal abstract class BaseResource
public abstract bool Manifest(string? outputDir);
public abstract IList<string> GetSupportedModules();
protected void WriteJsonOutputLine(string output)
{
Console.WriteLine(output);

139
src/dsc/v3/PowerToys.DSC/Resources/SettingsResource.cs
View File

@@ -4,6 +4,8 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text.Json;
using System.Text.Json.Nodes;
using ManagedCommon;
@@ -18,41 +20,45 @@ internal sealed class SettingsResource : BaseResource
private sealed record ModuleActions(Func<string> Get, Action<string> Set, Func<string> Schema);
public const string ResourceName = "settings";
public const string AppModule = "App";
private static readonly SettingsUtils _settingsUtils = new();
private readonly Dictionary<ModuleType, ModuleActions> _moduleActions;
private readonly Dictionary<string, ModuleActions> _moduleActions;
public SettingsResource(ModuleType module)
public string ModuleOrDefault => Module ?? AppModule;
public SettingsResource(string? module)
: base(module)
{
_moduleActions = new Dictionary<ModuleType, ModuleActions>()
_moduleActions = new Dictionary<string, ModuleActions>()
{
{ ModuleType.AdvancedPaste, CreateModuleActions<AdvancedPasteSettings>() },
{ ModuleType.AlwaysOnTop, CreateModuleActions<AlwaysOnTopSettings>() },
{ ModuleType.Awake, CreateModuleActions<AwakeSettings>() },
{ ModuleType.ColorPicker, CreateModuleActions<ColorPickerSettings>() },
{ ModuleType.CropAndLock, CreateModuleActions<CropAndLockSettings>() },
{ ModuleType.EnvironmentVariables, CreateModuleActions<EnvironmentVariablesSettings>() },
{ ModuleType.FancyZones, CreateModuleActions<FancyZonesSettings>() },
{ ModuleType.FileLocksmith, CreateModuleActions<FileLocksmithSettings>() },
{ ModuleType.FindMyMouse, CreateModuleActions<FindMyMouseSettings>() },
{ ModuleType.Hosts, CreateModuleActions<HostsSettings>() },
{ ModuleType.ImageResizer, CreateModuleActions<ImageResizerSettings>() },
{ ModuleType.KeyboardManager, CreateModuleActions<KeyboardManagerSettings>() },
{ ModuleType.MouseHighlighter, CreateModuleActions<MouseHighlighterSettings>() },
{ ModuleType.MouseJump, CreateModuleActions<MouseJumpSettings>() },
{ ModuleType.MousePointerCrosshairs, CreateModuleActions<MousePointerCrosshairsSettings>() },
{ ModuleType.MouseWithoutBorders, CreateModuleActions<MouseWithoutBordersSettings>() },
{ ModuleType.NewPlus, CreateModuleActions<NewPlusSettings>() },
{ ModuleType.Peek, CreateModuleActions<PeekSettings>() },
{ ModuleType.PowerRename, CreateModuleActions<PowerRenameSettings>() },
{ ModuleType.PowerLauncher, CreateModuleActions<PowerLauncherSettings>() },
{ ModuleType.PowerAccent, CreateModuleActions<PowerAccentSettings>() },
{ ModuleType.RegistryPreview, CreateModuleActions<RegistryPreviewSettings>() },
{ ModuleType.MeasureTool, CreateModuleActions<MeasureToolSettings>() },
{ ModuleType.ShortcutGuide, CreateModuleActions<ShortcutGuideSettings>() },
{ ModuleType.PowerOCR, CreateModuleActions<PowerOcrSettings>() },
{ ModuleType.Workspaces, CreateModuleActions<WorkspacesSettings>() },
{ ModuleType.ZoomIt, CreateModuleActions<ZoomItSettings>() },
{ AppModule, CreateModuleActions<GeneralSettings>() },
{ nameof(ModuleType.AdvancedPaste), CreateModuleActions<AdvancedPasteSettings>() },
{ nameof(ModuleType.AlwaysOnTop), CreateModuleActions<AlwaysOnTopSettings>() },
{ nameof(ModuleType.Awake), CreateModuleActions<AwakeSettings>() },
{ nameof(ModuleType.ColorPicker), CreateModuleActions<ColorPickerSettings>() },
{ nameof(ModuleType.CropAndLock), CreateModuleActions<CropAndLockSettings>() },
{ nameof(ModuleType.EnvironmentVariables), CreateModuleActions<EnvironmentVariablesSettings>() },
{ nameof(ModuleType.FancyZones), CreateModuleActions<FancyZonesSettings>() },
{ nameof(ModuleType.FileLocksmith), CreateModuleActions<FileLocksmithSettings>() },
{ nameof(ModuleType.FindMyMouse), CreateModuleActions<FindMyMouseSettings>() },
{ nameof(ModuleType.Hosts), CreateModuleActions<HostsSettings>() },
{ nameof(ModuleType.ImageResizer), CreateModuleActions<ImageResizerSettings>() },
{ nameof(ModuleType.KeyboardManager), CreateModuleActions<KeyboardManagerSettings>() },
{ nameof(ModuleType.MouseHighlighter), CreateModuleActions<MouseHighlighterSettings>() },
{ nameof(ModuleType.MouseJump), CreateModuleActions<MouseJumpSettings>() },
{ nameof(ModuleType.MousePointerCrosshairs), CreateModuleActions<MousePointerCrosshairsSettings>() },
{ nameof(ModuleType.MouseWithoutBorders), CreateModuleActions<MouseWithoutBordersSettings>() },
{ nameof(ModuleType.NewPlus), CreateModuleActions<NewPlusSettings>() },
{ nameof(ModuleType.Peek), CreateModuleActions<PeekSettings>() },
{ nameof(ModuleType.PowerRename), CreateModuleActions<PowerRenameSettings>() },
{ nameof(ModuleType.PowerLauncher), CreateModuleActions<PowerLauncherSettings>() },
{ nameof(ModuleType.PowerAccent), CreateModuleActions<PowerAccentSettings>() },
{ nameof(ModuleType.RegistryPreview), CreateModuleActions<RegistryPreviewSettings>() },
{ nameof(ModuleType.MeasureTool), CreateModuleActions<MeasureToolSettings>() },
{ nameof(ModuleType.ShortcutGuide), CreateModuleActions<ShortcutGuideSettings>() },
{ nameof(ModuleType.PowerOCR), CreateModuleActions<PowerOcrSettings>() },
{ nameof(ModuleType.Workspaces), CreateModuleActions<WorkspacesSettings>() },
{ nameof(ModuleType.ZoomIt), CreateModuleActions<ZoomItSettings>() },
};
}
@@ -63,7 +69,7 @@ internal sealed class SettingsResource : BaseResource
public override bool Get(string? input)
{
if (_moduleActions.TryGetValue(Module, out ModuleActions? actions))
if (_moduleActions.TryGetValue(ModuleOrDefault, out ModuleActions? actions))
{
WriteJsonOutputLine(actions.Get());
return true;
@@ -81,7 +87,7 @@ internal sealed class SettingsResource : BaseResource
return false;
}
if (_moduleActions.TryGetValue(Module, out ModuleActions? actions))
if (_moduleActions.TryGetValue(ModuleOrDefault, out ModuleActions? actions))
{
actions.Set(input!);
return true;
@@ -99,9 +105,9 @@ internal sealed class SettingsResource : BaseResource
public override bool Schema()
{
if (_moduleActions.TryGetValue(Module, out ModuleActions? actions))
if (_moduleActions.TryGetValue(ModuleOrDefault, out ModuleActions? actions))
{
WriteJsonOutputLine(actions.Get());
WriteJsonOutputLine(actions.Schema());
return true;
}
@@ -111,10 +117,38 @@ internal sealed class SettingsResource : BaseResource
public override bool Manifest(string? outputDir)
{
foreach (var moduleType in _moduleActions.Keys)
List<(string Name, string Manifest)> manifests = [];
if (!string.IsNullOrEmpty(Module))
{
var manifest = GenerateManifest(moduleType);
WriteJsonOutputLine(manifest);
if (!_moduleActions.ContainsKey(Module))
{
WriteMessageOutputLine(DscMessageLevel.Error, $"Unsupported module type: {Module}");
return false;
}
manifests.Add((Module, GenerateManifest(Module)));
}
else
{
foreach (var module in GetSupportedModules())
{
manifests.Add((module, GenerateManifest(module)));
}
}
if (!string.IsNullOrEmpty(outputDir))
{
foreach (var (name, manifest) in manifests)
{
File.WriteAllText(Path.Combine(outputDir, $"microsoft.powertoys.{name}.settings.dsc.resource.json"), manifest);
}
}
else
{
foreach (var (_, manifest) in manifests)
{
WriteJsonOutputLine(manifest);
}
}
return true;
@@ -141,33 +175,33 @@ internal sealed class SettingsResource : BaseResource
return new(GetSettings<TSettings>, SaveSettings<TSettings>, GenerateSchema<SettingsResourceObject<TSettings>>);
}
private string GenerateManifest(ModuleType moduleType)
private string GenerateManifest(string module)
{
var manifest = new JsonObject()
{
["$schema"] = "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.vscode.json",
["description"] = $"Allows management of {moduleType} settings state via the DSC v3 command line interface protocol.",
["type"] = "Microsoft.PowerToys/AwakeSettings",
["description"] = $"Allows management of {module} settings state via the DSC v3 command line interface protocol.",
["type"] = $"Microsoft.PowerToys/{module}Settings",
["version"] = "0.1.0",
["tag"] = new JsonArray("PowerToys"),
["tags"] = new JsonArray("PowerToys"),
["export"] = new JsonObject
{
["executable"] = "PowerToys.Dsc.exe",
["executable"] = "PowerToys.Dsc",
["input"] = "stdin",
["args"] = new JsonArray("export", "--module", moduleType.ToString(), "--resource", "settings"),
["args"] = new JsonArray("export", "--module", module, "--resource", "settings"),
},
["get"] = new JsonObject
{
["executable"] = "PowerToys.Dsc.exe",
["executable"] = "PowerToys.Dsc",
["input"] = "stdin",
["args"] = new JsonArray("get", "--module", moduleType.ToString(), "--resource", "settings"),
["args"] = new JsonArray("get", "--module", module, "--resource", "settings"),
},
["set"] = new JsonObject
{
["executable"] = "PowerToys.Dsc.exe",
["executable"] = "PowerToys.Dsc",
["implementsPretest"] = false,
["return"] = "stateAndDiff",
["args"] = new JsonArray("set", "--module", moduleType.ToString(), "--resource", "settings", new JsonObject
["args"] = new JsonArray("set", "--module", module, "--resource", "settings", new JsonObject
{
["jsonInputArg"] = "--input",
["mandatory"] = true,
@@ -177,12 +211,17 @@ internal sealed class SettingsResource : BaseResource
{
["command"] = new JsonObject
{
["executable"] = "PowerToys.Dsc.exe",
["args"] = new JsonArray("schema", "--module", moduleType.ToString(), "--resource", "settings"),
["executable"] = "PowerToys.Dsc",
["args"] = new JsonArray("schema", "--module", module, "--resource", "settings"),
},
},
};
return manifest.ToJsonString(new() { WriteIndented = false });
return manifest.ToJsonString(new() { WriteIndented = true });
}
public override IList<string> GetSupportedModules()
{
return [.. _moduleActions.Keys.Order()];
}
}