plugins-rs 0.1.2

js plugins for a rust app
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

# PluginSystem


<center class="display: flex; align-items: center; justify-content: center; width: 100%; gap: 5px;">
<h3>PluginSystem build with <a href="https://github.com/denoland/deno_core">[deno-core]</a></h3>
</center>

<center class="display: flex; align-items: center; justify-content: center; width: 100%; gap: 5px;">
    <span style="display: inline-block;">
        <a href="https://crates.io/crates/plugins-rs">
            <img src="https://img.shields.io/crates/v/plugins-rs?style=flat-square">
        </a>
    </span>
</center>

---

**Cargo.toml**
```toml
plugin-rs = { version = "0.1.2" }
```

---

**Features**
+ Embeded Plugins
+ Simple Standalone Plugins
+ Archived Plugins with `.7z`, `.zip`, `.tar`, `.tar.gz`, `.tar.xz`


**Not Supported yet**
+ packages like `npm`, `jsr`, `git` *(comming soon)*

---

**main.rs**
```rust
use plugins_rs::bind_dir;
use plugins_rs::{ Source, PluginSystem };

fn main() {

    let mut plugins = match PluginSystem::builder()
        .add_source(Source::from_static(std::env::current_dir().unwrap().join("javascript").join("plugins")))
        .add_embed(Source::from_embed(bind_dir!("javascript/embed")))
        .run(None) {
            Ok(prt) => prt,
            Err(err) => panic!("{}", err),
        };

    loop {
        println!("exec() > {:?}", plugins.execute("namespace", "base", "exec()").unwrap());
        println!("do_action.audio_dir() > {:?}", plugins.execute("namespace", "base", "do_action.audio_dir()").unwrap());
        println!("demo.title > {:?}", plugins.execute("namespace", "base", "demo.title").unwrap());
        std::thread::sleep(std::time::Duration::from_millis(1000));
    }

}
```

#### Static Plugins


**`javascript/static/{myplugin}/plugin.json`**
```json
{
    "name": "Test Plugin",
    "description": "Test Plugin",
    "identifier": "com.test.plugin",
    "version": "1.0.0",
    "entry": "index.ts"
}
```


**`javascript/static/{myplugin}/index.ts`**
```ts

// your Plugin Logic

globalThis.Plugins.registerPlugin("base", {
    name: "Base Test Plugin",
    exec: function () {
        return Date.now();
    },
    demo: CustomApi,
    do_action
});
```

#### Embeded Plugins

> to register plugins or custom api
> entry.ts as entry required

**example 1: `javascript/embed/{myplugin}/entry.ts`**
```ts

// your Plugin Logic

globalThis.Plugins.registerPlugin("base", {
    name: "Base Test Plugin",
    exec: function () {
        return Date.now();
    },
    demo: CustomApi,
    do_action
});
```

**example 2: `javascript/embed/{myplugin}/entry.ts`**
```ts
declare global {
    var  CustomApi: {
        title: string;
    }
}

globalThis.CustomApi = {
    title : "DemoProperty"
};
```