git

一款 Sumor Cloud 工具。
更多文档

一个 git 版本库，可以轻松打包版本和生成具有特定环境的包。

安装

npm i @sumor/git --save

先决条件

Node.JS 版本

需要 Node.JS 版本为 18.x 或以上

需要 Node.JS 的 ES 模块

由于此包是用 ES 模块编写的， 请在您的 package.json 文件中更改以下代码：

{
  "type": "module"
}

用法

import git from '@sumor/git'
const config = {
  // git url and credentials
  url: '<git url>', // 必填项
  token: '<git token>', // 必填项，若未提供用户名和密码
  username: '<git username>', // 必填项，若未提供令牌
  password: '<git password>' // 必填项，若未提供令牌
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // 获取当前提交

const commit2 = await repository.checkout('<target commit>') // 可以是分支、标签或提交

// 如果您安装了 Github Desktop，您可以使用下面的命令在 Github Desktop 中打开
await repository.github()

创建新的本地仓库

当您将配置参数设置为 null 时，它会在本地路径中创建一个新仓库。

await git(null, path1)

// 本地仓库的用法
const repository = await git({ url: path1 }, path2)