@todesktop/cli 1.21.0 → 1.23.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 +72 -6
- package/dist/cli.js +381 -206
- package/dist/cli.js.map +4 -4
- package/dist/types.d.ts +15 -2
- package/package.json +1 -1
- package/schemas/schema.json +30 -6
package/README.md
CHANGED
|
@@ -48,7 +48,7 @@ Create a `todesktop.json` file in the root of your Electron project.
|
|
|
48
48
|
|
|
49
49
|
```json
|
|
50
50
|
{
|
|
51
|
-
"$schema": "https://unpkg.com/@todesktop/cli@1.
|
|
51
|
+
"$schema": "https://unpkg.com/@todesktop/cli@1.23.0/schemas/schema.json",
|
|
52
52
|
"schemaVersion": 1
|
|
53
53
|
"id": "your-todesktop-id",
|
|
54
54
|
"icon": "./desktop-icon.png",
|
|
@@ -413,7 +413,7 @@ To enable JSON validation and IntelliSense for your `todesktop.json` file in com
|
|
|
413
413
|
- For example, if using a hosted version of the schema:
|
|
414
414
|
```json
|
|
415
415
|
{
|
|
416
|
-
"$schema": "https://unpkg.com/@todesktop/cli@1.
|
|
416
|
+
"$schema": "https://unpkg.com/@todesktop/cli@1.23.0/schemas/schema.json",
|
|
417
417
|
"id": "your-todesktop-id"
|
|
418
418
|
}
|
|
419
419
|
```
|
|
@@ -489,7 +489,7 @@ This is the path to your Electron application directory. Omit this unless your p
|
|
|
489
489
|
The path can be absolute or a relative path from the project root. The directory
|
|
490
490
|
it points to must be a valid Electron application directory; i.e.:
|
|
491
491
|
|
|
492
|
-
- It could be ran with the `electron` command; i.e. `npx electron {
|
|
492
|
+
- It could be ran with the `electron` command; i.e. `npx electron {appPath}`.
|
|
493
493
|
- It needs to contain a valid `package.json`.
|
|
494
494
|
- The `package.json` must either have a `main` property pointing to a file in
|
|
495
495
|
the directory or there must be an `index.js` at the root of the directory.
|
|
@@ -931,6 +931,30 @@ example, some apps need Ozone platform flags for Wayland/X11 compatibility:
|
|
|
931
931
|
Note: `--no-sandbox` is included by default. If you set `executableArgs`, it
|
|
932
932
|
will be preserved automatically unless you also set `noSandbox` to `false`.
|
|
933
933
|
|
|
934
|
+
### `linux.deb` - (optional) object
|
|
935
|
+
|
|
936
|
+
Configuration for Debian (.deb) packaging.
|
|
937
|
+
|
|
938
|
+
#### `linux.deb.additionalDepends` - (optional) string[]
|
|
939
|
+
|
|
940
|
+
Additional package dependencies to append to ToDesktop's default .deb dependencies.
|
|
941
|
+
|
|
942
|
+
This appends to ToDesktop's default Debian dependency list:
|
|
943
|
+
|
|
944
|
+
- `libgtk-3-0`
|
|
945
|
+
- `libnotify4`
|
|
946
|
+
- `libnss3`
|
|
947
|
+
- `libxss1`
|
|
948
|
+
- `libxtst6`
|
|
949
|
+
- `xdg-utils`
|
|
950
|
+
- `libatspi2.0-0`
|
|
951
|
+
- `libuuid1`
|
|
952
|
+
- `libsecret-1-0`
|
|
953
|
+
|
|
954
|
+
#### `linux.deb.depends` - (optional) string[]
|
|
955
|
+
|
|
956
|
+
The list of package dependencies for the .deb package. This overwrites ToDesktop's default dependency list and linux.deb.additionalDepends.
|
|
957
|
+
|
|
934
958
|
### `linux.noSandbox` - (optional) boolean
|
|
935
959
|
|
|
936
960
|
Default: `true`
|
|
@@ -1004,7 +1028,12 @@ Extra entries for `Info.plist`.
|
|
|
1004
1028
|
|
|
1005
1029
|
Example: `./mac-icon.png`
|
|
1006
1030
|
|
|
1007
|
-
The path to your application's Mac desktop icon. It must be an ICNS or
|
|
1031
|
+
The path to your application's Mac desktop icon. It must be an ICNS, PNG, or Apple `.icon` package directory.
|
|
1032
|
+
|
|
1033
|
+
Note: Apple `.icon` paths should point to the Icon Composer package directory
|
|
1034
|
+
(for example `AppIcon.icon`).
|
|
1035
|
+
|
|
1036
|
+
Note: Apple `.icon` support requires `appBuilderLibVersion` `26.8.1` or later.
|
|
1008
1037
|
|
|
1009
1038
|
Default: The root [`icon`](#icon---string) is used.
|
|
1010
1039
|
|
|
@@ -1348,9 +1377,12 @@ The publisher name, exactly as in your code signing certificate. Several names c
|
|
|
1348
1377
|
|
|
1349
1378
|
### `appBuilderLibVersion` - (optional) string
|
|
1350
1379
|
|
|
1351
|
-
Example: `22.14.13`
|
|
1380
|
+
Example: `22.14.13`, `latest`
|
|
1352
1381
|
|
|
1353
|
-
The version of app-builder-lib that ToDesktop should use for building your app. This can be useful if you need to use a specific version that includes certain features or fixes.
|
|
1382
|
+
The version of app-builder-lib that ToDesktop should use for building your app. This can be a specific version, a semantic version range, or "latest". This can be useful if you need to use a specific version that includes certain features or fixes.
|
|
1383
|
+
|
|
1384
|
+
Note: Set this to `26.8.1` or later if you are using Apple Icon Composer assets
|
|
1385
|
+
via [`mac.icon`](#macicon---optional-string).
|
|
1354
1386
|
|
|
1355
1387
|
### `platformOverrides` - (optional) object
|
|
1356
1388
|
|
|
@@ -1702,6 +1734,40 @@ Now, when we build your app on ToDesktop servers, it will also run your custom
|
|
|
1702
1734
|
|
|
1703
1735
|
## Changelog
|
|
1704
1736
|
|
|
1737
|
+
### 1.23.0
|
|
1738
|
+
|
|
1739
|
+
#### Minor Changes
|
|
1740
|
+
|
|
1741
|
+
- d4ed725: Add macOS Icon Composer `.icon` package support via `mac.icon`
|
|
1742
|
+
|
|
1743
|
+
#### Patch Changes
|
|
1744
|
+
|
|
1745
|
+
- 9cc64ae: Allow choosing the latest app-builder-lib version in
|
|
1746
|
+
`todesktop.json`.
|
|
1747
|
+
- cb5ef40: Clean up failed builds by deleting the build record when upload
|
|
1748
|
+
fails.
|
|
1749
|
+
|
|
1750
|
+
### 1.22.2
|
|
1751
|
+
|
|
1752
|
+
#### Patch Changes
|
|
1753
|
+
|
|
1754
|
+
- f6557f8: Fix cases when build cancelling doesn't work as expected
|
|
1755
|
+
|
|
1756
|
+
### 1.22.1
|
|
1757
|
+
|
|
1758
|
+
#### Patch Changes
|
|
1759
|
+
|
|
1760
|
+
- 3e109f0: Improved build introspection so the CLI passes app context for faster
|
|
1761
|
+
session startup and invited teammates can connect without tunnel auth
|
|
1762
|
+
permission errors.
|
|
1763
|
+
|
|
1764
|
+
### 1.22.0
|
|
1765
|
+
|
|
1766
|
+
#### Minor Changes
|
|
1767
|
+
|
|
1768
|
+
- c0222ed: Added support for custom deb package dependencies via
|
|
1769
|
+
`linux.deb.depends` in todesktop.json
|
|
1770
|
+
|
|
1705
1771
|
### 1.21.0
|
|
1706
1772
|
|
|
1707
1773
|
#### Minor Changes
|