@sumor/git

git

Una Sumor Cloud Herramienta.
Más Documentación

Una biblioteca de versiones 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

Prerrequisitos

Versión de Node.JS

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

requerir módulo ES de Node.JS

Ya que este paquete está escrito en módulo ES, 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 el nombre de usuario y contraseña
  username: '<nombre de usuario de git>', // obligatorio, si no se proporciona el token
  password: '<contraseña de git>' // obligatorio, si no se proporciona el token
}
const repository = await git(config, path)

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

const commit2 = await repository.checkout('<commit objetivo>') // 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, path1)

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