Permalink
Please
sign in to comment.
Browse files
docs(generic): add support document & move debugging section there
- Loading branch information
@@ -0,0 +1,33 @@ | ||
# Support for Electron Forge | ||
|
||
If you have questions about usage, we encourage you to browse the [website](https://electronforge.io/), | ||
and visit one of the several [community-driven sites](https://github.com/electron/electron#community). | ||
|
||
## Troubleshooting | ||
|
||
One way to troubleshoot potential problems is to set the `DEBUG` environment variable before | ||
running `electron-forge`. This will print debug information from the specified modules. The | ||
value of the environment variable is a comma-separated list of modules which support this logging | ||
feature. Known modules include: | ||
|
||
* `electron-compile:*` | ||
* `electron-download` | ||
* `electron-forge:*` (always use this one before filing an issue) | ||
* `electron-installer-debian` | ||
* `electron-installer-dmg` | ||
* `electron-installer-flatpak` | ||
* `electron-installer-redhat` | ||
* `electron-osx-sign` | ||
* `electron-packager` | ||
* `electron-rebuild` | ||
* `electron-windows-installer:main` | ||
* `electron-windows-store` | ||
* `extract-zip` | ||
* `get-package-info` | ||
|
||
We use the [`debug`](https://www.npmjs.com/package/debug#usage) module for this functionality. It | ||
has examples on how to set environment variables if you don't know how. | ||
|
||
**If you are using `npm run` to execute `electron-forge`, run the `electron-forge` command | ||
without using `npm run` and make a note of the output, because `npm run` does not print out error | ||
messages when a script errors.** |
0 comments on commit
d3f610c