git-blame-parser 0.1.1

Parses the git blame porcelain format into a struct.
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
63

git-blame-parser
================

[![Badge Workflow](https://github.com/mitsu-ksgr/git-blame-parser/actions/workflows/rust.yml/badge.svg)](https://github.com/mitsu-ksgr/git-blame-parser/actions)

Parses the output of `git blame` command in
[the porcelain format](https://git-scm.com/docs/git-blame#_the_porcelain_format)
into a struct.
the output must be generated using the `--line-porcelain` option.


## Usage
Run the following Cargo command in your project directory:

```sh
% cargo add git-blame-parser
```

Or add the following line to your `Cargo.toml`:

```toml
[dependencies]
git-blame-parser = "0.1.1"
```

Then:

```rust
let output = std::process::Command::new("git")
    .args(["blame", "--line-porcelain"])
    .arg(filepath)
    .output()
    .unwrap();

if output.status.success() {
    let raw_blame = String::from_utf8_lossy(&output.stdout);
    let blames = match git_blame_parser::parse(&raw_blame) {
        Ok(blames) => blames,
        Err(e) => {
            eprintln!("Error: {e}");
            std::process::exit(1);
        }
    };

    for blame in blames.iter() {
        println!(
            "* {}: {:0>4} by {} {}",
            blame.short_commit(),
            blame.original_line_no,
            blame.author,
            blame.author_mail
        );
        println!("summary: {}", blame.summary);
        println!("content: `{}`", blame.content);
        println!();
    }
}
```

See also [examples](./examples/).

## License
[MIT](./LICENSE)