@sumor/git

git

Un Sumor Cloud Outil.
Plus de documentation

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

Version NPM Téléchargements NPM GitHub CI GitHub Test GitHub Coverage GitHub Audit

Installation

npm i @sumor/git --save

Prérequis

Version Node.JS

Nécessite la version Node.JS 18.x ou supérieure

Require Node.JS module ES

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

{
  "type": "module"
}

Utilisation

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

const commit1 = await repository.currentCommit() // obtenir le commit actuel
const commitTime1 = await repository.currentCommitTime() // obtenir l'heure du commit actuel, en millisecondes

await repository.checkout('<commit cible>') // peut être une branche, un tag ou un commit
const commit2 = await repository.currentCommit() // obtenir le commit actuel

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

Créer un nouveau dépôt local

Lorsque vous passez null comme config, il créera un nouveau dépôt dans le chemin local.

await git(null, chemin1)

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