git

Uma Ferramenta Sumor Cloud.
Mais Documentação

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

Instalação

npm i @sumor/git --save

Pré-requisitos

Version Node.JS

Requer Node.JS 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 em seu arquivo package.json:

{
  "type": "module"
}

Uso

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

const commit1 = await repository.currentCommit() // obter commit atual
const commitTime1 = await repository.currentCommitTime() // obter horário atual do commit, em milissegundos

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

// 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 irá criar um novo repositório no caminho local.

await git(null, caminho1)

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