https://github.com/tjtelan/git-url-parse-rs

Parser of git repo urls for Rust
https://github.com/tjtelan/git-url-parse-rs

azure-devops bitbucket git github

Last synced: 3 days ago
JSON representation

Parser of git repo urls for Rust

• Host: GitHub
• URL: https://github.com/tjtelan/git-url-parse-rs
• Owner: tjtelan
• License: mit
• Created: 2020-01-22T05:47:03.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T21:35:24.000Z (2 months ago)
• Last Synced: 2025-01-06T16:44:29.213Z (4 days ago)
• Topics: azure-devops, bitbucket, git, github
• Language: Rust
• Homepage:
• Size: 62.5 KB
• Stars: 15
• Watchers: 2
• Forks: 8
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# git-url-parse

![Minimum Supported Rust Version](https://raw.githubusercontent.com/tjtelan/git-url-parse-rs/main/.github/assets/msrv-badge.svg)

[![Crates.io](https://img.shields.io/crates/v/git-url-parse)](https://crates.io/crates/git-url-parse)

[![Github actions CI status](https://github.com/tjtelan/git-url-parse-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/tjtelan/git-url-parse-rs/actions/workflows/ci.yml)

[![docs.rs](https://docs.rs/git-url-parse/badge.svg)](https://docs.rs/git-url-parse/)

[![License](https://img.shields.io/github/license/tjtelan/git-url-parse-rs)](LICENSE)

![Maintenance](https://img.shields.io/maintenance/yes/2024)

Supports common protocols as specified by the [Pro Git book](https://git-scm.com/book/en/v2)

See: [4.1 Git on the Server - The Protocols](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols)

Supports parsing SSH/HTTPS repo urls for:

* Github

* Bitbucket

* Azure Devops

See [tests/parse.rs](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](https://crates.io/crates/url) crate after normalization.

## Examples

### Run example with debug output

```shell

$ RUST_LOG=git_url_parse cargo run --example multi

$ RUST_LOG=git_url_parse cargo run --example trim_auth 

```

### Simple usage and output

```bash

$ cargo run --example readme

```

```rust

use git_url_parse::GitUrl;

fn main() {

    println!("SSH: {:#?}", GitUrl::parse("[email protected]:tjtelan/git-url-parse-rs.git"));

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

}

```

### Example Output

```bash

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,

    },

)

```