docs: note about usage of config as js file (#6341)

electron-userland · Oct 20, 2021 · d2ae0d3 · d2ae0d3
1 parent de40db8
commit d2ae0d3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md
@@ -13,6 +13,9 @@ electron-builder [configuration](#configuration) can be defined
    
     `json`, [json5](http://json5.org), [toml](https://github.com/toml-lang/toml) or `js` (exported configuration or function that produces configuration) formats also supported.
 
+    !!! tip
+        If you want to use `js` file, do not name it `electron-builder.js`. It will [conflict](https://github.com/electron-userland/electron-builder/issues/6227) with `electron-builder` package name.
+
     !!! tip
         If you want to use [toml](https://en.wikipedia.org/wiki/TOML), please install `yarn add toml --dev`.