@sumor/git

جيت

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

مكتبة إصدار git، تقوم بتجهيز الإصدار بسهولة وإنشاء حزمة معينة بوسائط.

إصدار NPM تنزيلات NPM CI GitHub اختبار 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: '<رابط git>', // إلزامي
  token: '<رمز git>', // إلزامي إذا لم يُقدم اسم المستخدم وكلمة المرور
  username: '<اسم مستخدم git>', // إلزامي إذا لم يتم توفير الرمز
  password: '<كلمة سر git>' // إلزامي إذا لم يتم توفير الرمز
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // الحصول على العلامة الحالية
const commitTime1 = await repository.currentCommitTime() // الحصول على وقت العلامة الحالية، بالمللي ثانية

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

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

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

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

await git(null, path1)

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