docs: clarify that name is the app name, not the AUMID - #605
Merged
Conversation
The `name` option's typedoc described it as the "Windows Application Model ID (appId)", which is misleading. `name` is the application name; the Windows AUMID is derived from it as `com.squirrel.<name>.<packageName>`.
5 tasks
MarshallOfSound
approved these changes
Jun 29, 2026
MarshallOfSound
marked this pull request as ready for review
June 29, 2026 20:34
georgexu99
approved these changes
Jul 1, 2026
|
🎉 This PR is included in version 5.4.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Samuel Attard · Slack thread
Before / After
The typedoc for the
nameoption claimed it was the "Windows Application Model ID (appId)", which is misleading.name— "Windows Application Model ID (appId)."name— "The application name." with a note that this is not the Windows AUMID, and that the AUMID is derived from it ascom.squirrel.<name>.<packageName>.How
Docs-only change to the
namefield's JSDoc insrc/options.ts. No behavioral change. The existing@defaultValuenote (the package.jsonnamefield) is preserved.This supersedes/feeds the fix originally drafted in electron/forge#4303 and resolves the docs concern in electron/forge#3118. Fixing it here upstream means Forge no longer needs a per-maker doc override, since it inherits these types.