git

Un outil Sumor Cloud.
Plus de documentation

Une bibliothèque de version git, empaquetant facilement la version et générant un package spécifique avec env.

Installation

npm i @sumor/git --save

Prérequis

Version de Node.JS

Nécessite la version Node.JS 18.x ou plus récente

Nécessite le module ES Node.JS

Comme ce package est écrit en module ES, veuillez modifier le code suivant dans votre fichier package.json :

{
  "type": "module"
}

Utilisation

import git from '@sumor/git'
const config = {
  // URL git et informations d'identification
  url: '<URL git>', // obligatoire
  token: '<jeton git>', // obligatoire, si le nom d'utilisateur et le mot de passe ne sont pas fournis
  username: "<nom d'utilisateur git>", // obligatoire, si le jeton n'est pas fourni
  password: '<mot de passe git>' // obligatoire, si le jeton n'est pas fourni
}
const dépôt = await git(config, chemin)

const commit1 = await dépôt.currentCommit() // obtenir le commit actuel

const commit2 = await dépôt.checkout('<commit cible>') // peut être une branche, un tag ou un commit

// si vous avez installé Github Desktop, vous pouvez utiliser la commande ci-dessous pour l'ouvrir dans Github Desktop
await dépôt.github()

Créer un nouveau dépôt local

Lorsque vous passez null en tant que configuration, cela créera un nouveau dépôt dans le chemin local.

await git(null, chemin1)

// utilisation pour le dépôt local
const dépôt = await git({ url: chemin1 }, chemin2)