mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-02-24 04:00:02 +01:00
f1367bfa17
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? --> ## Summary of the Pull Request Tasks checklist - [X] Implement DSC infra in PowerToys - [X] Implement Settings DSC resource - [X] Implement Get, Set, Test, Export, Schema - [X] Generate manifest (DSC resource JSON) - [X] Added Unit Tests - [x] Add `NJsonSchema` v11.4.0 to the stream - [x] Package the manifest files so dsc.exe can discover them - [x] Add `PowerToys.DSC.exe` to the PATH (maybe?) - [x] Add `InstallLocation` in the registry key so `winget configue export` can export the PowerToys DSC resources <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist - [X] Closes: #37276 - [X] **Communication:** I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected - [X] **Tests:** Added/updated and all pass - [X] **Localization:** All end-user-facing strings can be localized - [x] **Dev docs:** Added/updated - [x] **New binaries:** Added on the required places - [x] [JSON for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json) for new binaries - [x] [WXS for installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs) for new binaries and localization folder - [x] [YML for CI pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml) for new test projects - [x] [YML for signed pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml) - [x] **Documentation updated:** If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys) and link it here: #xxx <!-- Provide a more detailed description of the PR, other things fixed, or any additional comments/features here --> ## Detailed Description of the Pull Request / Additional comments <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed --------- Co-authored-by: vanzue <vanzue@outlook.com> Co-authored-by: Kai Tao (from Dev Box) <kaitao@microsoft.com> Co-authored-by: Leilei Zhang <leilzh@microsoft.com>
83 lines
3.4 KiB
Markdown
83 lines
3.4 KiB
Markdown
# 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"
|
||
``` |