@sumor/git

git

Ein Sumor Cloud-Tool.
Weitere Dokumentation

Eine git-Version-Bibliothek, die Versionen einfach verpackt und spezifische Pakete mit Umgebung generiert.

NPM-Version NPM-Downloads GitHub CI GitHub Test GitHub Coverage GitHub Audit

Installation

npm i @sumor/git --save

Voraussetzungen

Node.JS-Version

Erfordert Node.JS-Version 18.x oder höher.

Erforderliches Node.JS ES-Modul

Da dieses Paket in ES-Modul geschrieben ist, ändern Sie bitte den folgenden Code in Ihrer package.json-Datei:

{
  "type": "module"
}

Verwendung

import git from '@sumor/git'
const config = {
  // git-URL und Anmeldeinformationen
  url: '<git url>', // obligatorisch
  token: '<git token>', // obligatorisch, wenn Benutzername und Passwort nicht angegeben sind
  username: '<git username>', // obligatorisch, wenn Token nicht angegeben ist
  password: '<git password>' // obligatorisch, wenn Token nicht angegeben ist
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // aktueller Commit abrufen
const commitTime1 = await repository.currentCommitTime() // aktuelle Commit-Zeit abrufen, in Millisekunden

await repository.checkout('<target commit>') // kann ein Branch, ein Tag oder ein Commit sein
const commit2 = await repository.currentCommit() // aktuellen Commit abrufen

// Wenn Sie GitHub Desktop installiert haben, können Sie den folgenden Befehl verwenden, um es im GitHub Desktop zu öffnen
await repository.github()

Neuen lokalen Repository erstellen

Wenn Sie config als null übergeben, wird ein neues Repository im lokalen Pfad erstellt.

await git(null, path1)

// Verwendung für lokales Repository
const repository = await git({ url: path1 }, path2)