@todesktop/cli 1.15.2 → 1.18.0

package/README.md

@@ -21,7 +21,7 @@ For more information, visit the project [landing page](https://www.todesktop.com
 Install the package with:
 
 ```sh
-npm install --location=global @todesktop/cli
+npm install -g @todesktop/cli
 # or
 yarn global add @todesktop/cli
 ```
@@ -42,7 +42,7 @@ Create a `todesktop.json` file in the root of your Electron project.
 
 ```json
 {
-  "$schema": "https://unpkg.com/@todesktop/cli@1.15.1/schemas/schema.json",
+  "$schema": "https://unpkg.com/@todesktop/cli@1.18.0/schemas/schema.json",
   "schemaVersion": 1
   "id": "your-todesktop-id",
   "icon": "./desktop-icon.png",
@@ -272,7 +272,7 @@ To enable JSON validation and IntelliSense for your `todesktop.json` file in com
 - For example, if using a hosted version of the schema:
   ```json
   {
-    "$schema": "https://unpkg.com/@todesktop/cli@1.15.1/schemas/schema.json",
+    "$schema": "https://unpkg.com/@todesktop/cli@1.18.0/schemas/schema.json",
     "id": "your-todesktop-id"
   }
   ```
@@ -344,6 +344,43 @@ The path can be absolute or a relative path from the project root. 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.
 
+### `bundleWorkspacePackages` - (optional) object
+
+- Default: `{"enabled":false}`
+
+Useful when your application is a monorepo (e.g. pnpm workspaces). You can configure whether the CLI bundles workspace packages alongside the app upload. When enabled, workspace dependencies referenced via `workspace:` or local `file:` specifiers are bundled with your application upload and dependency ranges are rewritten to `file:` paths so they install deterministically on the build servers.
+
+- Example: `{"enabled":true}`
+
+### `bytenode` - (optional) object
+
+Default: `{"enabled":false}`
+
+Compile selected source files to .jsc using Bytenode during the build. Provide glob patterns relative to your appPath.
+
+> Experimental: This option may change or be removed in a future release.
+
+#### `bytenode.enabled` - (optional) boolean
+
+Default: `false`
+
+Enable Bytenode compilation.
+
+#### `bytenode.files` - (required when enabled) array of glob patterns
+
+Glob patterns relative to appPath for files to compile to Bytenode.
+
+Example:
+
+```json
+{
+  "bytenode": {
+    "enabled": true,
+    "files": ["dist/**/*.js", "main.js", "!renderer.js"]
+  }
+}
+```
+
 ### `appProtocolScheme` - (optional) string | string[]
 
 Default: no protocol scheme is registered
@@ -1334,6 +1371,21 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ## Changelog
 
+### 1.18.0
+
+#### Minor Changes
+
+- 0bf6caf: Add support for bytenode compilation
+
+
+### v1.17.1
+
+- 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.
+
 ### v1.15.2
 
 - Improved error handling in releaseBuild function