feat: enabling support for typescript config files (i.e. electron-builder.ts) (#7180)

Author: mmaietta

.changeset/sour-chicken-study.md

@@ -0,0 +1,6 @@
+---
+"app-builder-lib": minor
+"electron-builder": minor
+---
+
+feat: enabling typescript config files (i.e. electron-builder.ts)

README.md

@@ -118,6 +118,7 @@ will declare to use node-modules instead of PnP.
     }
     ```
    See [all options](https://www.electron.build/configuration/configuration). Option [files](https://www.electron.build/configuration/contents#files) to indicate which files should be packed in the final application, including the entry file, maybe required.
+   You can also use separate configuration files, such as `js`, `ts`, `yml`, and `json`/`json5`. See [read-config-file](https://www.npmjs.com/package/read-config-file) for supported extensions. [JS Example for programmatic API](https://www.electron.build/api/programmatic-usage)
 
 3. Add [icons](https://www.electron.build/icons).
 

docs/cli.md

@@ -25,7 +25,7 @@ Building:
   --projectDir, --project  The path to project directory. Defaults to current
                            working directory.
   --config, -c             The path to an electron-builder config. Defaults to
-                           `electron-builder.yml` (or `json`, or `json5`), see
+                           `electron-builder.yml` (or `json`, or `json5`, or `js`, or `ts`), see
                            https://goo.gl/YFRJOM
 
 Publishing:

docs/configuration/configuration.md

@@ -11,7 +11,7 @@ electron-builder [configuration](#configuration) can be defined
    appId: "com.example.app"
    ```
    
-    `json`, [json5](http://json5.org), [toml](https://github.com/toml-lang/toml) or `js` (exported configuration or function that produces configuration) formats also supported.
+    `json`, [json5](http://json5.org), [toml](https://github.com/toml-lang/toml) or `js`/`ts` (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.

packages/app-builder-lib/package.json

@@ -68,7 +68,7 @@
     "js-yaml": "^4.1.0",
     "lazy-val": "^1.0.5",
     "minimatch": "^3.1.2",
-    "read-config-file": "6.2.0",
+    "read-config-file": "6.3.2",
     "sanitize-filename": "^1.6.3",
     "semver": "^7.3.7",
     "tar": "^6.1.11",

packages/app-builder-lib/src/fileMatcher.ts

@@ -181,7 +181,7 @@ export function getMainFileMatchers(
 
   patterns.push(`!**/*.{${excludedExts}${packager.config.includePdb === true ? "" : ",pdb"}}`)
   patterns.push("!**/._*")
-  patterns.push("!**/electron-builder.{yaml,yml,json,json5,toml}")
+  patterns.push("!**/electron-builder.{yaml,yml,json,json5,toml,ts}")
   patterns.push(`!**/{${excludedNames}}`)
 
   if (isElectronCompile) {

packages/electron-builder/package.json

@@ -59,7 +59,7 @@
     "fs-extra": "^10.0.0",
     "is-ci": "^3.0.0",
     "lazy-val": "^1.0.5",
-    "read-config-file": "6.2.0",
+    "read-config-file": "6.3.2",
     "simple-update-notifier": "^1.0.7",
     "yargs": "^17.5.1"
   },

packages/electron-builder/src/builder.ts

@@ -286,7 +286,8 @@ export function configureBuildCommand(yargs: yargs.Argv): yargs.Argv {
     .option("config", {
       alias: ["c"],
       group: buildGroup,
-      description: "The path to an electron-builder config. Defaults to `electron-builder.yml` (or `json`, or `json5`), see " + chalk.underline("https://goo.gl/YFRJOM"),
+      description:
+        "The path to an electron-builder config. Defaults to `electron-builder.yml` (or `json`, or `json5`, or `js`, or `ts`), see " + chalk.underline("https://goo.gl/YFRJOM"),
     })
     .group(["help", "version"], "Other:")
     .example("electron-builder -mwl", "build for macOS, Windows and Linux")