git

Uma Ferramenta Sumor Cloud.
Mais Documentação

Uma biblioteca de versão do 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 do Node.JS

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

Requer módulo ES do Node.JS

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

{
  "type": "module"
}

Uso

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

const commit1 = await repository.currentCommit() // obter o commit atual

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

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

Criar um 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)