npm.io
1.0.0 • Published 4 years ago

simple-repo-kit

Licence
MIT
Version
1.0.0
Deps
2
Size
17 kB
Vulns
0
Weekly
0

Motivation

A easy way for cli/utils to operate with git.

Use simple-git ability and add some frequently used API(eg:branchExists、getCurrentBranchName)

Usage

yarn add simple-repo-kit
import SimpleRepoKit from 'simple-repo-kit';

const repo = new SimpleRepoKit();
await repo.initialize(__dirname);

const delegatedRepo = repo.delegate(['diff', 'log']); // https://www.npmjs.com/package/simple-git#API

delegatedRepo.getCurrentBranchName();
delegatedRepo.branchExists('some branch');
delegatedRepo.checkout('main');
delegatedRepo.commitLocalChange('commit message');

APIs

  • getCurrentBranchName()

  • branchExists(branchName: string, branchType: BranchType)

  • stashBeforeOperate()

  • checkout(branchName: string, sourceBranch: string)

  • getLastLog()

  • commitLocalChange(message: string)

  • delegate(methods: Array)