Skip to content

Add troubleshooting information for persisted-scope #3568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 5, 2025
Merged

Add troubleshooting information for persisted-scope #3568

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
629483e
Add troubleshooting information for persisted-scope
Picorims Oct 30, 2025
d3d0bb3
use warn aside in setup of persisted scope to document plugin order
Picorims Nov 4, 2025
6b11fb0
format
vasfvitor Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/content/docs/plugin/persisted-scope.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,28 @@ Install the persisted-scope plugin to get started.
</TabItem>
</Tabs>

:::caution
The `persisted-scope` plugin _must_ be registered and initialized after the `fs` plugin, as illustrated by the example below:

```rs
#[cfg_attr(mobile, tauri::mobile_entry_point)]
pub fn run() {
tauri::Builder::default()
.plugin(tauri_plugin_fs::init()) // fs MUST BE before persisted scope!
.plugin(tauri_plugin_persisted_scope::init())
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
```

**Not doing so will result in the persisted scope not working!** You should also see a warning message upon launching your app in dev mode, similar to this:

```
Please make sure to register the `fs` plugin before the `persisted-scope` plugin!
```

:::

## Usage

After setup the plugin will automatically save and restore filesystem and asset scopes.