Skip to content
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

win32metadata should have sensible defaults #611

Closed
3 tasks done
MarshallOfSound opened this issue Mar 7, 2017 · 4 comments
Closed
3 tasks done

win32metadata should have sensible defaults #611

MarshallOfSound opened this issue Mar 7, 2017 · 4 comments
Assignees
Labels
build-target:windows Bundling an Electron app specifically for Windows enhancement Feature request

Comments

@MarshallOfSound
Copy link
Member

MarshallOfSound commented Mar 7, 2017

  • I have read the contribution documentation for this project.
  • I agree to follow the code of conduct that this project follows, as appropriate.
  • I have searched the issue tracker for an issue that matches the one I want to file, without success.

win32metada should have reasonable defaults so that Squirrel shortcut creation works out of the box as expected.

Currently, https://github.com/electron-userland/electron-packager/blob/master/docs/api.md#win32metadata defaults to an empty object AFAIK and therefore the default metadata from Electron is left intact.

This results in lots of questions like "Why is my Squirrel shortcut called 'Electron'?". This can be solved by simply providing logical defaults for the win32metadata option as follows below. Where "p" === "package.json"

Key Mapped Value
ProductName config.name or p.productName or p.name
InternalName config.name or p.productName or p.name
OriginalFilename config.name or p.productName or p.name
FileDescription p.description
CompanyName p.author

This is just a proposal, feedback on this welcome 👍

@malept malept added build-target:windows Bundling an Electron app specifically for Windows enhancement Feature request labels Mar 7, 2017
@malept
Copy link
Member

malept commented Mar 8, 2017

I like this, I've been waiting for someone who has a Windows machine to write something that I can understand for sensible defaults for the metadata fields 😅

About CompanyName: per electron/forge#160 we should probably be more specific about this, since it can be an Object.

@jacobq
Copy link

jacobq commented Mar 8, 2017

I have Windows instances available so let me know if I can be any help.

@malept
Copy link
Member

malept commented Mar 8, 2017

@jacobq I think this one doesn't absolutely require Windows instances, but if you're volunteering them, a) seeing if you can reproduce #590 and/or #597 and b) figuring out what's going on in either would be greatly appreciated 😅

@malept
Copy link
Member

malept commented Mar 20, 2017

About CompanyName: per electron/forge#160 we should probably be more specific about this, since it can be an Object.

The person who implements this should use the parse-author module like in electron/forge#161.

@malept malept added the help wanted Needs a contributor from the community label Apr 23, 2017
@malept malept self-assigned this Jun 6, 2017
@malept malept removed the help wanted Needs a contributor from the community label Jun 6, 2017
malept added a commit that referenced this issue Jun 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build-target:windows Bundling an Electron app specifically for Windows enhancement Feature request
Projects
None yet
Development

No branches or pull requests

3 participants