# simple-repo-kit

> 对 simple-git API 进行简单封装, 提供一些常用功能

Latest version **1.0.0** (published 2022-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-repo-kit
pnpm add simple-repo-kit
yarn add simple-repo-kit
bun add simple-repo-kit
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-03-29 |
| First published | 2022-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 17.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | youngbrain1893@gmail.com |
| Maintainers | ybrain1893 |

## Links

- npm: https://www.npmjs.com/package/simple-repo-kit
- Repository: https://github.com/youngbrain1893/simple-repo-kit
- Homepage: https://github.com/youngbrain1893/simple-repo-kit#readme
- Issues: https://github.com/youngbrain1893/simple-repo-kit/issues
- npm.io page: https://npm.io/package/simple-repo-kit

## Dependencies (2)

- [simple-git](https://npm.io/package/simple-git.md) ^3.2.6
- [typescript](https://npm.io/package/typescript.md) ^4.6.2

## Recent versions

- 1.0.0 (latest) — 2022-03-29

## README

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

Use [simple-git](https://www.npmjs.com/package/simple-git) ability and add some frequently used API（eg：`branchExists`、`getCurrentBranchName`）

# Usage
```bash
yarn add simple-repo-kit
```

```typescript
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<keyof SimpleGit>)

---
_Source: https://npm.io/package/simple-repo-kit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._