a extremely customizable Rust library for CLI apps by Evrone

0
99
a extremely customizable Rust library for CLI apps by Evrone


update-informer is a library created primarily for CLI instruments which are written in Rust — equivalent to dotenv-linter, datanymizer. It checks for brand new variations which were launched and sends notifications when an replace is discovered. update-informer was developed by an open-source fanatic Mikhail Grachev.

CLI stands for Command Line Interface — a command-line program that reads the instructions you enter and performs the requested motion. Basically, any program that can be utilized by terminal instructions falls into this class.

 

How does it work?

update-informer permits you to mechanically test for brand new variations on sources like Crates.io and GitHub. Crates.io is the Rust neighborhood’s crate registry, the principle useful resource the place all tasks, libraries, and many others. are saved.

Once you add the update-informer library in your CLI software, which runs within the console, it periodically (for instance, as soon as a day) checks to see if a brand new model has been launched. If one is out, then update-informer sends a message to the console like, “A brand new launch is accessible, replace with this hyperlink.”

There are a variety of tasks with comparable instruments. For instance, GitHub CLI can carry GitHub to your terminal. Its performance comes out of the field, and you’ll work with points, pull requests, checks, releases, and extra. There’s additionally a library like this in Javascript, which may be very widespread.

Rust had an analogous library, nevertheless it hadn’t been maintained for fairly a very long time, it didn’t have GitHub help, and we weren’t fairly happy with the way it labored. It couldn’t be custom-made or modified. So we developed a extra common resolution for Rust neighborhood that may be custom-made in each doable method.

update-informer generates a notification within the code throughout program begin (within the logs). One of many key options of this instrument that units it aside from others is GitHub help, along with Crates.io. It additionally gives the power to configure the frequency of checks (you’ll be able to specify any size of time, even checking each single second) and has the minimal variety of dependencies — solely ureq, semver and serde. This is essential, since third-party options fairly often carry loads of dependencies, leading to code base will increase, compilation time will increase, and many others.

The end result appears like this:

update-informer

Utilization

Add update-informer to Cargo.toml:

[dependencies]
update-informer = "0.2.0"

To test for a brand new model on Crates.io, use the UpdateInformer::check_version perform. This perform takes the venture identify and present model in addition to test interval:

use update_informer::{registry::Crates, Test, UpdateInformer};

let informer = UpdateInformer::new(Crates, "repo", "0.1.0", Period::from_secs(60 * 60 * 24));
if let Okay(Some(model)) = informer.check_version() {
    println!("New model is accessible: {}", model);
}

Additionally, you’ll be able to take the identify and model of the venture from Cargo utilizing surroundings variables:

use update_informer::{registry::Crates, Test, UpdateInformer};

let identify = env!("CARGO_PKG_NAME");
let model = env!("CARGO_PKG_VERSION");
UpdateInformer::new(Crates, identify, model, Period::from_secs(60 * 60 * 24)).check_version();

Be aware that the primary test will begin solely after the interval has expired:

use update_informer::{registry::Crates, Test, UpdateInformer};

const EVERY_HOUR: Period = Period::from_secs(60 * 60);

let informer = UpdateInformer::new(Crates, "repo", "0.1.0", EVERY_HOUR);
informer.check_version(); // The test will begin solely after an hour

To test for a brand new model on GitHub (be aware that the venture identify should comprise the proprietor):

use update_informer::{registry::GitHub, Test, UpdateInformer};

let informer = UpdateInformer::new(GitHub, "proprietor/repo", "0.1.0", Period::from_secs(60 * 60 * 24));
informer.check_version();

Plans for the long run

In the mean time, the v0.2.0 model of the update-informer has been launched. If there may be curiosity from the neighborhood or requests for enhancements, then after all we’ll work on bettering this instrument and increasing the performance. Sooner or later, we plan to help all widespread hosts, equivalent to GitLab and Bitbucket, in addition to add help for numerous HTTP purchasers to scale back dependencies. Test the venture’s GitHub and ship us pull requests!

Our work on open-source tasks — and the truth that each month we select a number of OSS tasks to sponsor — reveals our initiative and understanding of what builders love and want. Attain out to us by way of the shape under if you must replace your venture to the most recent variations of the expertise stack!





Supply hyperlink

LEAVE A REPLY

Please enter your comment!
Please enter your name here