@sumor/git

git

Una Herramienta Sumor Cloud.
Más Documentación

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

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

Instalación

npm i @sumor/git --save

Requisitos previos

Versión de Node.JS

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

Requiere módulo ES de Node.JS

Como 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 de git y credenciales
  url: '<url de git>', // obligatorio
  token: '<token de git>', // obligatorio, si no se proporcionan nombre de 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, path)

const commit1 = await repository.currentCommit() // obtener el commit actual
const commitTime1 = await repository.currentCommitTime() // obtener la hora del commit actual, en milisegundos

await repository.checkout('<commit objetivo>') // puede ser una rama, una etiqueta o un commit
const commit2 = await repository.currentCommit() // obtener el commit actual

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

Crear nuevo repositorio local

Cuando pases 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)