@todesktop/cli 1.18.0 → 1.18.1

package/README.md

@@ -1,8 +1,10 @@
 # ToDesktop CLI
 
-The ToDesktop CLI allows you to build and deploy your electron app with native installers, auto-updates and code signing included.
+The ToDesktop CLI allows you to build and deploy your electron app with native
+installers, auto-updates and code signing included.
 
-For more information, visit the project [landing page](https://www.todesktop.com/cli).
+For more information, visit the project
+[landing page](https://www.todesktop.com/cli).
 
 ## Table of contents
 
@@ -32,7 +34,9 @@ You can use the ToDesktop CLI to work with an Electron application in 4 steps:
 
 ### Step 1: Create a ToDesktop application
 
-Create a ToDesktop application to link to your Electron application. This is currently done via the [web interface](http://app.todesktop.com/). Copy the ToDesktop application ID to your clipboard:
+Create a ToDesktop application to link to your Electron application. This is
+currently done via the [web interface](http://app.todesktop.com/). Copy the
+ToDesktop application ID to your clipboard:
 
 ![ToDesktop ID](https://firebasestorage.googleapis.com/v0/b/todesktop-prod1.appspot.com/o/assets%2Ftodesktop-id.png?alt=media&token=5985e731-76c4-43e8-bbfb-bd708b7cfffd)
 
@@ -50,42 +54,48 @@ Create a `todesktop.json` file in the root of your Electron project.
 }
 ```
 
-Alternatively, you can create a `todesktop.js` file. This allows you to use JavaScript to dynamically generate your configuration. For example:
+Alternatively, you can create a `todesktop.js` file. This allows you to use
+JavaScript to dynamically generate your configuration. For example:
 
 ```javascript
-const path = require("path");
+const path = require('path');
 
 module.exports = {
-  id: process.env.TODESKTOP_APP_ID || "your-default-todesktop-id",
-  icon: path.join(__dirname, "assets", "desktop-icon.png"),
+  id: process.env.TODESKTOP_APP_ID || 'your-default-todesktop-id',
+  icon: path.join(__dirname, 'assets', 'desktop-icon.png'),
   schemaVersion: 1,
 };
 ```
 
-You can also create a `todesktop.ts` file for TypeScript projects with full type checking and IntelliSense:
+You can also create a `todesktop.ts` file for TypeScript projects with full type
+checking and IntelliSense:
 
 ```typescript
-import type { Schema } from "@todesktop/cli";
-import path from "path";
+import type { Schema } from '@todesktop/cli';
+import path from 'path';
 
 const config: Schema = {
-  id: process.env.TODESKTOP_APP_ID || "your-default-todesktop-id",
-  icon: path.join(__dirname, "assets", "desktop-icon.png"),
+  id: process.env.TODESKTOP_APP_ID || 'your-default-todesktop-id',
+  icon: path.join(__dirname, 'assets', 'desktop-icon.png'),
   schemaVersion: 1,
-  nodeVersion: "18.12.1",
+  nodeVersion: '18.12.1',
   mac: {
-    category: "public.app-category.productivity",
+    category: 'public.app-category.productivity',
   },
 };
 
 export default config;
 ```
 
-See [Project configuration](#project-configuration-todesktopjson-todesktopjs-or-todesktops) for the full list of configuration options.
+See
+[Project configuration](#project-configuration-todesktopjson-todesktopjs-or-todesktops)
+for the full list of configuration options.
 
 ### Step 3: Add @todesktop/runtime as a dependency
 
-The ToDesktop [runtime package](https://www.npmjs.com/package/@todesktop/runtime) takes care of auto-updating, crash reporting, and more.
+The ToDesktop
+[runtime package](https://www.npmjs.com/package/@todesktop/runtime) takes care
+of auto-updating, crash reporting, and more.
 
 ```sh
 npm install @todesktop/runtime
@@ -93,11 +103,12 @@ npm install @todesktop/runtime
 yarn add @todesktop/runtime
 ```
 
-In your main (background process) script, require the package and call the `init` function. The key is to call it right at the beginning.
+In your main (background process) script, require the package and call the
+`init` function. The key is to call it right at the beginning.
 
 ```javascript
-const { app, BrowserWindow } = require("electron");
-const todesktop = require("@todesktop/runtime");
+const { app, BrowserWindow } = require('electron');
+const todesktop = require('@todesktop/runtime');
 
 todesktop.init();
 
@@ -109,7 +120,7 @@ function createWindow() {
   });
 
   // and load the index.html of the app.
-  win.loadFile("index.html");
+  win.loadFile('index.html');
 }
 
 app.whenReady().then(createWindow);
@@ -117,13 +128,16 @@ app.whenReady().then(createWindow);
 
 ### Step 4: Build your app
 
-To build your app, run the following command inside the root of your Electron project:
+To build your app, run the following command inside the root of your Electron
+project:
 
 ```sh
 todesktop build
 ```
 
-When prompted to login, use your email address and the accessToken from our dashboard. You can retrieve your access token by clicking on your name in the top right corner of the dashboard and selecting "Manage Access Token".
+When prompted to login, use your email address and the accessToken from our
+dashboard. You can retrieve your access token by clicking on your name in the
+top right corner of the dashboard and selecting "Manage Access Token".
 
 Once built, your app can then be downloaded and tested.
 
@@ -153,7 +167,9 @@ The main command:
 todesktop build
 ```
 
-This builds your Electron app with native installers, code signing, and so on baked-in. Once the build has succeeded, you should see the following output in your terminal. These are links to the download binaries for each platform:
+This builds your Electron app with native installers, code signing, and so on
+baked-in. Once the build has succeeded, you should see the following output in
+your terminal. These are links to the download binaries for each platform:
 
 ```sh
 > ✅ ToDesktop Quick Start v1.0.0
@@ -166,35 +182,50 @@ This builds your Electron app with native installers, code signing, and so on ba
 
 We also support:
 
-- `todesktop build --code-sign=false`. Run a build with code-signing and notarization disabled. This is handy for testing builds quickly.
-- `todesktop build --config=<path.to.config.file>`. Run a build with a different configuration file (e.g., `todesktop.staging.json` or `todesktop.prod.js`).
-- `todesktop build --async`. Run a build in the background. This is handy for CI environments.
-- `todesktop build --webhook URL`. Send a POST request to the webhook URL when the build is finished. It's especially useful together with the `--async` flag.
-- `todesktop build --ignore-extends-errors`. Ignore `id` and `appId` validation errors when extending another configuration file (`.json` or `.js`).
-- `todesktop release`. Release a build. This will publish a new download and an auto-update for existing users. By default it shows a list of builds for you to choose from.
+- `todesktop build --code-sign=false`. Run a build with code-signing and
+  notarization disabled. This is handy for testing builds quickly.
+- `todesktop build --config=<path.to.config.file>`. Run a build with a different
+  configuration file (e.g., `todesktop.staging.json` or `todesktop.prod.js`).
+- `todesktop build --async`. Run a build in the background. This is handy for CI
+  environments.
+- `todesktop build --webhook URL`. Send a POST request to the webhook URL when
+  the build is finished. It's especially useful together with the `--async`
+  flag.
+- `todesktop build --ignore-extends-errors`. Ignore `id` and `appId` validation
+  errors when extending another configuration file (`.json` or `.js`).
+- `todesktop release`. Release a build. This will publish a new download and an
+  auto-update for existing users. By default it shows a list of builds for you
+  to choose from.
   - Use `todesktop release <id>` to release a specific build by ID.
   - `todesktop release --latest` will release the latest build.
   - Append `--force` to skip the interactive confirmation step.
-  - Append `--config=<path.to.config.file>` to use a different configuration file.
+  - Append `--config=<path.to.config.file>` to use a different configuration
+    file.
 - `todesktop builds`. View your recent builds.
   - Use `todesktop builds <id>` to view a specific build and its progress.
   - `todesktop builds --latest` will show the latest build and it's progress.
   - `todesktop builds --count=<number>` will show the last `<number>` builds.
   - `todesktop builds --format=json` will output build data in JSON format.
-  - Append `--config=<path.to.config.file>` to use a different configuration file.
-  - Append `--exit` to disable dynamic pagination and exit the process once the build data has been displayed.
+  - Append `--config=<path.to.config.file>` to use a different configuration
+    file.
+  - Append `--exit` to disable dynamic pagination and exit the process once the
+    build data has been displayed.
 - `todesktop logout`. Logs you out.
-- `todesktop smoke-test` Check whether the build works and can be successfully updated.
+- `todesktop smoke-test` Check whether the build works and can be successfully
+  updated.
   - Use `todesktop smoke-test <id>` to test a specific build by ID.
   - `todesktop smoke-test --latest` will test the latest build.
-  - Append `--config=<path.to.config.file>` to use a different configuration file.
+  - Append `--config=<path.to.config.file>` to use a different configuration
+    file.
 - `todesktop whoami`. Prints the email of the account you're signed into.
 - `todesktop --help`. Shows the help documentation.
 - `todesktop --version`. Shows the current version of the CLI.
 
 ## Automating your builds (CI)
 
-You may want to automate builds with your Continuous Integration (CI) provider. To achieve this, simply set up environment variables for `TODESKTOP_ACCESS_TOKEN` and `TODESKTOP_EMAIL` within your CI project.
+You may want to automate builds with your Continuous Integration (CI) provider.
+To achieve this, simply set up environment variables for
+`TODESKTOP_ACCESS_TOKEN` and `TODESKTOP_EMAIL` within your CI project.
 
 ```
 TODESKTOP_ACCESS_TOKEN=accessToken
@@ -241,25 +272,33 @@ The webhook receives a POST request with the following JSON body:
 
 ## Project configuration (todesktop.json, todesktop.js, or todesktop.ts)
 
-This describes all of the possible configuration options in your `todesktop.json`, `todesktop.js`, or `todesktop.ts` file.
+This describes all of the possible configuration options in your
+`todesktop.json`, `todesktop.js`, or `todesktop.ts` file.
 
 You can use:
 
 - A standard JSON file (`todesktop.json`) for static configuration
-- A JavaScript file (`todesktop.js`) that exports a configuration object for dynamic configuration
-- A TypeScript file (`todesktop.ts`) that exports a configuration object with full type checking and IntelliSense
+- A JavaScript file (`todesktop.js`) that exports a configuration object for
+  dynamic configuration
+- A TypeScript file (`todesktop.ts`) that exports a configuration object with
+  full type checking and IntelliSense
 
-Using `.js` or `.ts` files allows for dynamic configuration, such as setting values based on environment variables or computing paths.
+Using `.js` or `.ts` files allows for dynamic configuration, such as setting
+values based on environment variables or computing paths.
 
 **Note:**
 
-- Schema validation and IntelliSense for `.json` files are available through the JSON schema (described under [Installation](#installation))
-- TypeScript files (`.ts`) provide full type checking and IntelliSense when using the exported `Schema` type from `@todesktop/cli`
-- TypeScript compilation requires a local installation of TypeScript in your project
+- Schema validation and IntelliSense for `.json` files are available through the
+  JSON schema (described under [Installation](#installation))
+- TypeScript files (`.ts`) provide full type checking and IntelliSense when
+  using the exported `Schema` type from `@todesktop/cli`
+- TypeScript compilation requires a local installation of TypeScript in your
+  project
 
 To avoid confusion, the following terms will be used throughout this file:
 
-- "Project root": this is the parent directory of your `todesktop.json`, `todesktop.js`, or `todesktop.ts`.
+- "Project root": this is the parent directory of your `todesktop.json`,
+  `todesktop.js`, or `todesktop.ts`.
 
 ### `$schema` - (optional) string
 
@@ -292,7 +331,10 @@ Example: `["dist/**", "!static/**"]`
 
 This option allows you to decide which files get uploaded to be built on the ToDesktop servers. By default, all files in your app path are included in your app, except for `node_modules` and `.git`. Dependencies are installed on our build servers as there could be platform-specific postinstall steps.
 
-If you wish to include files for the build process but exclude them in the distribution version of your app then you should use the [`filesForDistribution`](#filesForDistribution---optional-array-of-glob-patterns) property
+If you wish to include files for the build process but exclude them in the
+distribution version of your app then you should use the
+[`filesForDistribution`](#filesForDistribution---optional-array-of-glob-patterns)
+property
 
 The files must be within your [`appPath`](#apppath---optional-string).
 
@@ -308,15 +350,20 @@ The following are always included if they exist:
 
 - Asterisk (`*`) — matches everything except slashes (path separators).
 - A double star or globstar (`**`) — matches zero or more directories.
-- Question mark (`?`) – matches any single character except slashes (path separators).
-- Exclamation mark (`!`) — a glob that starts with an exclamation mark will result in any matched files being excluded.
+- Question mark (`?`) – matches any single character except slashes (path
+  separators).
+- Exclamation mark (`!`) — a glob that starts with an exclamation mark will
+  result in any matched files being excluded.
 
 Examples:
 
-- `src/**/*.js` — matches all files in the src directory (any level of nesting) that have the `.js` extension.
-- `src/*.??` — matches all files in the src directory (only first level of nesting) that have a two-character extension.
+- `src/**/*.js` — matches all files in the src directory (any level of nesting)
+  that have the `.js` extension.
+- `src/*.??` — matches all files in the src directory (only first level of
+  nesting) that have a two-character extension.
 
-We use the [fast-glob](https://www.npmjs.com/package/fast-glob) library under the hood.
+We use the [fast-glob](https://www.npmjs.com/package/fast-glob) library under
+the hood.
 
 ### `appId` - (optional) string
 
@@ -326,7 +373,8 @@ Example: `com.microsoft.word`
 
 Your application ID. Omit this unless you know what you're doing. It's used as the [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as the [Application User Model ID](<https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx>) for Windows.
 
-WARNING: if you have deployed an application with ToDesktop and would like to change this ID, talk to us first.
+WARNING: if you have deployed an application with ToDesktop and would like to
+change this ID, talk to us first.
 
 ### `appPath` - (optional) string
 
@@ -336,13 +384,17 @@ Example: `./dist`
 
 This is the path to your Electron application directory. Omit this unless your project setup is complicated. This is the directory that the CLI uploads.
 
-The path can be absolute or a relative path from the project root. The directory it points to must be a valid Electron application directory; i.e.:
+The path can be absolute or a relative path from the project root. The directory
+it points to must be a valid Electron application directory; i.e.:
 
 - It could be ran with the `electron` command; i.e. `npx electron {{appPath}}`.
 - It needs to contain a valid `package.json`.
-- The `package.json` must either have a `main` property pointing to a file in the directory or there must be an `index.js` at the root of the directory.
+- The `package.json` must either have a `main` property pointing to a file in
+  the directory or there must be an `index.js` at the root of the directory.
 
-Side note: if your `package.json` contains a `postinstall` script which references scripts, these must be accessible within the `appPath` directory as only the `appPath` is uploaded to our servers.
+Side note: if your `package.json` contains a `postinstall` script which
+references scripts, these must be accessible within the `appPath` directory as
+only the `appPath` is uploaded to our servers.
 
 ### `bundleWorkspacePackages` - (optional) object
 
@@ -401,7 +453,8 @@ Default: `["**/*.node"]`
 
 This option allows you to decide which files get unpacked from the asar archive. By default we unpack all native `*.node` files.
 
-If you want to unpack only files that are required to be unpacked, you can set this property to `false`.
+If you want to unpack only files that are required to be unpacked, you can set
+this property to `false`.
 
 You can also specify a list of glob patterns to unpack.
 
@@ -425,13 +478,15 @@ Options for customizing the macOS DMG (disk image) installer.
 
 #### `dmg.background` - (optional) string
 
-Default: `undefined` (if `undefined` then we use [this template](https://i.imgur.com/PUQIhvv.png)).
+Default: `undefined` (if `undefined` then we
+use [this template](https://i.imgur.com/PUQIhvv.png)).
 
 Example: `./mac-dmg-background.tiff`
 
 The path to the DMG installer's background image. It must be a `.tiff` file. The resolution of this file determines the resolution of the installer window. Typically, backgrounds are 540x380.
 
-You can generate a retina tiff background from png files using the following command:
+You can generate a retina tiff background from png files using the following
+command:
 
 ```sh
 tiffutil -cathidpicheck background.png background@2x.png -out background.tiff
@@ -465,8 +520,10 @@ The title of the produced DMG, which will be shown when mounted (volume name). M
 
 Customize icon locations. The x and y coordinates refer to the position of the center of the icon (at 1x scale), and do not take the label into account.
 
-- `x` number - The device-independent pixel offset from the left of the window to the center of the icon.
-- `y` number - The device-independent pixel offset from the top of the window to the center of the icon.
+- `x` number -
+  The device-independent pixel offset from the left of the window to the center of the icon.
+- `y` number -
+  The device-independent pixel offset from the top of the window to the center of the icon.
 
 ```
 [
@@ -489,8 +546,10 @@ The DMG windows position and size. In most cases, you will only want to specify
 
 - `x` number - The X position relative to left of the screen.
 - `y` number - The Y position relative to top of the screen.
-- `width` number - The width. Defaults to background image width or 540.
-- `height` number - The height. Defaults to background image height or 380.
+- `width` number -
+  The width. Defaults to background image width or 540.
+- `height` number -
+  The height. Defaults to background image height or 380.
 
 ```
 {
@@ -505,9 +564,13 @@ Default: `null`.
 
 Example: `./todesktop.base.json` or `./todesktop.base.js`.
 
-This is the path to a base configuration file (`.json` or `.js`). This is especially useful for configuration sharing between different environments (e.g., staging and production). The base configuration file can be a relative path from the project root or an absolute path.
+This is the path to a base configuration file (`.json` or `.js`). This is
+especially useful for configuration sharing between different environments
+(e.g., staging and production). The base configuration file can be a relative
+path from the project root or an absolute path.
 
-For more information about how to create a staging version of your app see: [How do I create a staging version of my app?](#how-do-i-create-a-staging-version-of-my-app).
+For more information about how to create a staging version of your app see:
+[How do I create a staging version of my app?](#how-do-i-create-a-staging-version-of-my-app).
 
 ### `extraContentFiles` - (optional) array of objects
 
@@ -515,9 +578,13 @@ Default: `[]`
 
 This option allows you specify files to be copied into the application's content directory (`Contents` for MacOS, root directory for Linux and Windows).
 
-Each item in the array must be an object, containing a `from` property which is a path to a file or directory. The path can be absolute or a relative path from the project root. The files specified must be inside your project root. A directory's contents are copied, not the directory itself (see example below).
+Each item in the array must be an object, containing a `from` property which is
+a path to a file or directory. The path can be absolute or a relative path from
+the project root. The files specified must be inside your project root. A
+directory's contents are copied, not the directory itself (see example below).
 
-The `to` property is optional. Use it to specify a directory inside the content directory to copy the file to.
+The `to` property is optional. Use it to specify a directory inside the content
+directory to copy the file to.
 
 Example:
 
@@ -529,7 +596,11 @@ Example:
 ]
 ```
 
-In the example above, `image.png` would be copied to the root of the content directory, whereas `anotherImage.png` would be copied to an `images` directory at the root of the content directory. The contents of the `./static` directory would be copied to `assets` in the content directory (i.e. `./static/example.txt` would be copied to `assets/example.txt`).
+In the example above, `image.png` would be copied to the root of the content
+directory, whereas `anotherImage.png` would be copied to an `images` directory
+at the root of the content directory. The contents of the `./static` directory
+would be copied to `assets` in the content directory (i.e.
+`./static/example.txt` would be copied to `assets/example.txt`).
 
 ### `electronMirror` - (optional) string
 
@@ -578,14 +649,21 @@ Example:
 ]
 ```
 
-- `ext` String | String[] - The extension (minus the leading period). e.g. png.
-- `name` String -  The name. e.g. PNG. Defaults to value of `ext`.
-- `description` String - windows-only. The description.
+- `ext` String | String[] -
+  The extension (minus the leading period). e.g. png.
+- `name` String - 
+  The name. e.g. PNG. Defaults to value of `ext`.
+- `description` String -
+  windows-only. The description.
 - `icon` String - macOS and windows. Icon file name without extension. It points to ico file for Windows and icns for macOS. For example, if the `icon` value is `"icons/py"` then it will look for both `"icons/py.ico"` and `"icons/py.icns"` in your project directory.
-- `mimeType` String - linux-only. The mime-type.
-- `role` = `Default: `Editor`` String - macOS-only. The app's role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.
-- `isPackage` Boolean - macOS-only. Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.
-- `rank` = `Default: `Default`` String - macOS-only. Determines how Launch Services ranks this app among the apps that declare themselves editors or viewers of files of this type. The possible values are: `Owner` (this app is the primary creator of files of this type), `Default` (this app is an opener of files of this type; this value is also used if no rank is specified), `Alternate` (this app is a secondary viewer of files of this type), and `None` (this app is never selected to open files of this type, but it accepts drops of files of this type).
+- `mimeType` String -
+  linux-only. The mime-type.
+- `role` = `Default: `Editor`` String -
+  macOS-only. The app's role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.
+- `isPackage` Boolean -
+  macOS-only. Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.
+- `rank` = `Default: `Default`` String -
+  macOS-only. Determines how Launch Services ranks this app among the apps that declare themselves editors or viewers of files of this type. The possible values are: `Owner` (this app is the primary creator of files of this type), `Default` (this app is an opener of files of this type; this value is also used if no rank is specified), `Alternate` (this app is a secondary viewer of files of this type), and `None` (this app is never selected to open files of this type, but it accepts drops of files of this type).
 
 ### `filesForDistribution` - (optional) array of glob patterns
 
@@ -593,7 +671,8 @@ Example: `["!**/node_modules/realm/android/**", "!**/design/**"]`
 
 This option allows you to explicitly exclude or include certain files in the packaged version of your app. These files are filtered _after_ the build step which happens on the ToDesktop servers.
 
-This is often useful for excluding large files which are installed during the build step but are not needed at runtime by your applcation.
+This is often useful for excluding large files which are installed during the
+build step but are not needed at runtime by your applcation.
 
 The following are always excluded if they exist:
 
@@ -615,7 +694,10 @@ Example: `./appIcon.png`
 
 The path to your application's desktop icon. It must be an ICNS or PNG.
 
-Note: to ensure the icon is never missing (e.g. this happens sometimes in Ubuntu), set the [`icon` option](https://www.electronjs.org/docs/api/browser-window#new-browserwindowoptions) when creating your `BrowserWindow`s.
+Note: to ensure the icon is never missing (e.g. this happens sometimes in
+Ubuntu), set the
+[`icon` option](https://www.electronjs.org/docs/api/browser-window#new-browserwindowoptions)
+when creating your `BrowserWindow`s.
 
 ### `id` - string
 
@@ -649,7 +731,10 @@ The path to your application's Linux desktop icon. It must be an ICNS or PNG.
 
 Default: The root [`icon`](#icon---string) is used.
 
-Note: to ensure the icon is never missing (e.g. this happens sometimes in Ubuntu), set the [`icon` option](https://www.electronjs.org/docs/api/browser-window#new-browserwindowoptions) when creating your `BrowserWindow`s.
+Note: to ensure the icon is never missing (e.g. this happens sometimes in
+Ubuntu), set the
+[`icon` option](https://www.electronjs.org/docs/api/browser-window#new-browserwindowoptions)
+when creating your `BrowserWindow`s.
 
 #### `linux.imageVersion` - (optional) string
 
@@ -661,7 +746,10 @@ The version of the Linux image that ToDesktop should use to build your app.
 
 Linux Changelog:
 
-- `0.1.0`: Updated g++ → g++10, gcc → gcc10. WARNING: This compiler has been updated to a newer version that is not compatible with older versions of Linux like Ubuntu 20.04. You should probably only use this version if you know what you're doing.
+- `0.1.0`: Updated g++ → g++10, gcc → gcc10. WARNING: This compiler has been
+  updated to a newer version that is not compatible with older versions of Linux
+  like Ubuntu 20.04. You should probably only use this version if you know what
+  you're doing.
 - `0.0.11`: Updated git 2.25.1 → 2.47.1 node 18.18.2 → 18.20.5
 
 ### `linux.noSandbox` - (optional) boolean
@@ -670,7 +758,8 @@ Default: `true`
 
 This option allows you to configure whether your app should run in a sandboxed environment.
 
-We default this to `true` for compatibility reasons because some Linux distributions do not support unprivileged user namespaces.
+We default this to `true` for compatibility reasons because some Linux
+distributions do not support unprivileged user namespaces.
 
 ### `includeSubNodeModules` - (optional) boolean
 
@@ -702,9 +791,11 @@ Example: `public.app-category.productivity`
 
 The application category type, as shown in the Finder via _View -> Arrange by Application Category_ when viewing the Applications directory.
 
-For example, `public.app-category.developer-tools` will set the application category to "Developer Tools".
+For example, `public.app-category.developer-tools` will set the application
+category to "Developer Tools".
 
-Valid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).
+Valid values are listed in
+[Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).
 
 #### `mac.entitlements` - (optional) string
 
@@ -825,7 +916,9 @@ Example:
 }
 ```
 
-You can also set the version of a `dependency` (or `devDependency`), such as Electron Builder, to `null`. This will remove Electron Builder from the effective `package.json` that ToDesktop will use.
+You can also set the version of a `dependency` (or `devDependency`), such as
+Electron Builder, to `null`. This will remove Electron Builder from the
+effective `package.json` that ToDesktop will use.
 
 ```js
 "packageJson": {
@@ -956,7 +1049,8 @@ Example: `[ "default", { "browser-sandbox": { "interface": "browser-support", "a
 
 The list of [plugs](https://snapcraft.io/docs/reference/interfaces). If list contains `default`, it will be replaced with the default list, so, `["default", "foo"]` can be used to add a custom plug `foo` in addition to the default list.
 
-Additional attributes can be specified using object instead of just name of plug:
+Additional attributes can be specified using object instead of just name of
+plug:
 
 ```json
 [
@@ -1102,7 +1196,10 @@ Example:
 }
 ```
 
-When a build is performed for a specific platform (e.g., Windows), the ToDesktop CLI will first take the global configuration value for a field. If that same field is defined within `platformOverrides.windows`, the platform-specific value will be used instead.
+When a build is performed for a specific platform (e.g., Windows), the ToDesktop
+CLI will first take the global configuration value for a field. If that same
+field is defined within `platformOverrides.windows`, the platform-specific value
+will be used instead.
 
 In the example above:
 
@@ -1115,23 +1212,32 @@ In the example above:
 - For Linux builds:
   - `appId` will remain `myapp.global.id` (as it's not overridden for Linux).
   - `copyright` will be `Copyright © My Company (Linux)`.
-- For any other properties not specified in the platform override, the global value will be used.
+- For any other properties not specified in the platform override, the global
+  value will be used.
 
-This is particularly useful for settings like `appId`, `copyright`, or platform-specific configurations within the `windows`, `mac`, or `linux` blocks (e.g., `mac.category`, `windows.icon`).
+This is particularly useful for settings like `appId`, `copyright`, or
+platform-specific configurations within the `windows`, `mac`, or `linux` blocks
+(e.g., `mac.category`, `windows.icon`).
 
 The fields that **cannot** be overridden using `platformOverrides` are:
 
 - `id` (the ToDesktop application ID)
-- `icon` (the main application icon, though platform-specific icons like `windows.icon` or `mac.icon` _can_ be overridden)
+- `icon` (the main application icon, though platform-specific icons like
+  `windows.icon` or `mac.icon` _can_ be overridden)
 - `schemaVersion`
 - `extends`
 - `platformOverrides` itself
 
 ## Build lifecycle hooks (package.json scripts)
 
-Sometimes you want to do something before or during the build process. For example, you might want to run a script before the build starts, or you might want to run a script after the files have been packaged. Our lifecycle hooks provide a way to do this.
+Sometimes you want to do something before or during the build process. For
+example, you might want to run a script before the build starts, or you might
+want to run a script after the files have been packaged. Our lifecycle hooks
+provide a way to do this.
 
-To specify a script, add a `scripts` property to your `package.json` file. The key is the name of the script (prefixed by `todesktop:`), and the value is the path to the script.
+To specify a script, add a `scripts` property to your `package.json` file. The
+key is the name of the script (prefixed by `todesktop:`), and the value is the
+path to the script.
 
 ```json
 {
@@ -1160,7 +1266,8 @@ module.exports = async ({ pkgJsonPath, pkgJson, appDir, hookName }) => {
 
 Example: `./scripts/beforeBuild.js`.
 
-The path to a script that will run before dependencies are rebuilt for target architectures.
+The path to a script that will run before dependencies are rebuilt for target
+architectures.
 
 Example script:
 
@@ -1175,10 +1282,10 @@ module.exports = async ({
   arch,
   hookName,
 }) => {
-  if (arch === "arm64") {
-    process.env.VARIABLE = "value";
+  if (arch === 'arm64') {
+    process.env.VARIABLE = 'value';
   } else {
-    process.env.VARIABLE = "alternative-value";
+    process.env.VARIABLE = 'alternative-value';
   }
 };
 ```
@@ -1192,11 +1299,11 @@ The path to a script that will be run before the build starts.
 Example script:
 
 ```js
-const { writeFile } = require("fs/promises");
+const { writeFile } = require('fs/promises');
 
 // Delete `internal` dependency from package.json
 module.exports = async ({ pkgJsonPath, pkgJson, appDir, hookName }) => {
-  delete pkgJson.dependencies["internal"];
+  delete pkgJson.dependencies['internal'];
   await writeFile(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
 };
 ```
@@ -1205,9 +1312,12 @@ module.exports = async ({ pkgJsonPath, pkgJson, appDir, hookName }) => {
 
 Example: `./scripts/afterPack.js`.
 
-The path to a script that will be run after the app has been packed (but _before_ it has been transformed into a distributable installer format and signed).
+The path to a script that will be run after the app has been packed (but
+_before_ it has been transformed into a distributable installer format and
+signed).
 
-The `afterPack` function also has the following arguments added to it's signature:
+The `afterPack` function also has the following arguments added to it's
+signature:
 
 - appPkgName - string - the name of the app package
 - appId - string - the app id
@@ -1215,21 +1325,22 @@ The `afterPack` function also has the following arguments added to it's signatur
 - outDir - string - the path to the output directory
 - appOutDir - string - the path to the app output directory
 - packager - object - the packager object
-- arch - number - the architecture of the app. `ia32 = 0`, `x64 = 1`, `armv7l = 2`, `arm64 = 3`, `universal = 4`.
+- arch - number - the architecture of the app. `ia32 = 0`, `x64 = 1`,
+  `armv7l = 2`, `arm64 = 3`, `universal = 4`.
 
 Example script:
 
 ```js
-const { writeFile } = require("fs/promises");
+const { writeFile } = require('fs/promises');
 
 // Add a copyright file inside of the app directory on Mac only
 module.exports = async ({ appOutDir, packager }) => {
-  if (os.platform() === "darwin") {
+  if (os.platform() === 'darwin') {
     const appName = packager.appInfo.productFilename;
     const appPath = path.join(`${appOutDir}`, `${appName}.app`);
     await writeFile(
-      path.join(appPath, "copyright.txt"),
-      `Copyright © ${new Date().getFullYear()} ${appName}`
+      path.join(appPath, 'copyright.txt'),
+      `Copyright © ${new Date().getFullYear()} ${appName}`,
     );
   }
 };
@@ -1237,59 +1348,86 @@ module.exports = async ({ appOutDir, packager }) => {
 
 ## App package.json requirements
 
-- Electron must be in your `devDependencies` and it must be a fixed version. I.e. it doesn't start with `^` or `~`.
-- You must set the [`author` property](https://docs.npmjs.com/files/package.json#people-fields-author-contributors).
+- Electron must be in your `devDependencies` and it must be a fixed version.
+  I.e. it doesn't start with `^` or `~`.
+- You must set the
+  [`author` property](https://docs.npmjs.com/files/package.json#people-fields-author-contributors).
 
 ### Recommendations for app package.json
 
-- You should set the `productName` property. Otherwise, your app name will default to the value of the `name` property.
+- You should set the `productName` property. Otherwise, your app name will
+  default to the value of the `name` property.
 
 ## FAQs
 
 ### One of my dependencies is a private package. How do I safely use it with ToDesktop CLI
 
-ToDesktop CLI is similar to Continuous Integration service so you can use the guide from here: https://docs.npmjs.com/using-private-packages-in-a-ci-cd-workflow/
+ToDesktop CLI is similar to Continuous Integration service so you can use the
+guide from here:
+https://docs.npmjs.com/using-private-packages-in-a-ci-cd-workflow/
 
 To summarize:
 
 1. Create a token using npm: `npm token create --read-only`.
 2. In ToDesktop's web UI go to Settings -> Build and Deploy.
-3. Enter an environment variable key of `NPM_TOKEN` and value should be the token entered above.
-4. Create an `.npmrc` file in the root of your project with the following contents:
+3. Enter an environment variable key of `NPM_TOKEN` and value should be the
+   token entered above.
+4. Create an `.npmrc` file in the root of your project with the following
+   contents:
 
 ```
 //registry.npmjs.org/:_authToken=${NPM_TOKEN}
 ```
 
-Note: **Do not put a token in this file**. You are specifying a literal value of `${NPM_TOKEN}`. NPM will replace the value for you. 5. Add `.npmrc` to your `appFiles` array `[".npmrc"]` in `todesktop.json`.
+Note: **Do not put a token in this file**. You are specifying a literal value of
+`${NPM_TOKEN}`. NPM will replace the value for you. 5. Add `.npmrc` to your
+`appFiles` array `[".npmrc"]` in `todesktop.json`.
 
 ### How can I specify a specific yarnVersion for use with my app?
 
-By default, ToDesktop uses version `1.x.x` of `Yarn` if a `yarn.lock` file is present in your project. You can override this by creating a `.yarnrc.yml` file in your project directory and specifying the `yarnPath` property to point to your specified version of yarn:
+By default, ToDesktop uses version `1.x.x` of `Yarn` if a `yarn.lock` file is
+present in your project. You can override this by creating a `.yarnrc.yml` file
+in your project directory and specifying the `yarnPath` property to point to
+your specified version of yarn:
 
 ```yml
 yarnPath: .yarn/releases/yarn-3.1.1.cjs
 ```
 
-This can be done automatically by running `yarn set version x.x.x` from within your project directory. This will create a `.yarnrc.yml` file and a corresponding `.yarn/releases/yarn-x.x.x.cjs` that the `yarnPath` property points to. This will also add a `packageManager` field in your `package.json` with a value of `yarn@x.x.x`
+This can be done automatically by running `yarn set version x.x.x` from within
+your project directory. This will create a `.yarnrc.yml` file and a
+corresponding `.yarn/releases/yarn-x.x.x.cjs` that the `yarnPath` property
+points to. This will also add a `packageManager` field in your `package.json`
+with a value of `yarn@x.x.x`
 
-It's important to ensure that the `.yarn` folder is included in your build. If you had previously changed your `todesktop.json`'s [`appFiles`](#appfiles---optional-array-of-glob-patterns) property from its default glob implementation of `**`, then please ensure that it includes the `.yarn` directory:
+It's important to ensure that the `.yarn` folder is included in your build. If
+you had previously changed your `todesktop.json`'s
+[`appFiles`](#appfiles---optional-array-of-glob-patterns) property from its
+default glob implementation of `**`, then please ensure that it includes the
+`.yarn` directory:
 
 Example: `[".yarn/**", ".yarnrc.yml", "...include your other changes here..."]`
 
-You will want to exclude the `.yarn` directory in the distribution version of your app. You can use the [`filesForDistribution`](#filesForDistribution---optional-array-of-glob-patterns) property to achieve this:
+You will want to exclude the `.yarn` directory in the distribution version of
+your app. You can use the
+[`filesForDistribution`](#filesForDistribution---optional-array-of-glob-patterns)
+property to achieve this:
 
 Example: `["!.yarn/**", "!.yarnrc.yml"]`
 
 ### How do I create a staging version of my app?
 
-ToDesktop CLI supports the concept of a staging version of your app. This is useful if you want to test your app before releasing it to the public. To create a staging version of your app, you need to do the following:
+ToDesktop CLI supports the concept of a staging version of your app. This is
+useful if you want to test your app before releasing it to the public. To create
+a staging version of your app, you need to do the following:
 
 1. Create a new app in ToDesktop's web UI.
 
-2. Create a new configuration file, for example `todesktop.staging.json` or `todesktop.staging.js`.
+2. Create a new configuration file, for example `todesktop.staging.json` or
+   `todesktop.staging.js`.
 
-3. Add the following to your staging configuration file (e.g., `todesktop.staging.json`):
+3. Add the following to your staging configuration file (e.g.,
+   `todesktop.staging.json`):
 
 ```json
 {
@@ -1317,22 +1455,29 @@ ToDesktop CLI supports the concept of a staging version of your app. This is use
 }
 ```
 
-Now you can run `npm run todesktop-build` to build the production app. Or you can run `npm run todesktop-staging-build` to build the staging app.
+Now you can run `npm run todesktop-build` to build the production app. Or you
+can run `npm run todesktop-staging-build` to build the staging app.
 
 ### I want ToDesktop to compile my typescript/react/whatever on ToDesktop Servers
 
-No problem, this can be achieved with a [`postInstall`](https://docs.npmjs.com/cli/v9/using-npm/scripts) script in combination with ToDesktop's `TODESKTOP_CI` and `TODESKTOP_INITIAL_INSTALL_PHASE` environment variables.
+No problem, this can be achieved with a
+[`postInstall`](https://docs.npmjs.com/cli/v9/using-npm/scripts) script in
+combination with ToDesktop's `TODESKTOP_CI` and
+`TODESKTOP_INITIAL_INSTALL_PHASE` environment variables.
 
 | Name                              | Description                                                                           |
 | --------------------------------- | ------------------------------------------------------------------------------------- |
 | `TODESKTOP_CI`                    | Set to `true` when running on ToDesktop build servers                                 |
 | `TODESKTOP_INITIAL_INSTALL_PHASE` | Set to `true` when running the first npm/yarn/pnpm install on ToDesktop build servers |
 
-First, let's create a file called `todesktop-postinstall.js` or something similar in the root of your app (alongside `pkckage.json`). This file is going to run a script to compile typescript after your dependencies have been installed. It could look something like this
+First, let's create a file called `todesktop-postinstall.js` or something
+similar in the root of your app (alongside `pkckage.json`). This file is going
+to run a script to compile typescript after your dependencies have been
+installed. It could look something like this
 
 ```js
-const { exec } = require("child_process");
-const { promisify } = require("util");
+const { exec } = require('child_process');
+const { promisify } = require('util');
 const execAsync = promisify(exec);
 
 async function postInstall() {
@@ -1340,12 +1485,12 @@ async function postInstall() {
     process.env.TODESKTOP_CI && process.env.TODESKTOP_INITIAL_INSTALL_PHASE;
 
   if (firstInstallOnToDesktopServers) {
-    console.log("➔ Building typescript on ToDesktop servers");
-    await execAsync("npm run build", {
-      stdio: "inherit",
+    console.log('➔ Building typescript on ToDesktop servers');
+    await execAsync('npm run build', {
+      stdio: 'inherit',
     });
   } else {
-    console.log("➔ Not on ToDesktop servers... Do nothing.");
+    console.log('➔ Not on ToDesktop servers... Do nothing.');
   }
 }
 
@@ -1367,7 +1512,8 @@ Next, add the following to your `package.json`:
 }
 ```
 
-Now, when we build your app on ToDesktop servers, it will also run your custom `build` script after all dependencies have been installed.
+Now, when we build your app on ToDesktop servers, it will also run your custom
+`build` script after all dependencies have been installed.
 
 ## Changelog
 
@@ -1380,11 +1526,13 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.17.1
 
-- Fix: `windows.icon` now accepts `.ico` files without triggering schema validation errors.
+- Fix: `windows.icon` now accepts `.ico` files without triggering schema
+  validation errors.
 
 ### v1.17.0
 
-- Add support for `bundleWorkspacePackages` in config to specify whether the CLI bundles workspace packages alongside the app upload.
+- Add support for `bundleWorkspacePackages` in config to specify whether the CLI
+  bundles workspace packages alongside the app upload.
 
 ### v1.15.2
 
@@ -1396,9 +1544,11 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.15.0
 
-- Add support for `todesktop.ts` configuration file with full TypeScript type checking and IntelliSense.
+- Add support for `todesktop.ts` configuration file with full TypeScript type
+  checking and IntelliSense.
 - Export `Schema` type from `@todesktop/cli` for TypeScript configuration files.
-- TypeScript compilation uses user's local TypeScript installation (no production dependencies added).
+- TypeScript compilation uses user's local TypeScript installation (no
+  production dependencies added).
 
 ### v1.14.0
 
@@ -1408,8 +1558,10 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.13.0
 
-- Add support for `platformOverrides` in config to specify platform-specific overrides for app configuration
-- Add support for `$schema` in config to enable JSON schema validation and IDE intellisense
+- Add support for `platformOverrides` in config to specify platform-specific
+  overrides for app configuration
+- Add support for `$schema` in config to enable JSON schema validation and IDE
+  intellisense
 
 ### v1.12.5
 
@@ -1417,11 +1569,13 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.12.3
 
-- Allow `catalog:` protocol (used by PNPM) for electron dependency version in `package.json`.
+- Allow `catalog:` protocol (used by PNPM) for electron dependency version in
+  `package.json`.
 
 ### v1.12.2
 
-- Fix: Update `appFiles` to not error when no `*.js` files are found (but `*.ts` files are present)
+- Fix: Update `appFiles` to not error when no `*.js` files are found (but `*.ts`
+  files are present)
 
 ### v1.12.1
 
@@ -1429,7 +1583,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.12.0
 
-- Add support for custom `updateUrlBase` in config to specify a custom auto-update URL
+- Add support for custom `updateUrlBase` in config to specify a custom
+  auto-update URL
 
 ### v1.11.5
 
@@ -1445,15 +1600,19 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.11.2
 
-- Stop erroring in cases where `appId` is not defined in an extended `todesktop.json`.
+- Stop erroring in cases where `appId` is not defined in an extended
+  `todesktop.json`.
 
 ### v1.11.1
 
-- You can now specify `linux.imageVersion` to explicitly set the version of the Linux image that ToDesktop should use to build your app.
+- You can now specify `linux.imageVersion` to explicitly set the version of the
+  Linux image that ToDesktop should use to build your app.
 
 ### v1.11.0
 
-- Add additional `id` and `appId` validation when extending another `todesktop.json` file. Can be disabled with the `--ignore-extends-errors` flag.
+- Add additional `id` and `appId` validation when extending another
+  `todesktop.json` file. Can be disabled with the `--ignore-extends-errors`
+  flag.
 
 ### v1.10.5
 
@@ -1466,7 +1625,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.10.3
 
-- Update Readme to include instructions on `todesktop.json` VSCode/Cursor validation
+- Update Readme to include instructions on `todesktop.json` VSCode/Cursor
+  validation
 
 ### v1.10.2
 
@@ -1493,7 +1653,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 ### v1.9.6
 
 - Add support for `mas.x64ArchFiles` in config.
-- Fix: Build is only recognised as ongoing if it was created in the last 24 hours.
+- Fix: Build is only recognised as ongoing if it was created in the last 24
+  hours.
 - Add support for `mac.entitlementsInherit` in config.
 
 ### v1.9.4
@@ -1504,7 +1665,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 - Add support for `mas.entitlements` in config.
 - Add support for `mas.entitlementsInherit` in config.
-- Add support for `mas.provisioningProfile` in config. Removed `mac.provisioningProfile` as a result.
+- Add support for `mas.provisioningProfile` in config. Removed
+  `mac.provisioningProfile` as a result.
 
 ### v1.9.2
 
@@ -1518,11 +1680,13 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.9.0
 
-- You can now specify `@electron/rebuild` as a custom `rebuildLibrary` in your configuration file.
+- You can now specify `@electron/rebuild` as a custom `rebuildLibrary` in your
+  configuration file.
 
 ### v1.8.1
 
-- Revert support for `yarnVersion` in config. Instead use `.yarnrc.yml` file to specify yarn version.
+- Revert support for `yarnVersion` in config. Instead use `.yarnrc.yml` file to
+  specify yarn version.
 
 ### v1.8.0
 
@@ -1546,7 +1710,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.7.4
 
-- Fix: Linux/Windows platform links no longer have mac/zip/[arch] added to the end of the download URL
+- Fix: Linux/Windows platform links no longer have mac/zip/[arch] added to the
+  end of the download URL
 
 ### v1.7.3
 
@@ -1554,7 +1719,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.7.1
 
-- Add support for specifying custom `appBuilderLibVersion` in the configuration file
+- Add support for specifying custom `appBuilderLibVersion` in the configuration
+  file
 - Show suggestion to run a Smoke Test when releasing an untested build
 
 ### v1.7.0
@@ -1563,7 +1729,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.6.3
 
-- Add support for specifying custom `windows.nsisCustomBinary` in the configuration file
+- Add support for specifying custom `windows.nsisCustomBinary` in the
+  configuration file
 
 ### v1.6.2
 
@@ -1609,7 +1776,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.2.1
 
-- Fix: When the build is finished the download link is now an Apple Silicon link if you are on an Apple Silicon Mac.
+- Fix: When the build is finished the download link is now an Apple Silicon link
+  if you are on an Apple Silicon Mac.
 
 ### v1.2.0