fix: exclude electron by default (#746)

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

Author: ascorbic

docs/large-functions.md

@@ -4,13 +4,15 @@ You may see an error about generated functions being too large. This is because
 There are two possible causes for this, each with its own solution. The list of largest files shown in the build logs will help you see what the cause is.
 
 - **Large dependencies**
-    This is the most common cause of the problem. Some node modules are very large, mostly those that include native modules. Examples include `electron` and `chromium`. The function bundler is usually able to find out which modules are actually used by your code, but sometimes it will incorrectly include unneeded modules. If this is the case, you can either remove the module from your dependencies if you installed it yourself, or exclude it manually by adding something like this to your `netlify.toml`, changing the value according to the problematic module:
+    This is the most common cause of the problem. Some node modules are very large, mostly those that include native modules. Examples include `electron` and `chromium`. The function bundler is usually able to find out which modules are actually used by your code, but sometimes it will incorrectly include unneeded modules. If this is the case, you can either remove the module from your dependencies if you installed it yourself, or exclude it manually by adding something like this to your `netlify.toml`, changing the value according to the problematic module. The `!` at the beginning of the module path indicates that it should be excluded:
 
     ```toml
     [functions]
-    excluded_files = "node_modules/electron/**/*"
+    included_files = ["!node_modules/a-large-module/**/*"]
     ```
-    If you do need large modules (e.g. if you are running Puppeteer in a Next API route), consider changing to a Netlify function.
+    If you really do need large modules (e.g. if you are running Puppeteer in a Next API route), consider changing to a Netlify function which will have less overhead than the equivalent Next.js function.
 
 - **Large numbers of pre-rendered pages**
-If you have a very large number of pre-rendered pages, these can take up a lot of space in the function. There are two approaches to fixing this. One is to consider deferring the building of the pages. If you set `fallback = "blocking"`, the rendering will be deferred until the first user requests the page. This is a good choice for low-traffic pages. It reduces build and deploy time, and can make your bundle a lot smaller. The other option is to enable an experimental feature that moves static files out of the function bundle. To do this, set the environment variable `EXPERIMENTAL_MOVE_STATIC_PAGES` to true.
+  If you have a very large number of pre-rendered pages, these can take up a lot of space in the function. There are two approaches to fixing this. One is to consider deferring the building of the pages. If you return `fallback: "blocking"` from `getStaticPaths` the rendering will be deferred until the first user requests the page. This is a good choice for low-traffic pages. It reduces build and deploy time, and can make your bundle a lot smaller. 
+
+  The other option is to enable an experimental feature that moves static files out of the function bundle. To do this, set the environment variable `EXPERIMENTAL_MOVE_STATIC_PAGES` to true.

src/helpers/config.js

@@ -150,5 +150,10 @@ exports.configureHandlerFunctions = ({ netlifyConfig, publish, ignore = [] }) =>
     if (sharpRoot) {
       netlifyConfig.functions[functionName].included_files.push(`!${sharpRoot}/**/*`)
     }
+
+    const electronRoot = resolveModuleRoot('electron')
+    if (electronRoot) {
+      netlifyConfig.functions[functionName].included_files.push(`!${electronRoot}/**/*`)
+    }
   })
 }