https://github.com/planjs/git-cli

https://github.com/planjs/git-cli

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/planjs/git-cli
• Owner: planjs
• License: mit
• Created: 2022-03-28T10:01:43.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-05-21T03:59:39.000Z (over 2 years ago)
• Last Synced: 2024-04-25T19:02:27.077Z (8 months ago)
• Language: TypeScript
• Size: 324 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @planjs/git-utils

一个可编程和命令行的git工具集合, 基于 `nodegit` 组件包开发。

### 安装

```

sudo npm i -g @planjs/git-utils --unsafe-perm=true

# or

npm i -D @planjs/git-utils

```

## cli 方式调用

##### `--check=branch` 检测当前分支是否正确

```bash

gt --check=test

```

如果当前分支不是 `test` 将会报错

#### `--autoMerge=targerBranch` 切换目标分支并且合并

```bash

gt --autoMerge=develop

```

将当前分支合并到`develop`并且将本地分支切换到`develop`分支，失败条件：合并存在冲突、本地分支存在为commit内容。

#### `--check=branch --entry=/project` 指定仓库目录地址

```bash

gt --autoMerge=develop --entry=/project

```

entry参数可以指定所在仓库目录地址

## Node Api

#### 使用例子

```javascript

import GT, { openRepository } from '@quan/git-utils';

const repo = GT({ autoMerge: 'develop' })

```

###### `gitUtils(options: { check?: string, autoMerge?: string, entry?: string })`

与命令行行为一致

###### `openRepository(path?: string): Promise`

打开一个git仓库，path 参数为仓库目录路径。

###### `checkNotCommit(repo: Git.Repository): Promise`

检测本地分支是否存在为保存内容。

###### `function pull(repo: Git.Repository): Promise`

拉取远程仓库内容

###### `function switchBranch(repo: Git.Repository,name: string): Promise`

切换到对应分支

###### `mergeBranch(repo: Git.Repository,fromBranch: string): Promise `

合并对应的分支，如果发生冲突会合并失败。

###### `function push(repo: Git.Repository)`

推送到远程仓库中