Skip to content

docs: correct maker-squirrel name option description - #4303

Closed
claude[bot] wants to merge 1 commit into
nextfrom
docs/squirrel-name-aumid
Closed

docs: correct maker-squirrel name option description#4303
claude[bot] wants to merge 1 commit into
nextfrom
docs/squirrel-name-aumid

Conversation

@claude

@claude claude Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Requested by Samuel Attard · Slack thread

Fixes #3118

Before: The name option's generated docs described it as the "Windows Application Model ID (appId)", which is misleading — name is not the AUMID.

After: The docs now describe name as the application name, and explain that on Windows the Application User Model ID (AUMID) is derived from it following the pattern com.squirrel.<name>.<packageName> (where <packageName> is the name field in package.json).

How: MakerSquirrelConfig re-exports electron-winstaller's Options type, which is where the misleading name typedoc originates. Since that comment can't be edited from this repo, the name field is now omitted from the inherited type and re-declared with an accurate typedoc comment (same pattern already used by maker-dmg's Config.ts). Docs-only change; no behavioral changes.

  • I have read the contribution documentation for this project.
  • I agree to follow the code of conduct that this project follows, as appropriate.
  • The changes are appropriately documented (if applicable).
  • The changes have sufficient test coverage (if applicable).
  • The testsuite passes successfully on my local machine (if applicable).

Summarize your changes:

Corrected the typedoc for the maker-squirrel name config option so the generated API docs accurately describe it as the application name (from which the Windows AUMID is derived), rather than incorrectly calling it the "Windows Application Model ID".

The `name` option's typedoc described it as the 'Windows Application
Model ID (appId)'. The AUMID is in fact derived from this value as
`com.squirrel.<name>.<packageName>`; the option itself is the
application name. Override the inherited typedoc with an accurate
description.

Fixes #3118
@github-actions github-actions Bot added the next label Jun 29, 2026
@MarshallOfSound
MarshallOfSound marked this pull request as ready for review June 29, 2026 19:53
@MarshallOfSound
MarshallOfSound requested a review from a team as a code owner June 29, 2026 19:53
@claude

claude Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

We're fixing this upstream in electron/windows-installer instead, where the misleading typedoc actually originates and which Forge inherits: electron/windows-installer#605

Correcting it there means Forge doesn't need a per-maker doc override, so I'm closing this PR in favor of the upstream fix. Thanks!

@claude claude Bot closed this Jun 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2 participants