|
|
@@ -11,20 +11,32 @@
|
|
|
//! The following are a list of [Cargo features](https://doc.rust-lang.org/stable/cargo/reference/manifest.html#the-features-section) that can be enabled or disabled:
|
|
|
//!
|
|
|
//! - **wry** *(enabled by default)*: Enables the [wry](https://github.com/tauri-apps/wry) runtime. Only disable it if you want a custom runtime.
|
|
|
+//! - **dox**: Internal feature to generate Rust documentation without linking on Linux.
|
|
|
+//! - **objc-exception**: Wrap each msg_send! in a @try/@catch and panics if an exception is caught, preventing Objective-C from unwinding into Rust.
|
|
|
//! - **isolation**: Enables the isolation pattern. Enabled by default if the `tauri > pattern > use` config option is set to `isolation` on the `tauri.conf.json` file.
|
|
|
//! - **custom-protocol**: Feature managed by the Tauri CLI. When enabled, Tauri assumes a production environment instead of a development one.
|
|
|
//! - **updater**: Enables the application auto updater. Enabled by default if the `updater` config is defined on the `tauri.conf.json` file.
|
|
|
//! - **devtools**: Enables the developer tools (Web inspector) and [`Window::open_devtools`]. Enabled by default on debug builds.
|
|
|
//! On macOS it uses private APIs, so you can't enable it if your app will be published to the App Store.
|
|
|
+//! - **shell-open-api**: Enables the [`api::shell`] module.
|
|
|
//! - **http-api**: Enables the [`api::http`] module.
|
|
|
+//! - **http-multipart**: Adds support to `multipart/form-data` requests.
|
|
|
//! - **reqwest-client**: Uses `reqwest` as HTTP client on the `http` APIs. Improves performance, but increases the bundle size.
|
|
|
-//! - **command**: Enables the [`api::process::Command`] APIs.
|
|
|
+//! - **process-command-api**: Enables the [`api::process::Command`] APIs.
|
|
|
+//! - **process-relaunch-dangerous-allow-symlink-macos**: Allows the [`api::process::current_binary`] function to allow symlinks on macOS (this is dangerous, see the Security section in the documentation website).
|
|
|
//! - **dialog**: Enables the [`api::dialog`] module.
|
|
|
//! - **notification**: Enables the [`api::notification`] module.
|
|
|
+//! - **fs-extract-api**: Enabled the `tauri::api::file::Extract` API.
|
|
|
//! - **cli**: Enables usage of `clap` for CLI argument parsing. Enabled by default if the `cli` config is defined on the `tauri.conf.json` file.
|
|
|
//! - **system-tray**: Enables application system tray API. Enabled by default if the `systemTray` config is defined on the `tauri.conf.json` file.
|
|
|
+//! - **ayatana-tray** *(enabled by default)*: Use libayatana-appindicator for system tray on Linux.
|
|
|
+//! - **gtk-tray**: Use libappindicator3-1 for system tray on Linux. To enable this, you need to disable the default features.
|
|
|
//! - **macos-private-api**: Enables features only available in **macOS**'s private APIs, currently the `transparent` window functionality and the `fullScreenEnabled` preference setting to `true`. Enabled by default if the `tauri > macosPrivateApi` config flag is set to `true` on the `tauri.conf.json` file.
|
|
|
//! - **window-data-url**: Enables usage of data URLs on the webview.
|
|
|
+//! - **compression** *(enabled by default): Enables asset compression. You should only disable this if you want faster compile times in release builds - it produces larger binaries.
|
|
|
+//! - **config-json5**: Adds support to JSON5 format for `tauri.conf.json`.
|
|
|
+//! - **icon-ico**: Adds support to set `.ico` window icons. Enables [`Icon::File`] and [`Icon::Raw`] variants.
|
|
|
+//! - **icon-png**: Adds support to set `.png` window icons. Enables [`Icon::File`] and [`Icon::Raw`] variants.
|
|
|
//!
|
|
|
//! ## Cargo allowlist features
|
|
|
//!
|
|
|
@@ -124,6 +136,10 @@
|
|
|
//! - **window-set-focus**: Enables the [`setFocus` API](https://tauri.studio/en/docs/api/js/classes/window.WebviewWindow#setfocus).
|
|
|
//! - **window-set-icon**: Enables the [`setIcon` API](https://tauri.studio/en/docs/api/js/classes/window.WebviewWindow#seticon).
|
|
|
//! - **window-set-skip-taskbar**: Enables the [`setSkipTaskbar` API](https://tauri.studio/en/docs/api/js/classes/window.WebviewWindow#setskiptaskbar).
|
|
|
+//! - **window-set-cursor-grab**: Enables the [`setCursorGrab` API](https://tauri.studio/en/docs/api/js/classes/window.WebviewWindow#setcursorgrab).
|
|
|
+//! - **window-set-cursor-visible**: Enables the [`setCursorVisible` API](https://tauri.studio/en/docs/api/js/classes/window.WebviewWindow#setcursorvisible).
|
|
|
+//! - **window-set-cursor-icon**: Enables the [`setCursorIcon` API](https://tauri.studio/en/docs/api/js/classes/window.WebviewWindow#setcursoricon).
|
|
|
+//! - **window-set-cursor-position**: Enables the [`setCursorPosition` API](https://tauri.studio/en/docs/api/js/classes/window.WebviewWindow#setcursorposition).
|
|
|
//! - **window-start-dragging**: Enables the [`startDragging` API](https://tauri.studio/en/docs/api/js/classes/window.WebviewWindow#startdragging).
|
|
|
//! - **window-print**: Enables the [`print` API](https://tauri.studio/en/docs/api/js/classes/window.WebviewWindow#print).
|
|
|
|
|
|
@@ -783,6 +799,27 @@ pub(crate) mod sealed {
|
|
|
#[cfg(test)]
|
|
|
pub mod test;
|
|
|
|
|
|
+#[cfg(test)]
|
|
|
+mod tests {
|
|
|
+ #[test]
|
|
|
+ fn features_are_documented() {
|
|
|
+ use cargo_toml::Manifest;
|
|
|
+ use std::{env::var, fs::read_to_string, path::PathBuf};
|
|
|
+ // this env var is always set by Cargo
|
|
|
+ let manifest_dir = PathBuf::from(var("CARGO_MANIFEST_DIR").unwrap());
|
|
|
+ let manifest =
|
|
|
+ Manifest::from_path(manifest_dir.join("Cargo.toml")).expect("failed to parse Cargo manifest");
|
|
|
+
|
|
|
+ let lib_code = read_to_string(manifest_dir.join("src/lib.rs")).expect("failed to read lib.rs");
|
|
|
+
|
|
|
+ for (f, _) in manifest.features {
|
|
|
+ if !(f.starts_with("__") || f == "default" || lib_code.contains(&format!("*{}**", f))) {
|
|
|
+ panic!("Feature {} is not documented", f);
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
#[cfg(test)]
|
|
|
mod test_utils {
|
|
|
use proptest::prelude::*;
|
Lucas Fernandes Nogueira