git

Una herramienta Sumor Cloud.
Más Documentación

Una biblioteca de versión git, empaquetando fácilmente la versión y generando un paquete específico con env.

Instalación

npm i @sumor/git --save

Prerrequisitos

Versión Node.JS

Requiere Node.JS versión 18.x o superior

Requiere módulo ES de Node.JS

Dado que este paquete está escrito en módulo ES, por favor cambie el siguiente código en su archivo package.json:

{
  "type": "module"
}

Uso

import git from '@sumor/git'
const config = {
  // url y credenciales de git
  url: '<git url>', // obligatorio
  token: '<git token>', // obligatorio, si no se proporciona nombre de usuario y contraseña
  username: '<git username>', // obligatorio, si no se proporciona un token
  password: '<git password>' // obligatorio, si no se proporciona un token
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // obtener el commit actual

const commit2 = await repository.checkout('<target commit>') // puede ser una rama, una etiqueta o un commit

// si tienes instalado Github Desktop, puedes usar el siguiente comando para abrirlo en Github Desktop
await repository.github()

Crear nuevo repositorio local

Cuando pases null como config, creará un nuevo repositorio en la ruta local.

await git(null, path1)

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