github_username_regex 1.0.0

A lightweight Rust crate to check if a GitHub username / handle is valid
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# github-username-regex-rust

[![test](https://github.com/GrantBirki/github-username-regex-rust/actions/workflows/test.yml/badge.svg)](https://github.com/GrantBirki/github-username-regex-rust/actions/workflows/test.yml) [![lint](https://github.com/GrantBirki/github-username-regex-rust/actions/workflows/lint.yml/badge.svg)](https://github.com/GrantBirki/github-username-regex-rust/actions/workflows/lint.yml) [![build](https://github.com/GrantBirki/github-username-regex-rust/actions/workflows/build.yml/badge.svg)](https://github.com/GrantBirki/github-username-regex-rust/actions/workflows/build.yml) [![release](https://github.com/GrantBirki/github-username-regex-rust/actions/workflows/release.yml/badge.svg)](https://github.com/GrantBirki/github-username-regex-rust/actions/workflows/release.yml)

A lightweight Rust crate to check if a GitHub username / handle is valid

## Installation 📦

You can use this crate from [crates.io](https://crates.io/crates/github_username_regex) with the following command:

```bash
cargo add github_username_regex
```

> This will add the latest version of this crate to your `Cargo.toml` file

Or you can use a version:

```toml
# Cargo.toml

[dependencies]
github_username_regex = "X.X.X" # where X.X.X is the version you want to use
```

## Usage 💻

Using this crate is very simple. You can use the `valid` function to check if a GitHub username is valid. This function returns a `bool` value.

Here is an example:

```rust
fn main() {
    let handle = "monalisa";
    let valid = github_username_regex::valid(&handle);
    if valid {
        println!("{} is a valid GitHub username", handle);
    } else {
        println!("{} is not a valid GitHub username", handle);
    }
}
```

Console output of the above code:

```console
$ cargo run
...
monalisa is a valid GitHub username
```

## Release 🚀

To release a new version of this gem, simply edit the [`Cargo.toml`](Cargo.toml) file in this repo. You just need to update the `version` value. When you commit (or merge) your changes to `main`, a new version will be automatically released via GitHub Actions to [crates.io](https://crates.io). Addtionally, a new release tag will be pushed to this repository as well.

## Note 📝

This Crate doesn't take reserved usernames into consideration. For example, it matches `help`, `about` and `pricing`, though they are reserved words and cannot be used as GitHub usernames.

## Credits 🙏

This Crate is based on the following npm [package](https://github.com/shinnn/github-username-regex)