mirror of
https://github.com/microsoft/PowerToys.git
synced 2024-12-12 02:09:24 +08:00
195 lines
10 KiB
Markdown
195 lines
10 KiB
Markdown
# Dev Documentation
|
|
|
|
## Fork, Clone, Branch and Create your PR
|
|
|
|
Once you've discussed your proposed feature/fix/etc. with a team member, and you've agreed an approach or a spec has been written and approved, it's time to start development:
|
|
|
|
1. Fork the repo if you haven't already
|
|
1. Clone your fork locally
|
|
1. Create & push a feature branch
|
|
1. Create a [Draft Pull Request (PR)](https://github.blog/2019-02-14-introducing-draft-pull-requests/)
|
|
1. Work on your changes
|
|
|
|
## Rules
|
|
|
|
- **Follow the pattern of what you already see in the code.**
|
|
- [Coding style](style.md).
|
|
- Try to package new ideas/components into libraries that have nicely defined interfaces.
|
|
- Package new ideas into classes or refactor existing ideas into a class as you extend.
|
|
- 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 started to 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 that 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`.
|
|
- We don't close issues automatically when referenced in a PR, so after the PR is merged:
|
|
- mark the issue(s), that the PR solved, with the `Resolution-Fix-Committed` label, remove the `In progress` label and if the issue is assigned to a project, move the item to the `Done` status.
|
|
- don't close the issue if it's a bug in the current released version since users tend to not search for closed issues, we will close the resolved issues when a new version is released.
|
|
- if it's not a code fix that effects the end user, the issue can be closed (for example a fix in the build or a code refactoring and so on).
|
|
|
|
|
|
## Repository Overview
|
|
|
|
General project organization:
|
|
|
|
### The [`doc`](/doc) folder
|
|
|
|
Documentation for the project.
|
|
|
|
### The [`Wiki`](https://github.com/microsoft/PowerToys/wiki)
|
|
|
|
The Wiki contains the current specs for the project.
|
|
|
|
### The [`installer`](/installer) folder
|
|
|
|
Contains the source code of the PowerToys installer.
|
|
|
|
### The [`src`](/src) folder
|
|
|
|
Contains the source code of the PowerToys runner and of all of the PowerToys modules. **This is where most of the magic happens.**
|
|
|
|
### The [`tools`](/tools) folder
|
|
|
|
Various tools used by PowerToys. Includes the Visual Studio 2019 project template for new PowerToys.
|
|
|
|
## Compiling PowerToys
|
|
|
|
### Prerequisites for Compiling PowerToys
|
|
|
|
1. Windows 10 April 2018 Update (version 1803) or newer
|
|
2. Visual Studio Community/Professional/Enterprise 2019
|
|
3. Once you've cloned and started the `PowerToys.sln`, in the solution explorer, if you see a dialog that says `install extra components`, click `install`
|
|
|
|
**Optional step:**<br/>
|
|
4. to build the Video Conference module, install the [WDK version 1903](https://docs.microsoft.com/en-us/windows-hardware/drivers/other-wdk-downloads) ([direct download link](https://go.microsoft.com/fwlink/?linkid=2085767))<br />
|
|
During the installation, make sure that, when prompted, the `Install Windows Driver Kit Visual Studio extension` option is checked.
|
|
|
|
|
|
### 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`.
|
|
- 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, step 1 and 2 must be done before the MSI will be able to 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 `WebcamReportTool.sln` tool. Path from root: `tools\WebcamReportTool\WebcamReportTool.sln` (details listed below)
|
|
4. Compile `PowerToysSetup.sln` Path from root: `installer\PowerToysSetup.sln` (details listed below)
|
|
5. Compile `PowerToysBootstrapper.sln` Path from root: `installer\PowerToysBootstrapper\PowerToysBootstrapper.sln` (details listed below)
|
|
|
|
### Prerequisites for building the MSI installer
|
|
|
|
1. Install the [WiX Toolset Visual Studio 2019 Extension](https://marketplace.visualstudio.com/items?itemName=RobMensching.WiXToolset).
|
|
2. Install the [WiX Toolset build tools](https://wixtoolset.org/releases/).
|
|
|
|
### Locally compiling the Bug reporting tool
|
|
|
|
1. Open `tools\BugReportTool\BugReportTool.sln`
|
|
2. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release`
|
|
3. From the `Build` menu, choose `Build Solution`.
|
|
|
|
### Locally compiling the Webcam reporting tool
|
|
|
|
1. Open `tools\WebcamReportTool\WebcamReportTool.sln`
|
|
2. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release`
|
|
3. From the `Build` menu, choose `Build Solution`.
|
|
|
|
### Locally compiling the .MSI installer
|
|
|
|
1. Open `installer\PowerToysSetup.sln`
|
|
2. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release`
|
|
3. From the `Build` menu choose `Build Solution`.
|
|
|
|
The resulting `PowerToysSetup.msi` installer will be available in the `installer\PowerToysSetup\x64\Release\` folder.
|
|
|
|
### Locally compiling the .EXE Bootstrapper installer
|
|
|
|
1. Open `installer\PowerToysBootstrapper\PowerToysBootstrapper.sln`
|
|
2. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release`
|
|
3. From the `Build` menu choose `Build Solution`.
|
|
|
|
The `PowerToysSetup-0.0.1-x64.exe` binary is created in the `installer\PowerToysBootstrapper\x64\Release\` folder.
|
|
|
|
#### Supported arguments for the .EXE Bootstrapper installer
|
|
|
|
Head over to the wiki to see the [full list of supported installer arguments][installerArgWiki].
|
|
|
|
## Debugging
|
|
|
|
The following configuration issue only applies if the user is a member of the Administrators group.
|
|
|
|
Some PowerToys modules require being run with the highest permission level if the current user is a member of the Administrators group. The highest permission level is required to be able to perform some actions when an elevated application (e.g. Task Manager) is in the foreground or is the target of an action. Without elevated privileges some PowerToys modules will still work but with some limitations:
|
|
|
|
- The `FancyZones` module will be not be able to move an elevated window to a zone.
|
|
- The `Shortcut Guide` module will not appear if the foreground window belongs to an elevated application.
|
|
|
|
To run and debug PowerToys from Visual Studio when the user is a member of the Administrators group, Visual Studio has to be started with elevated privileges. If you want to avoid running Visual Studio with elevated privileges and don't mind the limitations described above, you can do the following: open the `runner` project properties and navigate to the `Linker -> Manifest File` settings, edit the `UAC Execution Level` property and change it from `highestAvailable (level='highestAvailable')` to `asInvoker (/level='asInvoker')`, save the changes.
|
|
|
|
## How to create new PowerToys
|
|
|
|
See the instructions on [how to install the PowerToys Module project template](/tools/project_template). <br />
|
|
Specifications for the [PowerToys settings API](/doc/devdocs/settings.md).
|
|
|
|
## Implementation details
|
|
|
|
### [`Runner`](runner.md)
|
|
|
|
The PowerToys Runner contains the project for the PowerToys.exe executable.
|
|
It's responsible for:
|
|
|
|
- Loading the individual PowerToys modules.
|
|
- Passing registered events to the PowerToys.
|
|
- Showing a system tray icon to manage the PowerToys.
|
|
- Bridging between the PowerToys modules and the Settings editor.
|
|
|
|
|
|
|
|
### [`Interface`](modules/interface.md)
|
|
|
|
Definition of the interface used by the [`runner`](/src/runner) to manage the PowerToys. All PowerToys must implement this interface.
|
|
|
|
### [`Common`](common.md)
|
|
|
|
The common lib, as the name suggests, contains code shared by multiple PowerToys components and modules, e.g. [json parsing](/src/common/json.h) and [IPC primitives](/src/common/two_way_pipe_message_ipc.h).
|
|
|
|
### [`Settings`](settings.md)
|
|
|
|
WebView project for editing the PowerToys settings.
|
|
|
|
The html portion of the project that is shown in the WebView is contained in [`settings-html`](/src/settings/settings-html).
|
|
Instructions on how build a new version and update this project are in the [Web project for the Settings UI](./settings-web.md).
|
|
|
|
While developing, it's possible to connect the WebView to the development server running in localhost by setting the `_DEBUG_WITH_LOCALHOST` flag to `1` and following the instructions near it in `./main.cpp`.
|
|
|
|
### [`Settings-web`](settings-web.md)
|
|
This project generates the web UI shown in the [PowerToys Settings](/src/editor).
|
|
It's a `ReactJS` project created using [Fluent UI](https://developer.microsoft.com/en-us/fluentui#/).
|
|
|
|
#### Options
|
|
|
|
This module has a setting to serve as an example for each of the currently implemented settings property:
|
|
|
|
- BoolToggle property
|
|
- IntSpinner property
|
|
- String property
|
|
- ColorPicker property
|
|
- CustomAction property
|
|
|
|
|
|
|
|
[installerArgWiki]: https://github.com/microsoft/PowerToys/wiki/Installer-arguments-for-exe
|