-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Documentation walking through important steps for writing a New PowerToy #44242
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Documentation walking through important steps for writing a New PowerToy #44242
Conversation
| ```bash | ||
| # Module Name | ||
| Generate-FileList -fileDepsJson "" -fileListName <Module>Files -wxsFilePath $PSScriptRoot\<Module>.wxs -depsPath "$PSScriptRoot..\..\..\$platform\Release\<ModuleServiceName>" | ||
| Generate-FileComponents -fileListName "<Module>Files" -wxsFilePath $PSScriptRoot\<Module>.wxs -regroot $registryroot |
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error documentation
| ```bash | ||
| # Module Name | ||
| Generate-FileList -fileDepsJson "" -fileListName <Module>Files -wxsFilePath $PSScriptRoot\<Module>.wxs -depsPath "$PSScriptRoot..\..\..\$platform\Release\<ModuleServiceName>" | ||
| Generate-FileComponents -fileListName "<Module>Files" -wxsFilePath $PSScriptRoot\<Module>.wxs -regroot $registryroot |
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error documentation
This comment has been minimized.
This comment has been minimized.
| ### Requirements | ||
|
|
||
| * [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) (Desktop & C++ workloads) | ||
| * .NET 8 SDK |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
8 or 9? I dunno, was just wondering :).
Also, does this need to be installed manually? Wouldn't just setting up VS the right way have everything you'd need?
This comment has been minimized.
This comment has been minimized.
niels9001
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some nits
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of suggestions. Some general:
- Keep a blank line before/after every header, list, code block et cetera. (and at end of file)
- I would prefer to use
-for lists - Use MD/GitHub alerts
- A vcxproj file uses XML format
|
|
||
| ### Requirements | ||
|
|
||
| * [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) and the following workloads/individual components: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
VS 2022 is no longer on that page, it's VS 2026 now. But need PR #44304 first.
https://learn.microsoft.com/style-guide/scannable-content/headings |
…left on the PR (thanks!)
|
@Jay-o-Way, I think I implemented all of your feedback! Thanks for the thorough review! |
@check-spelling-bot Report🔴 Please reviewSee the 📂 files view, the 📜action log, or 📝 job summary for details.Unrecognized words (3)Gotchas These words are not needed and should be removedgotchaTo accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands... in a clone of the git@github.com:Jaylyn-Barbee/PowerToys.git repository curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/c635c2f3f714eec2fcf27b643a1919b9a811ef2e/apply.pl' |
perl - 'https://github.com/microsoft/PowerToys/actions/runs/20752062493/attempts/1' &&
git commit -m 'Update check-spelling metadata'Warnings
|
| Count | |
|---|---|
| 2 |
See
If the flagged items are 🤯 false positives
If items relate to a ...
-
binary file (or some other file you wouldn't want to check at all).
Please add a file path to the
excludes.txtfile matching the containing file.File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.
^refers to the file's path from the root of the repository, so^README\.md$would exclude README.md (on whichever branch you're using). -
well-formed pattern.
If you can write a pattern that would match it,
try adding it to thepatterns.txtfile.Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.
Note that patterns can't match multiline strings.
Summary of the Pull Request
This new document serves as a handy guide, packed with key details and helpful tips to keep in mind when creating a new PowerToy.