12 releases

0.4.5 Sep 6, 2024
0.4.4 Nov 5, 2022
0.4.3 Oct 11, 2022
0.4.2 May 30, 2022
0.1.0 Feb 6, 2020

#156 in Parser implementations

Download history 1186/week @ 2024-08-21 1226/week @ 2024-08-28 1459/week @ 2024-09-04 1419/week @ 2024-09-11 1211/week @ 2024-09-18 1309/week @ 2024-09-25 1396/week @ 2024-10-02 1378/week @ 2024-10-09 1222/week @ 2024-10-16 1071/week @ 2024-10-23 990/week @ 2024-10-30 1057/week @ 2024-11-06 772/week @ 2024-11-13 1493/week @ 2024-11-20 1730/week @ 2024-11-27 1797/week @ 2024-12-04

5,884 downloads per month
Used in 29 crates (24 directly)

MIT license

25KB
362 lines

git-url-parse

Minimum Supported Rust Version Crates.io Github actions CI status docs.rs License Maintenance

Supports common protocols as specified by the Pro Git book

See: 4.1 Git on the Server - The Protocols

Supports parsing SSH/HTTPS repo urls for:

  • Github
  • Bitbucket
  • Azure Devops

See tests/parse.rs for expected output for a variety of inputs.


URLs that use the ssh:// protocol (implicitly or explicitly) undergo a small normalization process in order to be parsed.

Internally uses Url::parse() from the Url crate after normalization.

Examples

Run example with debug output

$ RUST_LOG=git_url_parse cargo run --example multi
$ RUST_LOG=git_url_parse cargo run --example trim_auth 

Simple usage and output

$ cargo run --example readme
use git_url_parse::GitUrl;

fn main() {
    println!("SSH: {:#?}", GitUrl::parse("git@github.com:tjtelan/git-url-parse-rs.git"));
    println!("HTTPS: {:#?}", GitUrl::parse("https://github.com/tjtelan/git-url-parse-rs"));
}

Example Output

SSH: Ok(
    GitUrl {
        host: Some(
            "github.com",
        ),
        name: "git-url-parse-rs",
        owner: Some(
            "tjtelan",
        ),
        organization: None,
        fullname: "tjtelan/git-url-parse-rs",
        scheme: Ssh,
        user: Some(
            "git",
        ),
        token: None,
        port: None,
        path: "tjtelan/git-url-parse-rs.git",
        git_suffix: true,
        scheme_prefix: false,
    },
)
HTTPS: Ok(
    GitUrl {
        host: Some(
            "github.com",
        ),
        name: "git-url-parse-rs",
        owner: Some(
            "tjtelan",
        ),
        organization: None,
        fullname: "tjtelan/git-url-parse-rs",
        scheme: Https,
        user: None,
        token: None,
        port: None,
        path: "/tjtelan/git-url-parse-rs",
        git_suffix: false,
        scheme_prefix: true,
    },
)

Dependencies

~2–3MB
~57K SLoC