Tauri Plugin FSWatch
This plugin provides a "classical" Tauri Plugin Interface to watch changes on files and directories through notify.
Architecture
This repo shape might appear to be strange, but it is really just a hybrid Rust / Typescript project that recommends a specific type of consumption, namely using GIT as the secure distribution mechanism, and referencing specific unforgeable git hashes. Of course, it can also be consumed via Cargo and NPM.
/src
Rust source code that contains the plugin definition.
/webview-src
Typescript source for the /webview-dist folder that provides an API to interface with the rust code.
/webview-dist
Tree-shakeable transpiled JS to be consumed in a Tauri application.
/bindings
Forthcoming tauri bindings to other programming languages, like DENO.
Installation
There are three general methods of installation that we can recommend.
- Pull sources directly from Github using git tags / revision hashes (most secure, good for developement, shown below)
- Git submodule install this repo in your tauri project and then use
fileprotocol to ingest the source - Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
For more details and usage see the Todo app. Please note, below in the dependencies you can also lock to a revision/tag in both the Cargo.toml and package.json
RUST
src-tauri/Cargo.toml
[dependencies.tauri-plugin-fs-watch]
git = "https://github.com/tauri-apps/tauri-plugin-fs-watch"
tag = "v0.1.0"
#branch = "main"
Use in src-tauri/src/main.rs:
use tauri_plugin_fs_watch::Watcher;
fn main() {
tauri::Builder::default()
.plugin(Watcher::default())
.build()
.run();
}
WEBVIEW
Install from a tagged release
npm install github:tauri-apps/tauri-plugin-fs-watch#v0.1.0
# or
yarn add github:tauri-apps/tauri-plugin-fs-watch#v0.1.0
Install from a commit
npm install github:tauri-apps/tauri-plugin-fs-watch#488558717b77d8a2bcb37acfd2eca9658aeadc8e
# or
yarn add github:tauri-apps/tauri-plugin-fs-watch#488558717b77d8a2bcb37acfd2eca9658aeadc8e
package.json
"dependencies": {
"tauri-plugin-fs-watch-api": "github:tauri-apps/tauri-plugin-fs-watch#v0.1.0",
Use within your JS/TS:
import { watch, watchImmediate } from 'tauri-plugin-fs-watch-api'
// can also watch an array of paths
const stopWatching = await watch('/path/to/something', { recursive: true }, event => {
const { type, payload } = event
})
const stopRawWatcher = await watchImmediate(['/path/a', '/path/b'], {}, event => {
const { path, operation, cookie } = event
})
License
MIT / Apache-2.0
4.2k Jan 4, 2023
539 Dec 24, 2022
72 Dec 29, 2022
16.2k Jan 7, 2023
294 Dec 23, 2022
11 Dec 15, 2022
2 Sep 4, 2022
176 Dec 31, 2022
4 Oct 6, 2023
11 Mar 24, 2023
9 Jun 11, 2022
5 Nov 19, 2022
7 Oct 7, 2022
2 Apr 6, 2022
14 Dec 6, 2022
7 Jun 1, 2022
26 Dec 23, 2022
4 Oct 18, 2022
5 Dec 16, 2022
259 Jan 3, 2023