git

Ein Sumor Cloud Tool.
Weitere Dokumentation

Eine Git-Versionbibliothek, die Versionen einfach verpackt und ein spezifisches Paket mit Umgebung generiert.

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 Zugangsdaten
  url: '<git url>', // obligatorisch
  token: '<git token>', // obligatorisch, falls Benutzername und Passwort nicht angegeben sind
  username: '<git username>', // obligatorisch, falls Token nicht angegeben ist
  password: '<git password>' // obligatorisch, falls Token nicht angegeben ist
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // aktueller Commit abrufen

const commit2 = await repository.checkout('<Ziel-Commit>') // kann ein Branch oder ein Tag oder ein Commit sein

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

Neues lokales Repository erstellen

Wenn Sie null als Konfiguration übergeben, wird es ein neues Repository im lokalen Pfad erstellen.

await git(null, path1)

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