fix: add disableDefaultIgnoredFiles option (electron-userland#8398)

beyondkmp · Aug 8, 2024 · 5ab2bee · 5ab2bee
1 parent 8dabf64
commit 5ab2bee
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 2 deletions.
diff --git a/.changeset/smooth-roses-laugh.md b/.changeset/smooth-roses-laugh.md
@@ -0,0 +1,5 @@
+---
+"app-builder-lib": patch
+---
+
+add disableDefaultIgnoredFiles option
diff --git a/docs/generated/PlatformSpecificBuildOptions.md b/docs/generated/PlatformSpecificBuildOptions.md
@@ -12,6 +12,9 @@
 <p><code id="PlatformSpecificBuildOptions-compression">compression</code> = <code>normal</code> “store” | “normal” | “maximum” | “undefined” - The compression level. If you want to rapidly test build, <code>store</code> can reduce build time significantly. <code>maximum</code> doesn’t lead to noticeable size difference, but increase build time.</p>
 </li>
 <li>
+<p><code id="PlatformSpecificBuildOptions-disableDefaultIgnoredFiles">disableDefaultIgnoredFiles</code> = <code>false</code> Boolean | “undefined” - Whether to exclude all default ignored files(<a href="https://www.electron.build/configuration/contents#files">https://www.electron.build/configuration/contents#files</a>) and options. Defaults to <code>false</code>.</p>
+</li>
+<li>
 <p><code id="PlatformSpecificBuildOptions-files">files</code> The <a href="/configuration/contents#files">files</a> configuration.</p>
 </li>
 <li>

diff --git a/packages/app-builder-lib/scheme.json b/packages/app-builder-lib/scheme.json
@@ -1652,6 +1652,14 @@
           "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
           "type": "boolean"
         },
+        "disableDefaultIgnoredFiles": {
+          "default": false,
+          "description": "Whether to exclude all default ignored files(https://www.electron.build/configuration/contents#files) and options. Defaults to `false`.",
+          "type": [
+            "null",
+            "boolean"
+          ]
+        },
         "electronLanguages": {
           "anyOf": [
             {
@@ -2275,6 +2283,14 @@
           "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
           "type": "boolean"
         },
+        "disableDefaultIgnoredFiles": {
+          "default": false,
+          "description": "Whether to exclude all default ignored files(https://www.electron.build/configuration/contents#files) and options. Defaults to `false`.",
+          "type": [
+            "null",
+            "boolean"
+          ]
+        },
         "electronLanguages": {
           "anyOf": [
             {
@@ -2905,6 +2921,14 @@
           "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
           "type": "boolean"
         },
+        "disableDefaultIgnoredFiles": {
+          "default": false,
+          "description": "Whether to exclude all default ignored files(https://www.electron.build/configuration/contents#files) and options. Defaults to `false`.",
+          "type": [
+            "null",
+            "boolean"
+          ]
+        },
         "electronLanguages": {
           "anyOf": [
             {
@@ -6057,6 +6081,14 @@
           "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
           "type": "boolean"
         },
+        "disableDefaultIgnoredFiles": {
+          "default": false,
+          "description": "Whether to exclude all default ignored files(https://www.electron.build/configuration/contents#files) and options. Defaults to `false`.",
+          "type": [
+            "null",
+            "boolean"
+          ]
+        },
         "electronLanguages": {
           "anyOf": [
             {
@@ -6695,6 +6727,14 @@
         }
       ]
     },
+    "disableDefaultIgnoredFiles": {
+      "default": false,
+      "description": "Whether to exclude all default ignored files(https://www.electron.build/configuration/contents#files) and options. Defaults to `false`.",
+      "type": [
+        "null",
+        "boolean"
+      ]
+    },
     "disableSanityCheckAsar": {
       "default": false,
       "description": "Whether to disable sanity check asar package (useful for custom electron forks that implement their own encrypted integrity validation)",

diff --git a/packages/app-builder-lib/src/options/PlatformSpecificBuildOptions.ts b/packages/app-builder-lib/src/options/PlatformSpecificBuildOptions.ts
@@ -50,6 +50,13 @@ export interface PlatformSpecificBuildOptions extends TargetSpecificOptions {
    */
   readonly compression?: CompressionLevel | null
 
+  /**
+   * Whether to exclude all default ignored files(https://www.electron.build/configuration/contents#files) and options. Defaults to `false`.
+   *
+   * @default false
+   */
+  disableDefaultIgnoredFiles?: boolean | null
+
   files?: Array<FileSet | string> | FileSet | string | null
   extraResources?: Array<FileSet | string> | FileSet | string | null
   extraFiles?: Array<FileSet | string> | FileSet | string | null

diff --git a/packages/app-builder-lib/src/util/NodeModuleCopyHelper.ts b/packages/app-builder-lib/src/util/NodeModuleCopyHelper.ts
@@ -1,6 +1,6 @@
 import BluebirdPromise from "bluebird-lst"
 import { CONCURRENCY } from "builder-util"
-import { lstat, readdir } from "fs-extra"
+import { lstat, readdir, lstatSync } from "fs-extra"
 import * as path from "path"
 import { excludedNames, FileMatcher } from "../fileMatcher"
 import { Packager } from "../packager"
@@ -76,7 +76,9 @@ export class NodeModuleCopyHelper extends FileCopyHelper {
             return null
           }
 
-          if (!forceIncluded) {
+          // check if filematcher matches the files array as more important than the default excluded files.
+          const fileMatched = filter != null && filter(dirPath, lstatSync(dirPath))
+          if (!fileMatched || !forceIncluded || !!this.packager.config.disableDefaultIgnoredFiles) {
             for (const ext of nodeModuleExcludedExts) {
               if (name.endsWith(ext)) {
                 return null