@sumor/git

git

Una Herramienta 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.

Versión NPM Descargas NPM CI de GitHub Prueba de GitHub Cobertura de GitHub Auditoría de GitHub

Instalación

npm i @sumor/git --save

Requisitos previos

Versión de Node.JS

Requiere la versión de Node.JS 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 proporcionan nombre de usuario y contraseña
  username: '<git username>', // obligatorio, si no se proporciona el token
  password: '<git password>' // obligatorio, si no se proporciona el token
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // obtener confirmación actual
const commitTime1 = await repository.currentCommitTime() // obtener hora de confirmación actual, en milisegundos

await repository.checkout('<confirmación de destino>') // puede ser una rama, un tag o una confirmación
const commit2 = await repository.currentCommit() // obtener confirmación actual

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

Crear un nuevo repositorio local

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

await git(null, path1)

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