git

Uma Ferramenta Sumor Cloud.
Documentação Adicional

Uma biblioteca de versão git, embalando facilmente a versão e gerando um pacote específico com env.

Instalação

npm i @sumor/git --save

Pré-requisitos

Versão Node.JS

Requer Node.JS versão 18.x ou superior

Requer módulo ES Node.JS

Como esse pacote é escrito em módulo ES, por favor altere o seguinte código em seu arquivo package.json:

{
  "type": "module"
}

Uso

import git from '@sumor/git'
const config = {
  // url e credenciais git
  url: '<git url>', // obrigatório
  token: '<git token>', // obrigatório, se o nome de usuário e a senha não forem fornecidos
  username: '<git username>', // obrigatório, se o token não for fornecido
  password: '<git password>' // obrigatório, se o token não for fornecido
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // obtém o commit atual

const commit2 = await repository.checkout('<commit de destino>') // pode ser um branch, uma tag ou um commit

// se você instalou o Github Desktop, você pode usar o comando abaixo para abri-lo no Github Desktop
await repository.github()

Criar novo repositório local

Quando você passa null como config, ele criará um novo repositório no caminho local.

await git(null, path1)

// uso para repositório local
const repository = await git({ url: path1 }, path2)