tiny-commit-walker

tiny commit walker

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
tiny-commit-walker
401.2.17 years ago7 years agoMinified + gzip package size for tiny-commit-walker in KB

Readme

Tiny commit walker
Tiny git commit walker has no native modules.
Build Status Build status npm version
Install
$ npm install --save tiny-commit-walker
Usage
import { Repository } from 'tiny-commit-walker';

(async () => {
  const repo = new Repository('path/to/repo/.git');
  // const repo = new Repository(await Repository.findGitDir('path/to/repo'));
  const branches = await repo.readBranches();
  const tags = await repo.readTags();
  const branch = await repo.readCommitByBranch('master');
  console.log(branch.name); // master
  let commit = branch.commit;
  while (commit.hasParents) {
    console.log(commit.hash);
    commit = await commit.walk(); // default parameter of commit.walk is base parent hash.
  }
})();

// or

const repo = new Repository('path/to/repo/.git');
const branches = repo.readBranchesSync();
const tags = repo.readTagsSync();
const branch = repo.readCommitByBranchSync('master');
console.log(branch.name); // master
let commit = branch.commit;
while (commit.hasParents) {
  console.log(commit.hash);
  commit = commit.walkSync();
}
Documentation
https://ukyo.github.io/tiny-commit-walker