zsh-module 0.2.1

A High-level framework for creating zsh modules
Documentation 
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

# Zsh Module
This is a high level crate that allows you to define your own zsh module. It is in a very early state but it can be used to define commands.

In the future, most zsh module functionality will be added. Feel free to send a PR if you would like to add more functionality :)

## Getting started
Take a look at our online [documentation](https://docs.rs/zsh-module/latest/zsh-module) for a quick guide.

## Example module
Here's a simple greeter module:

```rust
 use zsh_module::{ Module, ModuleBuilder, Actions, Result };

 zsh_module::impl_hooks!();

 struct Greeter;

 impl Actions for Greeter {
     fn boot(&mut self) -> Result<()> {
         println!("Hello, everyone!");
         Ok(())
     }
     fn cleanup(&mut self) -> Result<()> {
         println!("Bye, everyone!");
         Ok(())
     }
 }

 fn setup() -> Result<Module> {
     let module = ModuleBuilder::new()
         .build(Greeter);
     Ok(module)
 }
```

For more information, take at look at the [`example` module][example]

[example]: https://github.com/Diegovsky/zsh-module-rs/tree/master/greeter