@sumor/git

git

أداة Sumor Cloud.
المزيد من التوثيق

مكتبة إصدار git، تعبئة الإصدار بسهولة وتوليد حزمة معيّنة بيئياً.

إصدار NPM عدد تنزيلات NPM تحقق GitHub CI اختبار GitHub تغطية GitHub مراجعة GitHub

التثبيت

npm i @sumor/git --save

المتطلبات الأساسية

نسخة Node.JS

يتطلب إصدار Node.JS 18.x أو أعلى

يتطلب وحدة Node.JS ES

نظرًا لأن هذه الحزمة مكتوبة بوحدة ES،
يرجى تغيير الكود التالي في ملف 'package.json' الخاص بك:

{
  "type": "module"
}

الاستخدام

import git from '@sumor/git'
const config = {
  // git url and credentials
  url: '<رابط git>', // إلزامي
  token: '<رمز git>', // إلزامي، إذا لم يتم توفير اسم المستخدم وكلمة المرور
  username: '<اسم مستخدم git>', // إلزامي، إذا لم يتم توفير الرمز
  password: '<كلمة مرور git>' // إلزامي، إذا لم يتم توفير الرمز
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // الحصول على الرتبة الحالية

const commit2 = await repository.checkout('<الرتبة المستهدفة>') // يمكن أن تكون فرعًا أو علامة أو رتبة

// إذا قمت بتثبيت Github Desktop، يمكنك استخدام الأمر التالي لفتحه في Github Desktop
await repository.github()

إنشاء مستودع محلي جديد

عند تمرير قيمة null كـ config، سيتم إنشاء مستودع جديد في المسار المحلي.

await git(null, path1)

// الاستخدام للمستودع المحلي
const repository = await git({ url: path1 }, path2)