git

Una herramienta de Sumor Cloud.
Más documentación

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

Instalación

npm i @sumor/git --save

Requisitos previos

Versión de Node.JS

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

requerir 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: '<url de git>', // obligatorio
  token: '<token de git>', // obligatorio, si no se proporciona usuario y contraseña
  username: '<nombre de usuario de git>', // obligatorio, si no se proporciona token
  password: '<contraseña de git>' // obligatorio, si no se proporciona token
}
const repository = await git(config, ruta)

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

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

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

Crear un nuevo repositorio local

Cuando pases null como configuración, creará un nuevo repositorio en la ruta local.

await git(null, ruta1)

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