@todesktop/cli 1.15.2 → 1.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -3
- package/dist/cli.js +682 -70
- package/dist/cli.js.map +4 -4
- package/dist/types.d.ts +9 -0
- package/package.json +2 -1
- package/schemas/schema.json +14 -0
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ For more information, visit the project [landing page](https://www.todesktop.com
|
|
|
21
21
|
Install the package with:
|
|
22
22
|
|
|
23
23
|
```sh
|
|
24
|
-
npm install
|
|
24
|
+
npm install -g @todesktop/cli
|
|
25
25
|
# or
|
|
26
26
|
yarn global add @todesktop/cli
|
|
27
27
|
```
|
|
@@ -42,7 +42,7 @@ Create a `todesktop.json` file in the root of your Electron project.
|
|
|
42
42
|
|
|
43
43
|
```json
|
|
44
44
|
{
|
|
45
|
-
"$schema": "https://unpkg.com/@todesktop/cli@1.15.
|
|
45
|
+
"$schema": "https://unpkg.com/@todesktop/cli@1.15.2/schemas/schema.json",
|
|
46
46
|
"schemaVersion": 1
|
|
47
47
|
"id": "your-todesktop-id",
|
|
48
48
|
"icon": "./desktop-icon.png",
|
|
@@ -272,7 +272,7 @@ To enable JSON validation and IntelliSense for your `todesktop.json` file in com
|
|
|
272
272
|
- For example, if using a hosted version of the schema:
|
|
273
273
|
```json
|
|
274
274
|
{
|
|
275
|
-
"$schema": "https://unpkg.com/@todesktop/cli@1.15.
|
|
275
|
+
"$schema": "https://unpkg.com/@todesktop/cli@1.15.2/schemas/schema.json",
|
|
276
276
|
"id": "your-todesktop-id"
|
|
277
277
|
}
|
|
278
278
|
```
|
|
@@ -344,6 +344,14 @@ The path can be absolute or a relative path from the project root. The directory
|
|
|
344
344
|
|
|
345
345
|
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.
|
|
346
346
|
|
|
347
|
+
### `bundleWorkspacePackages` - (optional) object
|
|
348
|
+
|
|
349
|
+
- Default: `{"enabled":false}`
|
|
350
|
+
|
|
351
|
+
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.
|
|
352
|
+
|
|
353
|
+
- Example: `{"enabled":true}`
|
|
354
|
+
|
|
347
355
|
### `appProtocolScheme` - (optional) string | string[]
|
|
348
356
|
|
|
349
357
|
Default: no protocol scheme is registered
|
|
@@ -1334,6 +1342,10 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
|
|
|
1334
1342
|
|
|
1335
1343
|
## Changelog
|
|
1336
1344
|
|
|
1345
|
+
### v1.17.0
|
|
1346
|
+
|
|
1347
|
+
- Add support for `bundleWorkspacePackages` in config to specify whether the CLI bundles workspace packages alongside the app upload.
|
|
1348
|
+
|
|
1337
1349
|
### v1.15.2
|
|
1338
1350
|
|
|
1339
1351
|
- Improved error handling in releaseBuild function
|