#tauri-plugin #tauri #fs-pro #fs-extra

sys tauri-plugin-fs-pro

Extended with additional methods for files and directories

6 stable releases

new 2.4.0 Apr 15, 2025
2.3.1 Mar 1, 2025
2.3.0 Dec 12, 2024
2.2.0 Nov 25, 2024

#279 in GUI

Download history 63/week @ 2024-12-28 113/week @ 2025-01-04 113/week @ 2025-01-11 138/week @ 2025-01-18 138/week @ 2025-01-25 57/week @ 2025-02-01 64/week @ 2025-02-08 138/week @ 2025-02-15 90/week @ 2025-02-22 352/week @ 2025-03-01 199/week @ 2025-03-08 245/week @ 2025-03-15 142/week @ 2025-03-22 160/week @ 2025-03-29 157/week @ 2025-04-05 246/week @ 2025-04-12

720 downloads per month

MIT license

95KB
507 lines

tauri-plugin-fs-pro

This plugin only works on tauri v2, if you need the v1 plugin, feel free to submit a PR!

What is the difference with @tauri-apps/plugin-fs?

The stat method of @tauri-apps/plugin-fs supports only files when getting size, while the metadata method of tauri-plugin-fs-pro supports both files and directories when getting size. And some additional methods are provided. More methods will be expanded in the future.

https://github.com/user-attachments/assets/f6cbf39d-7ce4-4efb-a348-90b8b3ed8b43

Platform Support

Platform Supported
Windows
macOS
Linux
Android
iOS

Install

cargo add tauri-plugin-fs-pro

You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

pnpm add tauri-plugin-fs-pro-api

Usage

src-tauri/src/lib.rs

pub fn run() {
    tauri::Builder::default()
+       .plugin(tauri_plugin_fs_pro::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

src-tauri/capabilities/default.json

{
    ...
    "permissions": [
        ...
+       "fs-pro:default"
    ]
}

Afterwards all the plugin's APIs are available through the JavaScript guest bindings:

import { isExist } from "tauri-plugin-fs-pro-api";

const exists = await isExist("/Users/xxx/EcoPaste.txt");
console.log(exists); // true

Methods

Method Description
isExist Check if a path exists.
isFile Check if a path is a file.
isDir Check if a path is a directory.
size Get the size of the path, or 0 if it does not exist.
name Get the name of the path.
extname Get the extension name of the path.
fullName Get the full name of a file or directory including extension.
parentName Get the parent name of the path.
icon Get the icon of the path.
metadata Get the metadata of the path.
compress Compress the source path into a tar.gz file to the destination path.
decompress Decompress the tar.gz file from the source path to the destination path.
transfer Move the source path to the destination path.

Example

git clone https://github.com/ayangweb/tauri-plugin-fs-pro.git
pnpm install

pnpm build

cd examples/tauri-app

pnpm install

pnpm tauri dev

Thanks

Who's Use It

  • EcoPaste - Open source cross-platform clipboard management tool.

  • Coco AI - Search, Connect, Collaborate, Your Personal AI Search and Assistant, all in one space.

Dependencies

~21–59MB
~1M SLoC