https://github.com/quark-zju/gitrevset

Revset DSL for Git
https://github.com/quark-zju/gitrevset

git revset

Last synced: 3 months ago
JSON representation

Revset DSL for Git

• Host: GitHub
• URL: https://github.com/quark-zju/gitrevset
• Owner: quark-zju
• License: gpl-2.0
• Created: 2020-09-01T10:12:11.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-18T05:42:36.000Z (about 4 years ago)
• Last Synced: 2024-07-18T05:36:58.223Z (4 months ago)
• Topics: git, revset
• Language: Rust
• Homepage:
• Size: 83 KB
• Stars: 14
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gitrevset

[![Documentation](https://docs.rs/gitrevset/badge.svg)](https://docs.rs/gitrevset)

![Build Status](https://github.com/quark-zju/gitrevset/workflows/build/badge.svg)

A domain-specific-language to select commits in a git repo. Similar to

[Mercurial's revset](https://www.mercurial-scm.org/repo/hg/help/revsets).

See [the crate documentation](https://docs.rs/gitrevset/#language-specification) for supported functions and operators. More functions might be added over time.

`gitrevset` provides the Rust library interface. There is also a simple command-line utility `git-revs`. It takes revset expressions as arguments, and outputs commit hashes.

## Examples

### Revset Expressions

The current commit (HEAD) and its parent:

    . + .^

Merge base (common ancestor) of HEAD and origin/master:

    gca(., origin/master)

The bottom of the current local (draft) branch:

    roots(draft() & ::.)

Tagged commits since 100 days ago:

    tag() & date("since 100 days ago")

Commits by "alice" or "bob" in the "dev" but not "master" branch:

    (dev % master) & (author(alice) | author(bob))

### Using `gitrevset` Library

Parse revset from a string at runtime. Execute it and iterate through the `Oid`s:

```rust

use gitrevset::{Repo, SetExt};

let repo = Repo::open_from_env()?;

let set = repo.revs("(draft() & ::.)^ + .")?;

for oid in set.to_oids()? {

    dbg!(oid?)

}

```

Parse at compile time. Interact with local variables like strings, or calculated set:

```rust

use gitrevset::{ast, Repo};

let repo = Repo::open_from_env()?;

let master = "origin/master";

let stack = repo.revs(ast!(only(".", ref({ master }))))?;

let head = repo.revs(ast!(heads({ stack })))?;

```

### Using `git-revs` CLI

```bash

git revs "(draft() & ::.)^ + ."

```

### Configuration

Customized revset aliases or functions can be defined in git config:

```ini

[revsetalias]

d = draft()

f = ancestor($1, origin/master):$1

```

Then they can be used in `git-revs` or using the `repo.anyrevs` API.

```bash

git revs "f(d)"

```