Configuration keywords have changed, undocumented and inconsistent doco

[electron-forge]

Configuration keywords have changed, undocumented and inconsistent doco

[chetbox]

Thank you @abulka! This is the most useful documentation I have found for maker config in 2021.

[chetbox]

Update: I found some helpful documentation here but I was thrown off by the out-of-date documentation on nmpjs.com: https://www.npmjs.com/package/electron-forge

My Migration Notes

For my own project, I migrated by kind of figuring it out. I like the new format better. Here is what I did to my package.json:

• Renamed electronPackagerConfig -> packagerConfig
• Removed make_targets, electronRebuildConfig and all the electronInstaller*entries and replaced them with a single makers entry e.g.

 "config": {
    "forge": {

      "makers": [
        {
          "name": "@electron-forge/maker-squirrel",
          "config": {
            "name": "myproject"
          }
        },
        {
          "name": "@electron-forge/maker-zip",
          "platforms": [
            "darwin"
          ]
        },
        {
          "name": "@electron-forge/maker-deb",
          "config": {},
          "platforms": [
            "linux"
          ]
        },
        {
          "name": "@electron-forge/maker-rpm",
          "config": {}
        }
      ]

In addition, for what its worth, I read all the config examples for all the makers and compiled this list of possible keywords in each makers object:

- name
- platforms  (a list of strings)
- config 
    - name
    - background
    - format
    - options
        - maintainer
        - homepage
        - categories
        - mimeType
        - keychain
    - features
        - audio
        - mpris
        - webgl
    - summary
    - certificateFile
    - certificatePassword

Many thanks for this documentation! I don't understand why they never keep the documentations updated.

[erickzhao]

I think we caught most of these problems in the v6.0.0 stable release. Please open an issue (or submit a PR) if you find any new problems!