git

Uma Sumor Cloud Ferramenta.
Documentação Adicional

Uma biblioteca de versão git, empacotando 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 versão 18.x ou acima

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 do git>', // obrigatório
  token: '<token do git>', // obrigatório, se nome de usuário e 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 commit atual
const commitTime1 = await repository.currentCommitTime() // obter tempo do commit atual, 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 seguinte comando para abri-lo no Github Desktop
await repository.github()

Criar novo repositório local

Quando você passa nulo como configuração, ele criará um novo repositório no caminho local.

await git(null, caminho1)

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