https://github.com/hubiolabs/tauri-plugin-structure-manager

A Tauri plugin for managing application structure, including directory and file creation and validation.
https://github.com/hubiolabs/tauri-plugin-structure-manager

rust tauri tauri-plugin

Last synced: 5 days ago
JSON representation

A Tauri plugin for managing application structure, including directory and file creation and validation.

• Host: GitHub
• URL: https://github.com/hubiolabs/tauri-plugin-structure-manager
• Owner: HubioLabs
• License: mit
• Created: 2024-07-04T23:09:10.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-07T10:28:05.000Z (about 2 months ago)
• Last Synced: 2024-09-30T05:04:14.346Z (5 days ago)
• Topics: rust, tauri, tauri-plugin
• Language: Rust
• Homepage:
• Size: 714 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tauri Plugin Structure Manager

A Tauri plugin for managing application structure, including directory and file creation and validation. This plugin helps ensure that the necessary project structure is maintained and allows for easy setup and verification of the application's file system.

## Features

- Create and verify directory and file structures

- Easily configurable through a JSON file

- Integrates seamlessly with Tauri applications

- Provides centralized management of project structures

## Installation

Run the following Cargo command in your project directory:

```bash

cargo add [email protected]

```

Or add the following line to your `Cargo.toml`:

```toml

[dependencies]

tauri-plugin-structure-manager = "0.3.8"

```

## Usage

### Rust

In your Tauri application, register the plugin:

```rust

pub fn run() {

    tauri::Builder::default()

        .invoke_handler(tauri::generate_handler![greet])

        .plugin(tauri_plugin_structure_manager::init())

        .setup(|app| {

            app.verify_document()?;

            Ok(())

        })

        .run(tauri::generate_context!())

        .expect("error while running tauri application");

}

```

You can call specific structure manager methodes from anywhere with an acces to the `appHandle`.

### Configuration

You can configure the structure in the `tauri.conf.json`.

```json

"plugins": {

    "structure_manager": {

      "document": {

        "files": [],

        "dirs": {

          "Hubio": {

            "options": {

              "repair": true

            },

            "files": [],

            "dirs": {

              "projects": {

                "files": [],

                "dirs": {}

              }

            }

          }

        }

      }

    }

  },

```

## Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

## License

This project is licensed under the MIT License. See the LICENSE file for more details.