Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2025-12-15 19:27:56 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
copilot/fix-controls-label-association
PowerToys/doc/devdocs
History
Jaylyn Barbee 0d5220561d [New Module] Light Switch (#41987) 
<!-- 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
This pull request introduces a new module called "Light Switch" which
allows users to automatically switch between light and dark mode on a
timer.

![Light
Switch](https://github.com/user-attachments/assets/d24d7364-445f-4f23-ab5e-4b8c6a4147ab)

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist

- [x] Closes: #1331
- [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] **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:
[#5867](https://github.com/MicrosoftDocs/windows-dev-docs-pr/pull/5867)

<!-- 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

### Known bugs:
- Default settings not saving correctly when switching modes
- Issue: Sometimes when you switch from one mode to another, they are
supposed to update with new defaults but sometimes this fails for the
second variable. Potentially has to do with accessing the settings file
while another chunk of code is still updating.
- Sometimes the system looks "glitched" when switching themes

### To do:
- [x] OOBE page and assets
- [x] Logic to disable the chart when no location has been selected
- [x] Localization

### How to and what to test
Grab the latest installer from the pipeline below for your architecture
and install PowerToys from there.
- Toggle theme shortcutSystem only, Apps only, Both system and apps
selected
- Does changing the values on the settings page update the settings
file? %LOCALAPPDATA%/Microsoft/PowerToys/LightSwitch/settings.json
- Manual mode: System only, Apps only, Both system and apps selected
- Sunrise modes:  Are the times accurate?
- If you manage to let this run through sunset/rise does the theme
change?
- Set your theme to change within the next minute using manual mode and
set your device to sleepOpen your device and login once the time you set
has passed. --> Do your settings resync once the next minute ticks after
logging back into your device?
- Disable the service and ensure the tasks actually ends.
- While the module is disabled:
     - Make sure the shortcut no longer works
     - Make sure the last time you set doesn't trigger a theme change
- Bonus: Toggle GPO Configuration and make sure you are unable to enable
the module

---------

Co-authored-by: Niels Laute <niels.laute@live.nl>
Co-authored-by: Gordon Lam (SH) <yeelam@microsoft.com>
2025-10-06 13:44:07 -07:00
..
common
[DevDocs] More content and restructure (#40165)
2025-07-01 14:27:34 +02:00
core
[Installer] Upgrade the installer from WiX3 to WiX5 (#40877)
2025-08-25 18:39:11 +08:00
development
Fix for #42186 (#42187)
2025-10-06 15:02:31 +02:00
images
[Tests] More consistent naming (#40754)
2025-07-24 17:53:22 +02:00
modules
[New Module] Light Switch (#41987)
2025-10-06 13:44:07 -07:00
processes
Resolve spelling check noise (#40433)
2025-07-07 13:08:48 +08:00
tools
Adds BgcodeThumbnailProvider and BgcodePreviewHandler (#38667)
2025-07-10 17:20:30 +08:00
akaLinks.md
[VCM]Deprecate the Video Conference Mute utility (#36772)
2025-01-16 15:17:34 +00:00
disk-usage-footprint.md
[devdocs] Add disk usage footprint doc (#23248)
2023-01-25 18:36:25 +01:00
embedded-msix.md
[Docs] Add msix embedding instructions (#13489)
2021-09-30 14:29:05 +03:00
guidance.md
Updates for check-spelling v0.0.25 (#40386)
2025-07-08 17:16:52 -05:00
localization.md
Updates for check-spelling v0.0.25 (#40386)
2025-07-08 17:16:52 -05:00
logging.md
Centralize c# logger (#22760)
2023-03-21 10:27:29 +01:00
readme.md
DevDocs: Add prerequisites to enable long paths in Windows (#41329)
2025-09-02 19:43:28 -05:00
run-as-admin-detection.md
Create run-as-admin-detection.md
2020-07-29 17:43:43 -07:00
style.md
[Build]Use XamlStyler to check XAML formatting (#28643)
2023-10-09 15:58:13 +01:00

readme.md

PowerToys Developer Documentation

Welcome to the PowerToys developer documentation. This documentation provides information for developers who want to contribute to PowerToys or understand how it works.

Core Architecture

Common Components

Development Guidelines

Tools

Processes

Fork, Clone, Branch and Create your PR

Once you've discussed your proposed feature/fix/etc. with a team member, and an approach or a spec has been written and approved, it's time to start development:

  1. Fork the repo on GitHub if you haven't already
  2. Clone your fork locally
  3. Create a feature branch
  4. Work on your changes
  5. Create a Draft Pull Request (PR)
  6. When ready, mark your PR as "ready for review".

Rules

  • Follow the pattern of what you already see in the code.
  • Coding style.
  • Try to package new functionality/components into libraries that have nicely defined interfaces.
  • Package new functionality into classes or refactor existing functionality into a class as you extend the code.
  • When adding new classes/methods/changing existing code, add new unit tests or update the existing tests.

GitHub Workflow

  • Before starting to work on a fix/feature, make sure there is an open issue to track the work.
  • Add the In progress label to the issue, if not already present. Also add a Cost-Small/Medium/Large estimate and make sure all appropriate labels are set.
  • If you are a community contributor, you will not be able to add labels to the issue; in that case just add a comment saying that you have started work on the issue and try to give an estimate for the delivery date.
  • If the work item has a medium/large cost, using the markdown task list, list each sub item and update the list with a check mark after completing each sub item.
  • When opening a PR, follow the PR template.
  • When you'd like the team to take a look (even if the work is not yet fully complete) mark the PR as 'Ready For Review' so that the team can review your work and provide comments, suggestions, and request changes. It may take several cycles, but the end result will be solid, testable, conformant code that is safe for us to merge.
  • When the PR is approved, let the owner of the PR merge it. For community contributions, the reviewer who approved the PR can also merge it.
  • Use the Squash and merge option to merge a PR. If you don't want to squash it because there are logically different commits, use Rebase and merge.
  • Close issues automatically when referenced in a PR. You can use closing keywords in the body of the PR to have GitHub automatically link your PR to the issue.

Compiling PowerToys

Prerequisites for Compiling PowerToys

  1. Windows 10 April 2018 Update (version 1803) or newer
  2. Visual Studio Community/Professional/Enterprise 2022 17.4 or newer
  3. A local clone of the PowerToys repository
  4. Enable long paths in Windows (see Enable Long Paths for details)

Install Visual Studio dependencies

  1. Open the PowerToys.sln file.
  2. If you see a dialog that says install extra components in the solution explorer pane, click install

Get Submodules to compile

We have submodules that need to be initialized before you can compile most parts of PowerToys. This should be a one-time step.

  1. Open a terminal
  2. Navigate to the folder you cloned PowerToys to.
  3. Run git submodule update --init --recursive

Compiling Source Code

  • Open PowerToys.sln in Visual Studio.
  • In the Solutions Configuration drop-down menu select Release or Debug.
  • From the Build menu choose Build Solution, or press Control+Shift+b on your keyboard.
  • The build process may take several minutes depending on your computer's performance. Once it completes, the PowerToys binaries will be in your repo under x64\Release\.
    • You can run x64\Release\PowerToys.exe directly without installing PowerToys, but some modules (i.e. PowerRename, ImageResizer, File Explorer extension etc.) will not be available unless you also build the installer and install PowerToys.

Compile the installer

Our installer is two parts, an EXE and an MSI. The EXE (Bootstrapper) contains the MSI and handles more complex installation logic.

  • The EXE installs all prerequisites and installs PowerToys via the MSI. It has additional features such as the installation flags (see below).
  • The MSI installs the PowerToys binaries.

The installer can only be compiled in Release mode; steps 1 and 2 must be performed before the MSI can be compiled.

  1. Compile PowerToys.sln. Instructions are listed above.
  2. Compile BugReportTool.sln tool. Path from root: tools\BugReportTool\BugReportTool.sln (details listed below)
  3. Compile StylesReportTool.sln tool. Path from root: tools\StylesReportTool\StylesReportTool.sln (details listed below)
  4. Compile PowerToysSetup.sln Path from root: installer\PowerToysSetup.sln (details listed below)

See Installer for more details on building and debugging the installer.

How to create new PowerToys

See the instructions on how to install the PowerToys Module project template.
Specifications for the PowerToys settings API.

Reference in New Issue View Git Blame Copy Permalink