at the moment this library only is covering reading simple git files api, and i dont pretend heavily maintain this library beyond what i need, but feel free to submit a pull request for new features if you thinking about use it too

Installation

this module officially can be installed only via pesde

pesde add ernisto/git

Documentation

querys

function read_ref_by_post_commits(params: {
    commit_id: sha1,
    predicate: nil|(ref) -> boolean?
}): {
    ref: ref?,
    commit_ids: {sha1},
}

local function is_tag(ref: git.ref)
    return ref.kind == 'tags'
end

local current_branch = git.head.read_current()
local result = git.query.read_ref_by_post_commits {
    commit_id = current_branch.commit_id, predicate = is_tag
}
local tag = result.ref or error(`no tag found`)

object (commits, trees and globs)

function object.read_from_id(object_id: sha1): raw_object

local raw_object = object.read_from_id("2387d09d9d5e17162cee849db9595255eb0e0d01")
local commit = commit.read_from_id("2387d09d9d5e17162cee849db9595255eb0e0d01")

ref (branches and tags)

function remote.read_from_id(id: ref_id): remote
function head.read_from_id(id: ref_id): head
function tag.read_from_id(id: ref_id): tag
function ref.read_from_id(id: ref_id): ref

local tag = git.tag.read_from_id("refs/tags/v1.0.0")
local same_tag = git.tag.read_from_name("v1.0.0")

function remotes.read_all(): remote
function head.read_all(): head
function tag.read_all(): tag
function ref.read_all(): ref

for id, branch in git.head.read_all() do
    print('branch', id, branch)
end

function head.read_current(): ref

local current_branch = git.head.read_current()
print(current_branch.name)