electron / electron/forge

Documentation for `name` property on Squirrel maker config is incorrect

Open
#3,118 3 comments 0 reactions 0 assignees View on GitHub
documentation maker/squirrel
Dominant language
TypeScript
Stars
7.1k
Forks
641
Avg merge
3d 1h
Merged PRs (30d)
30

Description

### Pre-flight checklist

- [X] I have read the [contribution documentation](https://github.com/electron/forge/blob/main/CONTRIBUTING.md) for this project.
- [X] I agree to follow the [code of conduct](https://github.com/electron/electron/blob/main/CODE_OF_CONDUCT.md) that this project uses.
- [X] I have searched the issue tracker for a bug that matches the one I want to file, without success.

### Electron Forge version

6.0.4

### Electron version

22.0.0

### Operating system

Windows 11 (22621.963)

### Last known working Electron Forge version

_No response_

### Expected behavior

The [name config option for the Windows Squirrel maker](https://js.electronforge.io/interfaces/_electron_forge_maker_squirrel.InternalOptions.Options.html#name) is described accurately.

### Actual behavior

This is the current description for `name`:

> Windows Application Model ID (appId).
>
> Defaults to the name field in your app's package.json file.

It looks like the AUMID actually gets set to `com.squirrel..` Where `` is the value given to the `name` property on the maker config, and `` is the name field in package.json.

### Steps to reproduce

Use the [lnk-parser tool](https://code.google.com/archive/p/lnk-parser/) to check `System.AppUserModel.ID` on the shortcut generated by the Squirrel installer.

### Additional information

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.