@tauri-apps/cli 1.0.0 → 1.0.3

package/CHANGELOG.md

@@ -1,5 +1,64 @@
 # Changelog
 
+## \[1.0.3]
+
+- Changed the app template to not set the default app menu as it is now set automatically on macOS which is the platform that needs a menu to function properly.
+  - [91055883](https://www.github.com/tauri-apps/tauri/commit/9105588373cc8401bd9ad79bdef26f509b2d76b7) feat: add implicit default menu for macOS only, closes [#4551](https://www.github.com/tauri-apps/tauri/pull/4551) ([#4570](https://www.github.com/tauri-apps/tauri/pull/4570)) on 2022-07-04
+- Improved bundle identifier validation showing the exact source of the configuration value.
+  - [8e3e7fc6](https://www.github.com/tauri-apps/tauri/commit/8e3e7fc64641afc7a6833bc93205e6f525562545) feat(cli): improve bundle identifier validation, closes [#4589](https://www.github.com/tauri-apps/tauri/pull/4589) ([#4596](https://www.github.com/tauri-apps/tauri/pull/4596)) on 2022-07-05
+- Improve configuration deserialization error messages.
+  - [9170c920](https://www.github.com/tauri-apps/tauri/commit/9170c9207044fa561535f624916dfdbaa41ff79d) feat(core): improve config deserialization error messages ([#4607](https://www.github.com/tauri-apps/tauri/pull/4607)) on 2022-07-06
+- Revert the `run` command to run in a separate thread.
+  - [f65eb4f8](https://www.github.com/tauri-apps/tauri/commit/f65eb4f84d8e511cd30d01d20a8223a297f7e584) fix(cli.js): revert `run` command to be nonblocking on 2022-07-04
+- Skip the static link of the `vcruntime140.dll` if the `STATIC_VCRUNTIME` environment variable is set to `false`.
+  - [2e61abaa](https://www.github.com/tauri-apps/tauri/commit/2e61abaa9ae5d7a41ca1fa6505b5d6c368625ce5) feat(cli): allow dynamic link vcruntime, closes [#4565](https://www.github.com/tauri-apps/tauri/pull/4565) ([#4601](https://www.github.com/tauri-apps/tauri/pull/4601)) on 2022-07-06
+- The `TAURI_CONFIG` environment variable now represents the configuration to be merged instead of the entire JSON.
+  - [fa028ebf](https://www.github.com/tauri-apps/tauri/commit/fa028ebf3c8ca7b43a70d283a01dbea86217594f) refactor: do not pass entire config from CLI to core, send patch instead ([#4598](https://www.github.com/tauri-apps/tauri/pull/4598)) on 2022-07-06
+- Watch for Cargo workspace members in the `dev` file watcher.
+  - [dbb8c87b](https://www.github.com/tauri-apps/tauri/commit/dbb8c87b96dec9942b1bf877b29bafb8246514d4) feat(cli): watch Cargo workspaces in the dev command, closes [#4222](https://www.github.com/tauri-apps/tauri/pull/4222) ([#4572](https://www.github.com/tauri-apps/tauri/pull/4572)) on 2022-07-03
+
+## \[1.0.2]
+
+- Fixes a crash on the `signer sign` command.
+  - [8e808fec](https://www.github.com/tauri-apps/tauri/commit/8e808fece95f2e506acf2c446d37b9913fd67d50) fix(cli.rs): conflicts_with arg doesn't exist closes  ([#4538](https://www.github.com/tauri-apps/tauri/pull/4538)) on 2022-06-30
+
+## \[1.0.1]
+
+- No longer adds the `pkg-config` dependency to `.deb` packages when the `systemTray` is used.
+  This only works with recent versions of `libappindicator-sys` (including https://github.com/tauri-apps/libappindicator-rs/pull/38),
+  so a `cargo update` may be necessary if you create `.deb` bundles and use the tray feature.
+  - [0e6edeb1](https://www.github.com/tauri-apps/tauri/commit/0e6edeb14f379af1e02a7cebb4e3a5c9e87ebf7f) fix(cli): Don't add `pkg-config` to `deb` ([#4508](https://www.github.com/tauri-apps/tauri/pull/4508)) on 2022-06-29
+- AppImage bundling will now prefer bundling correctly named appincidator library (including `.1` version suffix). With a symlink for compatibility with the old naming.
+  - [bf45ca1d](https://www.github.com/tauri-apps/tauri/commit/bf45ca1df6691c05bdf72c5716cc01e89a7791d4) fix(cli,bundler): prefer AppImage libraries with ABI version ([#4505](https://www.github.com/tauri-apps/tauri/pull/4505)) on 2022-06-29
+- Improve error message when `cargo` is not installed.
+  - [e0e5f772](https://www.github.com/tauri-apps/tauri/commit/e0e5f772430f6349ec99ba891e601331e376e3c7) feat(cli): improve `cargo not found` error message, closes [#4428](https://www.github.com/tauri-apps/tauri/pull/4428) ([#4430](https://www.github.com/tauri-apps/tauri/pull/4430)) on 2022-06-21
+- The app template now only sets the default menu on macOS.
+  - [5105b428](https://www.github.com/tauri-apps/tauri/commit/5105b428c4726b2179cd4b3244350d1a1ee73734) feat(cli): change app template to only set default menu on macOS ([#4518](https://www.github.com/tauri-apps/tauri/pull/4518)) on 2022-06-29
+- Warn if updater is enabled but not in the bundle target list.
+  - [31c15cd2](https://www.github.com/tauri-apps/tauri/commit/31c15cd2bd94dbe39fb94982a15cbe02ac5d8925) docs(config): enhance documentation for bundle targets, closes [#3251](https://www.github.com/tauri-apps/tauri/pull/3251) ([#4418](https://www.github.com/tauri-apps/tauri/pull/4418)) on 2022-06-21
+- Check if target exists and is installed on dev and build commands.
+  - [13b8a240](https://www.github.com/tauri-apps/tauri/commit/13b8a2403d1353a8c3a643fbc6b6e862af68376e) feat(cli): validate target argument ([#4458](https://www.github.com/tauri-apps/tauri/pull/4458)) on 2022-06-24
+- Fixes the covector configuration on the plugin templates.
+  - [b8a64d01](https://www.github.com/tauri-apps/tauri/commit/b8a64d01bab11f955b7bbdf323d0afa1a3db4b64) fix(cli): add prepublish scripts to the plugin templates on 2022-06-19
+- Set the binary name to the product name in development.
+  - [b025b9f5](https://www.github.com/tauri-apps/tauri/commit/b025b9f581ac1a6ae0a26789c2be1e9928fb0282) refactor(cli): set binary name on dev ([#4447](https://www.github.com/tauri-apps/tauri/pull/4447)) on 2022-06-23
+- Allow registering a `.gitignore` file to skip watching some project files and directories via the `TAURI_DEV_WATCHER_IGNORE_FILE` environment variable.
+  - [83186dd8](https://www.github.com/tauri-apps/tauri/commit/83186dd89768407984db35fb67c3cc51f50ea8f5) Read extra ignore file for dev watcher, closes [#4406](https://www.github.com/tauri-apps/tauri/pull/4406) ([#4409](https://www.github.com/tauri-apps/tauri/pull/4409)) on 2022-06-20
+- Fix shebang for `kill-children.sh`.
+  - [35dd51db](https://www.github.com/tauri-apps/tauri/commit/35dd51db6826ec1eed7b90082b9eb6b2a699b627) fix(cli): add shebang for kill-children.sh, closes [#4262](https://www.github.com/tauri-apps/tauri/pull/4262) ([#4416](https://www.github.com/tauri-apps/tauri/pull/4416)) on 2022-06-22
+- Update plugin templates to use newer `tauri-apps/create-pull-request` GitHub action.
+  - [07f90795](https://www.github.com/tauri-apps/tauri/commit/07f9079532a42f3517d96faeaf46cad6176b31ac) chore(cli): update plugin template tauri-apps/create-pull-request on 2022-06-19
+- Use UNIX path separator on the init `$schema` field.
+  - [01053045](https://www.github.com/tauri-apps/tauri/commit/010530459ef62c48eed68ca965f2688accabcf69) chore(cli): use unix path separator on $schema ([#4384](https://www.github.com/tauri-apps/tauri/pull/4384)) on 2022-06-19
+- The `info` command now can check the Cargo lockfile on workspaces.
+  - [12f65219](https://www.github.com/tauri-apps/tauri/commit/12f65219ea75a51ebd38659ddce1563e015a036c) fix(cli): read lockfile from workspace on the info command, closes [#4232](https://www.github.com/tauri-apps/tauri/pull/4232) ([#4423](https://www.github.com/tauri-apps/tauri/pull/4423)) on 2022-06-21
+- Preserve the `Cargo.toml` formatting when the features array is not changed.
+  - [6650e5d6](https://www.github.com/tauri-apps/tauri/commit/6650e5d6720c215530ca1fdccd19bd2948dd6ca3) fix(cli): preserve Cargo manifest formatting when possible ([#4431](https://www.github.com/tauri-apps/tauri/pull/4431)) on 2022-06-21
+- Change the updater signature metadata to include the file name instead of its full path.
+  - [094b3eb3](https://www.github.com/tauri-apps/tauri/commit/094b3eb352bcf5de28414015e7c44290d619ea8c) fix(cli): file name instead of path on updater sig comment, closes [#4467](https://www.github.com/tauri-apps/tauri/pull/4467) ([#4484](https://www.github.com/tauri-apps/tauri/pull/4484)) on 2022-06-27
+- Validate bundle identifier as it must only contain alphanumeric characters, hyphens and periods.
+  - [0674a801](https://www.github.com/tauri-apps/tauri/commit/0674a80129d7c31bc93257849afc0a5069129fed) fix: assert config.bundle.identifier to be only alphanumeric, hyphens or dots. closes [#4359](https://www.github.com/tauri-apps/tauri/pull/4359) ([#4363](https://www.github.com/tauri-apps/tauri/pull/4363)) on 2022-06-17
+
 ## \[1.0.0]
 
 - Upgrade to `stable`!

package/Cargo.toml

@@ -8,9 +8,10 @@ crate-type = ["cdylib"]
 
 [dependencies]
 # Default enable napi4 feature, see https://nodejs.org/api/n-api.html#node-api-version-matrix
-napi = { version = "2.5", default-features = false, features = ["napi4"] }
-napi-derive = "2.5"
+napi = { version = "2.6", default-features = false, features = ["napi4"] }
+napi-derive = "2.6"
 tauri-cli = { path = ".." }
+log = "0.4.17"
 
 [build-dependencies]
 napi-build = "2.0"

package/index.d.ts

@@ -4,3 +4,4 @@
 /* auto-generated by NAPI-RS */
 
 export function run(args: Array<string>, binName: string | undefined | null, callback: (...args: any[]) => any): void
+export function logError(error: string): void

package/index.js

@@ -236,6 +236,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { run } = nativeBinding
+const { run, logError } = nativeBinding
 
 module.exports.run = run
+module.exports.logError = logError

package/main.js

@@ -1,4 +1,4 @@
-const { run } = require('./index')
+const { run, logError } = require('./index')
 
 module.exports.run = (args, binName) => {
   return new Promise((resolve, reject) => {
@@ -11,3 +11,5 @@ module.exports.run = (args, binName) => {
     })
   })
 }
+
+module.exports.logError = logError

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/cli",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Command line interface for building Tauri apps",
   "funding": {
     "type": "opencollective",
@@ -37,13 +37,13 @@
     }
   },
   "devDependencies": {
-    "@napi-rs/cli": "2.10.0",
+    "@napi-rs/cli": "2.10.1",
     "cross-env": "7.0.3",
     "cross-spawn": "7.0.3",
     "fs-extra": "10.1.0",
-    "jest": "28.1.1",
+    "jest": "28.1.2",
     "jest-transform-toml": "1.0.0",
-    "prettier": "2.7.0"
+    "prettier": "2.7.1"
   },
   "engines": {
     "node": ">= 10"
@@ -64,14 +64,14 @@
     "format:check": "prettier --check ./package.json ./tauri.js"
   },
   "optionalDependencies": {
-    "@tauri-apps/cli-win32-x64-msvc": "1.0.0",
-    "@tauri-apps/cli-darwin-x64": "1.0.0",
-    "@tauri-apps/cli-linux-x64-gnu": "1.0.0",
-    "@tauri-apps/cli-darwin-arm64": "1.0.0",
-    "@tauri-apps/cli-linux-arm64-gnu": "1.0.0",
-    "@tauri-apps/cli-linux-arm64-musl": "1.0.0",
-    "@tauri-apps/cli-linux-arm-gnueabihf": "1.0.0",
-    "@tauri-apps/cli-linux-x64-musl": "1.0.0",
-    "@tauri-apps/cli-win32-ia32-msvc": "1.0.0"
+    "@tauri-apps/cli-win32-x64-msvc": "1.0.3",
+    "@tauri-apps/cli-darwin-x64": "1.0.3",
+    "@tauri-apps/cli-linux-x64-gnu": "1.0.3",
+    "@tauri-apps/cli-darwin-arm64": "1.0.3",
+    "@tauri-apps/cli-linux-arm64-gnu": "1.0.3",
+    "@tauri-apps/cli-linux-arm64-musl": "1.0.3",
+    "@tauri-apps/cli-linux-arm-gnueabihf": "1.0.3",
+    "@tauri-apps/cli-linux-x64-musl": "1.0.3",
+    "@tauri-apps/cli-win32-ia32-msvc": "1.0.3"
   }
 }

package/schema.json

@@ -129,6 +129,7 @@
           "macOS": {
             "minimumSystemVersion": "10.13"
           },
+          "targets": "all",
           "windows": {
             "allowDowngrades": true,
             "certificateThumbprint": null,
@@ -136,6 +137,10 @@
             "timestampUrl": null,
             "tsp": false,
             "webviewFixedRuntimePath": null,
+            "webviewInstallMode": {
+              "silent": true,
+              "type": "downloadBootstrapper"
+            },
             "wix": null
           }
         },
@@ -259,6 +264,7 @@
             "macOS": {
               "minimumSystemVersion": "10.13"
             },
+            "targets": "all",
             "windows": {
               "allowDowngrades": true,
               "certificateThumbprint": null,
@@ -266,6 +272,10 @@
               "timestampUrl": null,
               "tsp": false,
               "webviewFixedRuntimePath": null,
+              "webviewInstallMode": {
+                "silent": true,
+                "type": "downloadBootstrapper"
+              },
               "wix": null
             }
           },
@@ -607,7 +617,7 @@
           "type": "boolean"
         },
         "theme": {
-          "description": "The initial window theme. Defaults to the system theme. Only implemented on Windows.",
+          "description": "The initial window theme. Defaults to the system theme. Only implemented on Windows and macOS 10.14+.",
           "anyOf": [
             {
               "$ref": "#/definitions/Theme"
@@ -896,23 +906,21 @@
       ],
       "properties": {
         "active": {
-          "description": "Whether we should build your app with tauri-bundler or plain `cargo build`",
+          "description": "Whether Tauri should bundle your application or just output the executable.",
           "default": false,
           "type": "boolean"
         },
         "targets": {
-          "description": "The bundle targets, currently supports [\"deb\", \"app\", \"msi\", \"appimage\", \"dmg\"] or \"all\"",
-          "anyOf": [
+          "description": "The bundle targets, currently supports [\"deb\", \"appimage\", \"msi\", \"app\", \"dmg\", \"updater\"] or \"all\".",
+          "default": "all",
+          "allOf": [
             {
               "$ref": "#/definitions/BundleTarget"
-            },
-            {
-              "type": "null"
             }
           ]
         },
         "identifier": {
-          "description": "The application identifier in reverse domain name notation (e.g. `com.tauri.example`). This string must be unique across applications since it is used in system configurations like the bundle ID and path to the webview data directory.",
+          "description": "The application identifier in reverse domain name notation (e.g. `com.tauri.example`). This string must be unique across applications since it is used in system configurations like the bundle ID and path to the webview data directory. This string must contain only alphanumeric characters (A–Z, a–z, and 0–9), hyphens (-), and periods (.).",
           "type": "string"
         },
         "icon": {
@@ -1013,6 +1021,10 @@
             "timestampUrl": null,
             "tsp": false,
             "webviewFixedRuntimePath": null,
+            "webviewInstallMode": {
+              "silent": true,
+              "type": "downloadBootstrapper"
+            },
             "wix": null
           },
           "allOf": [
@@ -1025,21 +1037,43 @@
       "additionalProperties": false
     },
     "BundleTarget": {
-      "description": "Targets to bundle.",
+      "description": "Targets to bundle. Each value is case insensitive.",
       "anyOf": [
+        {
+          "description": "Bundle all targets.",
+          "enum": [
+            "all"
+          ]
+        },
         {
           "description": "A list of bundle targets.",
           "type": "array",
           "items": {
-            "type": "string"
+            "$ref": "#/definitions/BundleType"
           }
         },
         {
           "description": "A single bundle target.",
-          "type": "string"
+          "allOf": [
+            {
+              "$ref": "#/definitions/BundleType"
+            }
+          ]
         }
       ]
     },
+    "BundleType": {
+      "description": "A bundle referenced by tauri-bundler.",
+      "type": "string",
+      "enum": [
+        "deb",
+        "appimage",
+        "msi",
+        "app",
+        "dmg",
+        "updater"
+      ]
+    },
     "AppImageConfig": {
       "description": "Configuration for AppImage bundles.",
       "type": "object",
@@ -1167,8 +1201,20 @@
           "default": false,
           "type": "boolean"
         },
+        "webviewInstallMode": {
+          "description": "The installation mode for the Webview2 runtime.",
+          "default": {
+            "silent": true,
+            "type": "downloadBootstrapper"
+          },
+          "allOf": [
+            {
+              "$ref": "#/definitions/WebviewInstallMode"
+            }
+          ]
+        },
         "webviewFixedRuntimePath": {
-          "description": "Path to the webview fixed runtime to use.\n\nThe fixed version can be downloaded [on the official website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section). The `.cab` file must be extracted to a folder and this folder path must be defined on this field.",
+          "description": "Path to the webview fixed runtime to use. Overwrites [`Self::webview_install_mode`] if set.\n\nWill be removed in v2, prefer the [`Self::webview_install_mode`] option.\n\nThe fixed version can be downloaded [on the official website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section). The `.cab` file must be extracted to a folder and this folder path must be defined on this field.",
           "type": [
             "string",
             "null"
@@ -1193,6 +1239,111 @@
       },
       "additionalProperties": false
     },
+    "WebviewInstallMode": {
+      "description": "Install modes for the Webview2 runtime. Note that for the updater bundle [`Self::DownloadBootstrapper`] is used.\n\nFor more information see <https://tauri.app/v1/guides/building/windows>.",
+      "oneOf": [
+        {
+          "description": "Do not install the Webview2 as part of the Windows Installer.",
+          "type": "object",
+          "required": [
+            "type"
+          ],
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "skip"
+              ]
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "description": "Download the bootstrapper and run it. Requires internet connection. Results in a smaller installer size, but is not recommended on Windows 7.",
+          "type": "object",
+          "required": [
+            "type"
+          ],
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "downloadBootstrapper"
+              ]
+            },
+            "silent": {
+              "description": "Instructs the installer to run the bootstrapper in silent mode. Defaults to `true`.",
+              "default": true,
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "description": "Embed the bootstrapper and run it. Requires internet connection. Increases the installer size by around 1.8MB, but offers better support on Windows 7.",
+          "type": "object",
+          "required": [
+            "type"
+          ],
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "embedBootstrapper"
+              ]
+            },
+            "silent": {
+              "description": "Instructs the installer to run the bootstrapper in silent mode. Defaults to `true`.",
+              "default": true,
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "description": "Embed the offline installer and run it. Does not require internet connection. Increases the installer size by around 127MB.",
+          "type": "object",
+          "required": [
+            "type"
+          ],
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "offlineInstaller"
+              ]
+            },
+            "silent": {
+              "description": "Instructs the installer to run the installer in silent mode. Defaults to `true`.",
+              "default": true,
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "description": "Embed a fixed webview2 version and use it at runtime. Increases the installer size by around 180MB.",
+          "type": "object",
+          "required": [
+            "path",
+            "type"
+          ],
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "fixedRuntime"
+              ]
+            },
+            "path": {
+              "description": "The path to the fixed runtime to use.\n\nThe fixed version can be downloaded [on the official website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section). The `.cab` file must be extracted to a folder and this folder path must be defined on this field.",
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
     "WixConfig": {
       "description": "Configuration for the MSI bundle using WiX.",
       "type": "object",
@@ -1262,7 +1413,7 @@
           }
         },
         "skipWebviewInstall": {
-          "description": "Disables the Webview2 runtime installation after app install.",
+          "description": "Disables the Webview2 runtime installation after app install.\n\nWill be removed in v2, prefer the [`WindowsConfig::webview_install_mode`] option.",
           "default": false,
           "type": "boolean"
         },
@@ -2258,6 +2409,11 @@
           "description": "A Boolean value that determines whether the image represents a [template](https://developer.apple.com/documentation/appkit/nsimage/1520017-template?language=objc) image on macOS.",
           "default": false,
           "type": "boolean"
+        },
+        "menuOnLeftClick": {
+          "description": "A Boolean value that determines whether the menu should appear when the tray icon receives a left click on macOS.",
+          "default": true,
+          "type": "boolean"
         }
       },
       "additionalProperties": false
@@ -2349,4 +2505,4 @@
       "additionalProperties": true
     }
   }
-}
+}

package/src/lib.rs

@@ -12,7 +12,9 @@ pub fn run(args: Vec<String>, bin_name: Option<String>, callback: JsFunction) ->
   let function: ThreadsafeFunction<bool, ErrorStrategy::CalleeHandled> = callback
     .create_threadsafe_function(0, |ctx| ctx.env.get_boolean(ctx.value).map(|v| vec![v]))?;
 
-  std::thread::spawn(move || match tauri_cli::run(args, bin_name) {
+  // we need to run in a separate thread so Node.js (e.g. vue-cli-plugin-tauri) consumers
+  // can do work while `tauri dev` is running.
+  std::thread::spawn(move || match tauri_cli::try_run(args, bin_name) {
     Ok(_) => function.call(Ok(true), ThreadsafeFunctionCallMode::Blocking),
     Err(e) => function.call(
       Err(Error::new(Status::GenericFailure, format!("{:#}", e))),
@@ -22,3 +24,8 @@ pub fn run(args: Vec<String>, bin_name: Option<String>, callback: JsFunction) ->
 
   Ok(())
 }
+
+#[napi_derive::napi]
+pub fn log_error(error: String) {
+  log::error!("{}", error);
+}

package/tauri.js

@@ -44,6 +44,6 @@ if (binStem === 'node' || binStem === 'nodejs') {
 }
 
 cli.run(arguments, binName).catch((err) => {
-  console.log(`Error running CLI: ${err.message}`)
+  cli.logError(err.message)
   process.exit(1)
 })