Refresh

A Simple and easy to use hot reload tool for your projects.

What is Refresh?

Refresh is a very simple cli written in rust that does one thing and one thing only: Reload your project when any file changes.

Atleast by default it does that. I am planning to add more features to it in the future. For now, you can use refresh on your:

• Rust projects
• Go projects

Other than that, you can free to contribute and add support for your own language or toolchain.

How to use Refresh?

For now, using refresh is very simple. Just install it using cargo:

cargo install refresh

And then run it in your project directory:

refresh <dir>

Where <dir> is the directory you want to watch for changes. If you don't specify a directory, it will watch the current directory.

How does Refresh work?

Refresh uses the notify crate to watch for changes in the specified directory.

Refresh automatically picks up on which tool chain and language you are using and runs the appropriate command to build your project.

For example, if you are using rust, refresh will run cargo build on your project. If you are using go, refresh will run go build on your project.

However, if just run refresh in a directory, if refresh doesn't find an appropriate command to run, it will just exit.

How to contribute?

If you want to add support for your own language or toolchain, you can do so by modifying the src/handler.rs file.

For example, the rust handler looks like this:

fn handle_cargo(){
    bunt::println!("Building...");
    let _ = std::process::Command::new("cargo")
        .arg("build")
        .output()
        .expect("Failed to build");
    bunt::println!("{$green}Build Successful{/$}");
}

You can add your own handler in the same way. Just add a new function and call it in the handle function. If you want to add support for a new language, you can do so by adding a new function in the same way.

Well, there is more to it and I will add more documentation in the future. For now, you can just look at the source code and figure it out.

License

Refresh is licensed under the MIT License. See the LICENSE file for more information.