use-git-revision 0.0.1

Primitive Git revision selector vocabulary for RustUse
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

# use-git-revision

Primitive `Git` revision selector vocabulary for `RustUse`.

`use-git-revision` models revision selectors, suffixes, and ranges such as `A..B` and `A...B`. It does not resolve revisions.

## Basic usage

```rust
use use_git_revision::{GitRevision, RevisionRange, RevisionRangeKind};

let revision = GitRevision::head();
let range = RevisionRange::new("main", "feature/use-git", RevisionRangeKind::TwoDot)
    .expect("valid range");

assert_eq!(revision.as_str(), "HEAD");
assert_eq!(range.to_string(), "main..feature/use-git");
```

## Scope

- Model `HEAD`, branch, tag, ref, and object identifier selectors as text.
- Model parent and ancestor suffix vocabulary.
- Keep revision resolution out of scope.